listBrokerConnections

JSON MQ and Hub "listBrokerConnections" action returns and filters a list of broker connections

The "listBrokerConnections" action lists all available broker connections that have been created.

  • 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.

 

Request examples

Minimal

{
  "action": "listBrokerConnections",
  "authToken": "replaceWithAuthTokenFromCreateSession"
}
 
 

Maximal

{
  "api": "mq",
  "action": "listBrokerConnections",
  "apiVersion": "1.0",
  "requestId": "2",
  "params": {
    "partialName": "M",
    "search": ""
  },
  "authToken": "replaceWithAuthTokenFromCreateSession"
}
 
 

 

Response examples

Success

{
    "result": {
        "brokerConnectionNames": [
            "MqttBroker1"
        ]
    },
    "requestId": "1",
    "errorCode": 0,
    "errorMessage": ""
}
 
 

 

Properties

Request properties ("params")

Property Description Default Type Limits (inclusive)

partialName

The "partialName" property returns code packages with code names that match the value of "partialName". The match starts at the name's beginning, making it a "starts with" match instead of a "substring" match. If the partial name is empty, null, or omitted, it matches all names.

 Optional with default of "" string 1 to 64 bytes

search

The "search" property 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.
 Optional with default of "" string 0 to 64 bytes

 

Response properties ("result")

Property Description Type Limits (inclusive)

brokerConnectionNames

The "brokerConnectionNames" property contains a list of "brokerConnectionName" strings. Each string is the name of a table. A client should force uniqueness of the items in the array because the server ignores duplicate items.

 array of objects

1 object for each broker connection matching the request containing some or all of the following properties:

"brokerHostname"

"brokerPort"

"brokerUserName"

"reconnectFrequencySeconds"

"isConnected"

"statusCode"

"statusMessage"

 

Was this article helpful?

Give feedback about this article

Related Articles