"describeTopics"
The "describeTopics"
action returns all available information about specified MQTT topics.
Request examples
Minimal request example
{ "api": "mq", "apiVersion": "1.0", "authToken": "anAuthorizationTokenFromTheServer", "requestId": "00000001", "action": "describeTopics", "params": { "topics": [ "acmefactory/line1/station1/acidbath/telemetry" ] } }
Response examples
{ "result": { "data": [ { "name": "acmefactory/line1/station1/acidbath/telemetry", "creationTime": "2023-01-26T18:20:28.626", "messageCount": 0, "averageMessagesPerMinute": 0, "averageMessagesPerHour": 0, "averageMessagesPerDay": 0, "subscriberList": [], "persistence": { "topic": "acmefactory/line1/station1/acidbath/telemetry", "databaseConnectionString": "FAIRCOM1", "databaseUserName": "ADMIN", "databaseName": "ctreeSQL", "tableName": "acmefactory_line1_station1_acidbath_telemetry", "ownerName": "admin", "threads": 1, "tableAutoTimeStamp": true, "tableAutoTimeStampIndex": true, "tableReplicationReady": true, "retentionPolicy": "autoPurge", "retentionUnit": "day", "retentionPeriod": 30, "storeAndForward": true, "maxDeliveryRatePerSecond": 0, "newSubscriberDeliveryMode": "newMessages", "newSubscriberMaxDeliveredMessages": 0, "retrySeconds": 5, "outputPayloadField": "userDefineField" } } ] }, "requestId": "00000018", "errorCode": 0, "errorMessage": "" }
"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 summariesProperty | Description | Default | Type | Limits (inclusive) |
---|---|---|---|---|
| contains |
| array |
"result"
Property summary
Table 2.
"result"
property summariesProperty | Description | Type | Limits (inclusive) |
---|---|---|---|
| contains an array or object that the server returns, such as records returned by a query NoteIt is an empty array when there are no results available. | array | Its contents are determined by the action |