JSON to different table API reference

API reference for the JSON to different table transform method

Request examples

Minimal request

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

Maximal request

{
  "api": "hub",
  "apiVersion": "1.0",
  "requestId": "00000006",
  "action": "createTransform",
  "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"
  },
  "authToken": "replaceWithAuthTokenFromCreateSession"
}

Note

The jsonToDifferentTableFields transform will automatically add the following fields to the target table if they do not already exist. When the transform inserts a new row into the target table, it auto-populates these fields:

change_id
create_ts
id
out1
out2
source_database
source_id
source_schema
source_table

If any existing field or index has the same name as one of these but with a mismatched schema definition, the transform will fail and prompt the user to fix this conflict.

Response example

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

API reference for the JSON to different table transform method

API referenceJSON hub APIJSON transformJSON to different tabletable transform

`"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	1 to 64 bytes

`"transformActions"`

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

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.