Get queues list operation (deprecated)

Use the Get queues list 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.

Important

The Get queues list operation is deprecated. Boomi recommends that you transition to use newer functionality provided by the List queues operation for retrieving a list of message queues.

You must have the Runtime Management privilege to use this action. The Get queues list action is an asynchronous process:

1. The client sends an initial GET request to the that specifies an 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 progress. 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.

Structure

<bns:result xsi:type="bns:QueueRecord" queueName="" queueType="" messagesCount="" deadLettersCount=""/>

Field	Type	Description
Filter	Filter	Filter
containerId	string	The unique ID assigned by the system to the container.Use the Runtime ID for runtimes and runtime cloud clusters found in the user interface by navigating to Manage > Runtime Management and viewing the Atom Information panel for a selected container.
queueName	string	The name of the message queue.
queueType	string	The type of message queue — Point-to-Point or Publish/Subscribe.
messagesCount	integer	The aggregate count of messages in the message or subscriber queue.
deadLettersCount	integer	The aggregate count of the message queue’s or subscriber queue's dead letters.

Supported operations

GET	QUERY	CREATE	UPDATE	EXECUTE	DELETE
Supported	Not Supported	Not Supported	Not Supported	Not Supported	Not Supported

Using the GET operation

• The GET operation returns a list of all message queues that exist for a given container. You must have the Runtime Management privilege to use perform this operation.

• If the response is not yet ready, the initial GET response returns a 202 responseStatusCode. Boomi encourages you to continue polling the same Session ID until the responseStatusCode returns a 200 status code. After receiving a 200 status, you cannot use the same Session ID again.

RESTish implementation

• GET operation

To retrieve a list of message queues:

1. Send a GET request to https://api.boomi.com/api/rest/v1/<accountId>/QueueList/<containerId> , where accountID is the ID of the account authenticating the request and containerId is the ID of the runtime, Runtime cluster, or Runtime cloud that owns the message queue you want to retrieve.

   note

   You can find the Account ID by navigating to Settings > Account Information and Setup in the user interface.

   You can find the container ID by navigating to Manage > Runtime Management in the user interface, and viewing the Runtime ID value on the Atom Information panel for a selected Runtime, Runtime cluster, or Runtime cloud.

2. After receiving a 200 status code response, send a second GET request to https://api.boom.com/api/rest/v1/<accountId>/async/QueueList/response/<sessionId>, where accountID is the ID of the account authenticating the request and sessionId is the ID provided in the initial response.

XML response (first GET request):

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<bns:QueueMessageResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:bns="http://api.platform.boomi.com/" sessionId="QueueList-5678f901-23e4-567d-8b9e-01b234cc5678" message="Request submitted to query queue messages"/>

XML response (for the second GET request using Session ID):

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<bns:AsyncOperationResult xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:bns="http://api.platform.boomi.com/" numberOfResults="3" responseStatusCode="200">
    <bns:result xsi:type="bns:QueueRecord" queueName="Queue1" queueType="Point-to-Point" messagesCount="150" deadLettersCount="0"/>
    <bns:result xsi:type="bns:QueueRecord" queueName="Queue2" queueType="Publish/Subscribe" messagesCount="18" deadLettersCount="2">
        <bns:topicSubscribers SubscriberName="123fb43d-a5c6-7890-123d-a4c56789ece0" messageCount="9" deadLettersCount="1"/>
        <bns:topicSubscribers SubscriberName="e4d567d3-cd89-0aae-b123-6848dcf975f0" messageCount="9" deadLettersCount="1"/>
    </bns:result>
    <bns:result xsi:type="bns:QueueRecord" queueName="Queue3" queueType="Point-to-Point" messagesCount="150" deadLettersCount="0"/>
</bns:AsyncOperationResult>

JSON response (first GET request):

{
    "@type": "QueueMessageResponse",
    "sessionId": "QueueList-5678f901-23e4-567d-8b9e-01b234cc5678",
    "message": "Request submitted to query queue messages"
}

JSON response (for the second GET request using Session ID):

{
    "@type": "AsyncOperationResult",
    "result": [
        {
            "@type": "QueueRecord",
            "queueName": "Queue1",
            "queueType": "Point-to-Point",
            "messagesCount": 150,
            "deadLettersCount": 0
        },
        {
            "@type": "QueueRecord",
            "topicSubscribers": [
                {
                    "@type": "TopicSubscriber",
                    "SubscriberName": "123fb43d-a5c6-7890-123d-a4c56789ece0",
                    "messageCount": 10,
                    "deadLettersCount": 0
                },
                {
                    "@type": "TopicSubscriber",
                    "SubscriberName": "e4d567d3-cd89-0aae-b123-6848dcf975f0",
                    "messageCount": 10,
                    "deadLettersCount": 0
                }
            ],
            "queueName": "Queue2",
            "queueType": "Publish/Subscribe",
            "messagesCount": 20,
            "deadLettersCount": 0
        },
        {
            "@type": "QueueRecord",
            "queueName": "Queue3",
            "queueType": "Point-to-Point",
            "messagesCount": 150,
            "deadLettersCount": 0
        }
    ],
    "numberOfResults": 3,
    "responseStatusCode": 200
}