"listTopics" (jsonAction)
JSON MQ "listTopics" action returns and filters a list of MQTT topics
The "listTopics" action lists the names of MQTT topics that the server is tracking.
You can return a filtered list by specifying a partial name in the
"partialName"property.You can include additional items in the list by searching for words contained in the item’s metadata.
Use
"describeTopics"to get detailed information about specific MQTT topics.
Request examples
Minimal
{
"api": "mq",
"action": "listTopics",
"authToken": "replaceWithAuthTokenFromCreateSession"
}
{
"api": "mq",
"apiVersion": "1.0",
"requestId": "2",
"action": "listTopics",
"params": {
"partialName": "test",
"search": null,
"dataFormat": "arrays",
"skipRecords": null,
"maxRecords": 20,
"label": {
"group": "group name",
"name": "label name"
}
},
"authToken": "replaceWithAuthTokenFromCreateSession"
}
{
"result": {
"data": [
"test/ReasonCodes",
"test/SharedSubscriptions",
"test/topic1",
"test/topic2"
]
},
"errorCode": 0,
"errorMessage": "",
"authToken": "replaceWithAuthTokenFromCreateSession"
}
{
"result": {
"data": [
"test/ReasonCodes",
"test/SharedSubscriptions",
"test/topic1",
"test/topic2"
]
},
"requestId": "2",
"errorCode": 0,
"errorMessage": "",
"authToken": "replaceWithAuthTokenFromCreateSession"
}
The listTopics action lists the names of MQTT topics that the server is tracking
The "params" property is an object that contains an action's parameters. Each action defines its own required and optional properties.
"params" property summariesProperty | Description | Default | Type | Limits (inclusive) | ||
|---|---|---|---|---|---|---|
(optional) filters the response by the results that match the specified label properties |
| object |
| |||
(optional) filters the returned topics by applying partial matches to their names |
| string | 0 to 64 bytes |
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.
Properties summary
"result" properties summaryProperty | Description | Type | Limits (inclusive) |
|---|---|---|---|
data | (optional) 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. It is an empty array when there are no results available | array | Its contents are determined by the action |