"describeIntegrationTables" (JSON Action)
JSON hub "describeIntegrationTable action returns all available information about each specified integration table in FairCom Edge
The "describeIntegrationTables" action returns all available information about each specified integration table.
Request examples
Describe a table
{
"api": "hub",
"apiVersion": "1.0",
"requestId": "optionalUniquerequestIdFromTheClient",
"action": "describeIntegrationTables",
"params": {
"tables":
[
{
"databaseName": "faircom",
"ownerName": "admin",
"tableName": "mqtt_msg_faircomadmin_topics"
}
]
},
"authToken": "replaceWithAuthTokenFromCreateSession"
}
{
"requestId": "optionalUniqueRequestIdFromTheClient",
"api": "hub",
"action": "describeIntegrationTables",
"params": {
"tables": [
{
"databaseName": "faircom",
"ownerName": "admin",
"tableName": "mqtt_msg_faircomadmin_topics"
}
]
},
"apiVersion": "1.0",
"debug": "max",
"authToken": "replaceWithAuthTokenFromCreateSession"
}{
"result": {
"data": [
{
"databaseName": "faircom",
"ownerName": "admin",
"tableName": "mqtt_msg_faircomadmin_topics",
"fields": [],
"retentionPolicy": "autoPurge",
"retentionPeriod": 30,
"retentionUnit": "day"
}
]
},
"requestId": "00000017",
"errorCode": 0,
"errorMessage": "",
"authToken": "replaceWithAuthTokenFromCreateSession"
}
{
"result": {
"transformStatus": "running",
"transformPercentComplete": 52
},
"errorCode": 0,
"errorMessage": "",
"authToken": "replaceWithAuthTokenFromCreateSession"
}
Use the describeIntegrationTables JSON API action to return all available information about each specified integration table in FairCom edge
The "params" property is an object that contains an action's request parameters as defined by a set of properties. Each action defines its own required and optional properties. See System limits for a comprehensive overview of property requirements and limitations.
"params" property summariesProperty | Description | Default | Type | Limits (inclusive) | ||
|---|---|---|---|---|---|---|
tables | (optional) contains an array of objects [each object identifies a table]. |
| array | |||
| (optional) specifies the name of a database. | Defaults to the | string | 1 to 64 bytes | ||
| (optional) specifies the unique name of a schema in a database. |
| string | 1 to 64 bytes | ||
| specifies the name of a table. | Required - No default value | string | 1 to 64 bytes | ||
(optional) specifies an array of transform objects. |
| array of objects | 0 or more objects |
The "databaseName" property is an optional string that specifies the database that contains the tables. It defaults to the database name supplied at login.
Note
In the API Explorer, "defaultDatabaseName" is set to "ctreeSQL" in the "createSession" action that happens at login.
A zero-length
"databaseName"is invalid.Its length limit is from 0 to 64 bytes.
If the
"databaseName"property is omitted or set tonull, the server will use the default database name specified at login.If no default database is specified during
"createSession","databaseName"will be set to the"defaultDatabaseName"value that is specified in theservices.jsonfile.
"params": {
"databaseName": "mainDatabase"
}
The "ownerName" property is an optional string from 1 to 64 bytes that identifies the user who owns an object (see Object owner). If it is omitted or set to "" or null, the server uses the default owner name supplied during the "createSession" action or uses the account's "username" as the owner name.
"params": {
"ownerName": "SuperUser"
}
The "tableName" property contains the name of the table in the database where the event occurred. It is a non-zero-length string.
See table name in System limits for table naming requirements and limitations.
A table in DBnotify is defined by "databaseName", "ownerName" and "tableName" or by "dataFilePath".
The "transformSteps" property is an array of transform step objects.
Different actions interpret "transformSteps": [] differently.
In the
"alterIntegrationTable"action,"transformSteps"is optional. Setting it to[]removes transform steps from the integration table.In the
"createIntegrationTable"action,"transformSteps"is optional. Setting it to[]is the same as setting it tonullor omitting it.In the
"testIntegrationTableTransformSteps"actions,"transformSteps"is required; thus, omitting it or setting it to[]ornullis an error.
Each transform step object contains the required "transformStepMethod" property. It also supports the following optional properties:
"transformStepName""transformStepService"
Each transform step method also supports unique properties that are defined below.
"transformStepMethod": "javascript"
Required properties
"codeName"
Optional properties
"ownerName""databaseName"
"transformStepMethod": "tableFieldsToJson"
Required properties
"mapOfPropertiesToFields"
"transformStepMethod": "jsonToTableFields"
Required properties
"mapOfPropertiesToFields"
"transformStepMethod": "jsonToDifferentTableFields"
Required properties
"mapOfPropertiesToFields""targetTableName"
Optional properties
"targetOwnerName""targetDatabaseName"
"result" property summariesProperty | Description | Type | Limits (inclusive) | |||
|---|---|---|---|---|---|---|
data | is an array of objects or arrays. Each item in the array describes a record. The array is empty if no results are available. | array | The action determines its contents. | |||
identifies the format of the data in the | string |
| ||||
provides an estimate of the transformation progress. | integer |
|
The "dataFormat" property is a case-insensitive string enum that defines the format of the "data" property. The default format is an array of arrays. The alternative is an array of objects. The default for "dataFormat" can be changed during a "createSession" action by assigning a different value to the "dataFormat" property in "defaultResponseOptions".
"dataFormat" property:Two of those versions occur in a request, and another occurs in a response. They all indicate how data is formatted.
"dataFormat"in the request in"responseOptions"determines how the"data"property in the response is formatted.Possible values include:
"arrays"This is the default and causes the server to return results as an array of arrays, which is the most efficient.
"objects"This returns results as an array of objects. This is less efficient but is simpler to generate, read, and troubleshoot.
"dataFormat"in the request in the"params"object notifies the server how the"sourceData"property is formatted in the request. This version is rarely used because of the default"autoDetect"behavior.Possible values include:
"arrays"This causes the server to return results as an array of arrays, which is the most efficient.
"objects"This returns results as an array of objects. This is less efficient but is simpler to generate, read, and troubleshoot.
"autoDetect"This is the default, and the server automatically detects the format of the data in the
"sourceData"property.
"dataFormat"in the response shows the client how the server formatted the"data"property.Possible values include:
"arrays"This is the default and causes the server to return results as an array of arrays, which is the most efficient.
"objects"This returns results as an array of objects. This is less efficient but is simpler to generate, read, and troubleshoot.
Example response
{
"result": {
"dataFormat": "objects"
}
}
The "transformPercentComplete" property is an integer between 0 and 99 that is an estimate of the transformation progress when either the "rerunIntegrationTableTransformSteps" or "testIntegrationTableTransformSteps" action is transforming existing records in the integration table.
It is
0when the action has finished, has not started, or is not transforming existing records.It is between
1and99while existing records are being transformed.