JSON to fields API reference

API reference for the JSON to fields transform method

Request examples

Minimal request

{
    "api": "hub",
    "action": "createTransform",
    "authToken": "AuthorizedToken",
    "params": {
        "transformName": "TestTransform2",
        "transformActions": [
            {
                "inputFields": [
                    "In1"
                ],
                "outputFields": [
                    "Out1"
                ],
                "transformActionName": "jsonToTableFields",
                "transformParams": {
                    "mapOfPropertiesToFields": [
                        {
                            "propertyPath": "out1",
                            "name": "out1",
                            "type": "VARCHAR",
                            "length": 200
                        }
                    ]
                }
            }
        ]
    }
}

Maximal request

{
    "api": "hub",
    "apiVersion": "1.0",
    "requestId": "00000006",
    "action": "createTransform",
    "authToken": "AuthorizedToken",
    "params": {
        "transformName": "TestTransform2",
        "transformActions": [
            {
                "inputFields": [
                    "In1"
                ],
                "outputFields": [
                    "Out1",
                    "Out2"
                ],
                "transformActionName": "jsonToTableFields",
                "transformParams": {
                    "mapOfPropertiesToFields": [
                        {
                            "propertyPath": "out1",
                            "name": "out1",
                            "type": "VARCHAR",
                            "length": 200
                        },
                        {
                            "propertyPath": "out2",
                            "name": "out2",
                            "type": "DOUBLE"
                        }
                    ]
                },
                "metadata": {
                    "myTag": "my data"
                }
            }
        ]
    },
    "responseOptions": {
        "binaryFormat": "base64",
        "dataFormat": "arrays",
        "numberFormat": "number"
    }

}

Response example

{
    "authToken": "AuthorizedToken",
    "result": {},
    "requestId": "00000007",
    "errorCode": 0,
    "errorMessage": ""
}

API reference for the JSON to fields transform method

API referenceJSON hub APIJSON API referenceJSON to fields transformJSON fields

`"params"`

The "params" property is an object that contains an action's parameters. Each action defines its own required and optional properties.

Property summary

Table 1. "params" property summaries

Property

Description

Default

Type

Limits

"transformActions"

specifies "transformAction" objects

Required - No default value

array of objects

"transformName"

specifies the name of a transform process. The name cannot be one of the FairCom-provided transform names

Required - No default value

string

Minimum length: 1

Maximum length: 64

`"transformActions"`

The "transformActions" property is an optional array of "transformAction" objects. It defaults to an empty array.

"inputFields"

The "inputFields" property is a required array containing one or more of the fields in the integration table. The FairCom server sends the value of each of these fields to the transform action as its primary input.

Typically a transform action only needs one input field and the most common input field is "source_payload".
When a transform is applied to an integration table, the server automatically adds missing fields to the table. Thus, any field can be the source of a transform. A transform can only put the result of a transform in a field specially created to hold the transform's output value. In other words, a transform's output field cannot be a field that is built into the table or a field that is being used by another transform.
When a transform has multiple transform actions, you typically daisy chain the "output" field of one transform action to be either the input field of another transform or the field that is being written to by another transform.

`"transformParams"`

The "transformParams" property is a required object that can be an empty object or contain one or more properties needed by the "transformAction".

`"mapOfPropertiesToFields"`

The "mapOfPropertiesToFields" property is a required array of "mapOfPropertiesToFields" objects. It defaults to an empty array.

Example

"mapOfPropertiesToFields": [
  {
    "propertyPath": "out1",
    "name": "out1",
    "type": "VARCHAR",
    "length": 200
  }
]

`"propertyPath"`

The "propertyPath" property is a string that specifies the property that will be read in JSON.

`"name"`

The "name" property is a string that specifies the destination in the integration table for the data that was read from the propertyPath.

`"type"`

The "type" property specifies the type of the integration table being written to.

`"length"`

The "length" property is an integer that specifies the length of the "name" property.