Boomi Platform API Reference (1.0.0) - ListQueues

Toggle Pane

• List queues
  • getRetrieves a ListQueues object by identifier
  • getRetrieves a ListQueues object by identifier

API docs by Redocly

License: Boomi API License and Rate Limits

Download OpenAPI Specification: Download

List queues

Use the List queues operation to programmatically retrieve a list of message queues (both point-to-point and publisher-subscriber) along with its name, type, and number of messages and dead letter messages in the queue. This operation leverages the deprecated functionality provided by the GET queue list operation. You must have the Runtime Management privilege to use this operation. The List queues action is an asynchronous process:

1. The client sends an initial GET request to the that specifies a Runtime ID for the Runtime, Runtime cluster, or Runtime cloud containing the message queue that the user wants to retrieve.
2. The platform returns a status code 202 while the request is in process. A 200 status code indicates that the request is complete.
3. The client sends a second GET request using the Session ID value provided in the first response.
4. The second GET response returns all message queues available in the Runtime ID specified in step 1.

Retrieves a ListQueues object by identifier

After receiving a 200 status code response, send a second GET request where {accountId} is the ID of the account authenticating the request and sessionId is the ID provided in the initial response.

Authorizations:

basicAuth

path Parameters

token required

string Takes in the token from a previous call to return a result.

Responses

Response Schema:

application/jsonapplication/xmlapplication/json

responseStatusCode required	integer <int32>
numberOfResults	integer <int32>
	Array of objects (ListQueues)

Boomi Platform API Endpoint URL. {accountId} is the Account ID of the authenticated Boomi platform account making this request.

https://api.boomi.com/api/rest/v1/{accountId}/async/ListQueues/response/{token}

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

• "AsyncOperationResult": {

  • "numberOfResults": "3",
  • "responseStatusCode": "200",
  • "result": [

    • {

      • "xsi_type": "QueueRecord",
      • "queueName": "Queue1",
      • "queueType": "Point-to-Point",
      • "messagesCount": "150",
      • "deadLettersCount": "0"

      },
    • {

      • "xsi_type": "QueueRecord",
      • "queueName": "Queue2",
      • "queueType": "Publish/Subscribe",
      • "messagesCount": "18",
      • "deadLettersCount": "2",
      • "topicSubscribers": [

        • {

          • "SubscriberName": "123fb43d-a5c6-7890-123d-a4c56789ece0",
          • "messageCount": "9",
          • "deadLettersCount": "1"

          },
        • {

          • "SubscriberName": "e4d567d3-cd89-0aae-b123-6848dcf975f0",
          • "messageCount": "9",
          • "deadLettersCount": "1"

          }

        ]

      },
    • {

      • "xsi_type": "QueueRecord",
      • "queueName": "Queue3",
      • "queueType": "Point-to-Point",
      • "messagesCount": "150",
      • "deadLettersCount": "0"

      }

    ]

  }

}

Retrieves a ListQueues object by identifier

To retrieve a list of message queues, Send an HTTP GET where accountId is the account that you are authenticating with and containerId is the ID of the Runtime, Runtime cluster, or Runtime cloud which owns the message queue that you want to retrieve.

Note: You can find the Account ID for an account by navigating to Settings > Account Information and Setup in the user interface. Additionally, you can find the container ID by navigating to Manage > Runtime Management and viewing the Runtime ID value on the Runtime Information panel for a selected Runtime, Runtime cluster, or Runtime cloud.

Authorizations:

basicAuth

path Parameters

id required

string

Responses

Response Schema:

application/jsonapplication/xmlapplication/json

required	object (AsyncToken)
responseStatusCode required	integer <int32>

Boomi Platform API Endpoint URL. {accountId} is the Account ID of the authenticated Boomi platform account making this request.

https://api.boomi.com/api/rest/v1/{accountId}/async/ListQueues/{id}

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

• "QueueMessageResponse": {

  • "sessionId": "QueueList-5678f901-23e4-567d-8b9e-01b234cc5678",
  • "message": "Request submitted to query queue messages"

  }

}