`"listBrokerConnections"`

Abstract

listBrokerConnections lists all available broker connections that have been created.

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

Things to know

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 request example

{
  "api": "mq",
  "apiVersion": "1.0",
  "authToken": "replaceWithAuthtokenFromCreateSession",
  "action": "listBrokerConnections"
}

Maximal request example

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

Response examples

Successful response example

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

Maximal response example

{
    "result": {
        "brokerConnectionNames": [
            "MqttBroker1"
        ]
    },
    "requestId": "00000068",
    "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 summaries

Property

Description

Default

Type

Limits (inclusive)

"partialName"

filters the returned topics by applying partial matches to their names

""

string

Minimum length: 0

Maximum length: 64

"search"

searches the content of the "metadata" property that is part of each topic and integration table

""

string

Minimum length: 0

Maximum length: 64

`"search"`

The "search" property is an optional string that searches the content of the "metadata" property that is part of each topic and integration table.

Things to know:

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.

`"result"`

Property summary

Table 2. "result" property summaries

Property	Description	Type	Limits (inclusive)
`"brokerConnectionNames"`	contains a list of `"brokerConnectionName"` strings	array

`"brokerConnectionNames"`

The "brokerConnectionNames" property is a required array that contains a list of "brokerConnectionName" strings. It defaults to an empty array.

Things to know:

Must contain at least one string.
Each string is the name of a table.
A zero-length string is invalid.
A client should force uniqueness of the items in the array because the server ignores duplicate items.