API reference

Request examples

Minimal request example

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

Maximal request example

{
    "api": "hub",
    "apiVersion": "1.0",
    "requestId": "00000006",
    "action": "createTransform",
    "authToken": "AuthorizedToken",
    "params": {
        "transformName": "TestTransform2",
        "transformActions": [
            {
                "inputFields": [
                    "In1"
                ],
                "outputFields": [
                    "Out1",
                    "Out2"
                ],
                "transformActionName": "jsonToDifferentTableFields",
                "transformParams": {
                    "targetDatabaseName": "faircom",
                    "targetTableName": "test_out2",
                    "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": ""
}

`"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

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.

Things to know:

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 the input field of another.

"outputFields"

The "outputFields" property is a required array containing one or more of the fields in the integration table. The transform action writes its output to these fields.

Things to know:

Typically a transform action only needs one output field.
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 field that is 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.
It is an error for the "source_payload" field to be an output field because it always contains the payload from the input service or MQTT topic.
It is also an error for multiple transform actions to write to the same output field because they would overwrite each other’s results.
When a transform has multiple transform actions, you typically daisy chain the output field of one transform action to be the input field of another.

"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 an optional array of "mapOfPropertyToField" objects. It defaults to an empty array.

        "mapOfPropertiesToFields": 
        [
          {
            "propertyPath": "",
            "type": "",
            "name": ""
          }
        ],