"listTransforms"
JSON transform "listTransform" action returns a list of the existing transforms in FairCom MQ and FairCom Edge
The "listTransforms" action obtains a list of the names of existing transforms.
Use the
"partialName"property to filter the list by partial names.You can include additional items in the list by searching for words contained in the item’s metadata.
Use
"describeTransforms"to get detailed information about specific transforms.
Request examples
Minimal request
{
"api": "transform",
"apiVersion": "1.0",
"action": "listTransforms",
"params": {},
"authToken": "aAuthorizedTokenFromServer",
"requestId": "00000011"
}{
"api": "transform",
"apiVersion": "1.0",
"action": "listTransforms",
"params": {
"partialName": "Sensor",
"skipRecords": 0,
"maxRecords": 20
},
"authToken": "aAuthorizedTokenFromServer",
"requestId": "00000012"
}{
"result": {
"data": [
"SensorsTransform1"
]
},
"requestId": "00000011",
"errorCode": 0,
"errorMessage": ""
}{
"result": {
"data": [
"SensorsTransform1"
]
},
"requestId": "00000012",
"errorCode": 0,
"errorMessage": ""
}Use the listTransforms JSON API action to return a list of the existing transforms
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) | |||
|---|---|---|---|---|---|---|---|
specifies the name of a database | Defaults to the | string | 1 to 64 bytes | ||||
specifies the returned results as an array of array, an array of objects, or the default setting defined at login |
| string |
| ||||
specifies the maximum number of records to return from an action. |
| integer |
| ||||
specifies the unique name of a schema in a database |
| string | 1 to 64 bytes | ||||
filters the returned topics by applying partial matches to their names |
| string | 0 to 64 bytes | ||||
searches the content of the |
| string | 0 to 64 bytes | ||||
specifies the number of records to skip over in the results before returning records |
| integer |
|
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 "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.
The "maxRecords" is an optional integer from -1 to 65,535 that sets the maximum number of records to return from an action. It is used in query actions to paginate the query results when returning records directly. The default for most actions is to return 20 records.
Important
-1 returns all records and should be used very carefully because a large query can return so many records that it eventually times out and wastes server and client resources.
When present,
"maxRecords"works in conjunction with the"skipRecords"(and, when applicable,"reverseOrder") properties to paginate results."maxRecords"returns an error when"returnCursor"istrue.Note
This does not apply to the actions where
"returnCursor"is not present.When returning a cursor, retrieve records using the
"getRecordsFromCursor"action.A value of
0for"maxRecords"is not useful because it causes the action to return no records."maxRecords"is ignored by the"getRecordsByIds"action.
The "ownerName" property is an optional string from 1 to 64 bytes that specifies the account that owns an object.
The "partialName" property is an optional string that causes the server to include items in the result when the beginning of their names match the "partialName" value. It defaults to an empty string.
A zero-length string matches all names.
The
"partialName"property is used to filter results in several actions used to return lists.
The "search" property is an optional string that searches the content of the "metadata" property that is part of each topic and integration table.
If there is nothing in the
"metadata"property for a topic or an integration table, there is nothing to search for, resulting in an empty array in the"data"property in the response.The
"metadata"property is a JSON field, meaning you can put a valid JSON in it — for example, a string or object.
The "skipRecords" property is an optional integer from 0 to 9,223,372,036,854,775,807. It is used in query actions to paginate the query results when returning records directly. It defaults to 0.
It specifies the number of records to skip over in the results before returning records.
It works with
"maxRecords"and"reverseOrder".It is ignored when
"returnCursor"istrue.Note
This does not apply to the actions where
"returnCursor"is not present.
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 always included in a response but contains an empty array when no results are available. | array | Its contents are determined by the action |