Skip to main content

JSON to different table API reference

API reference for the JSON to different table transform method

Request examples

Minimal request

{
    "api": "hub",
    "action": "createTransform",
    "authToken": "AuthorizedToken",
    "params": {
        "transformName": "TestTransform2",
        "transformActions": [
            {
                "inputFields": [
                    "In1"
                ],
                      ],
                "transformActionName": "jsonToDifferentTableFields",
                "transformParams": {
                    "targetDatabaseName": "faircom",
                    "targetTableName": "test_out2",
                    "mapOfPropertiesToFields": [
                        {
                            "propertyPath": "out1",
                            "name": "out1",
                            "type": "VARCHAR",
                            "length": 200
                        }
                    ]
                }
            }
        ]
    }
}
{
  "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"
  }
}
{
    "authToken": "AuthorizedToken",
    "result": {},
    "requestId": "00000007",
    "errorCode": 0,
    "errorMessage": ""
}

API reference for the JSON to different table transform method

API referenceJSON hub APIJSON transformJSON to different tabletable transform

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


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