"describeIntegrationTables"
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 request
{
"api": "hub",
"apiVersion": "1.0",
"requestId": "optionalUniquerequestIdFromTheClient",
"authToken": "anAuthorizationTokenFromTheServer",
"action": "describeIntegrationTables",
"params": {
"tables":
[
{
"databaseName": "faircom",
"ownerName": "admin",
"tableName": "mqtt_msg_faircomadmin_topics"
}
]
}
}
{
"requestId": "optionalUniqueRequestIdFromTheClient",
"authToken": "anAuthorizationTokenFromTheServer",
"api": "hub",
"action": "describeIntegrationTables",
"params": {
"tables": [
{
"databaseName": "faircom",
"ownerName": "admin",
"tableName": "mqtt_msg_faircomadmin_topics"
}
]
},
"apiVersion": "1.0",
"debug": "max"
}{
"authToken": "anAuthorizationTokenFromTheServer",
"result": {
"data": [
{
"databaseName": "faircom",
"ownerName": "admin",
"tableName": "mqtt_msg_faircomadmin_topics",
"fields": [],
"retentionPolicy": "autoPurge",
"retentionPeriod": 30,
"retentionUnit": "day"
}
]
},
"requestId": "00000017",
"errorCode": 0,
"errorMessage": ""
}
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 parameters. Each action defines its own required and optional properties.
Properties summary
"params" properties summaryProperty | Description | Default | Type | Limits (inclusive) | ||
|---|---|---|---|---|---|---|
tables | contains an array of objects [each object identifies a table] | Defaults to a single default object. | array | none | ||
| specifies the name of a database | Defaults to the | string | 1 to 64 bytes | ||
| 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 |
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 limits are 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","defaultDatabaseName"will be set to the"defaultDatabaseName"value that is specified in theservices.jsonfile.
The "ownerName" property is an optional string from 1 to 64 bytes that specifies the account that owns an object.
The "tableName" property contains the name of the table in the database where the event occurred. It is a non-zero-length string.
A table name may contain up to 64 ASCII characters and must not start with a number.
A table in DBnotify is defined by "databaseName", "ownerName" and "tableName" or by "dataFilePath".
Properties summary
"result" properties summaryProperty | Description | Type | Limits (inclusive) | |||
|---|---|---|---|---|---|---|
data | specifies an array or object that the server returns, such as records returned by a query. It is an empty array when no results are available. | array | Its contents are determined by the action | |||
specifies the format of the data in the | string |
|
The "dataFormat" property is an optional, case-insensitive string enum that defines the format of the response in 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 inside"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 causes the server to automatically detect 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.