Waiting for engine...
Skip to main content

Boomi Platform API Reference (1.0.0) - ClearQueue

Toggle Pane
API docs by Redocly

License: Boomi API License and Rate Limits

Download OpenAPI Specification: Download

Clear queue messages

Use the Clear queue messages operation to programmatically delete all messages in a Runtime queue for a given Runtime, Runtime cluster, or Runtime cloud. This action is similar to the Clear Messages action located on Queue Management panel Manage --> Runtime Management of the interface.

Executes an action on a ClearQueue object

  • When you run the Clear queue messages action, it deletes all messages in a queue name from the queue. Note that this clears all messages in the queue; you cannot select and remove individual messages using this action. In addition, the action overrides any purge settings you might configure in the user interface.
  • The immediate response indicates success in passing the request to the Runtime.
  • If the specified Runtime queue does not contain any messages to clear, the response only returns a success message stating that the message passed even though there is no action taken on the Runtime.
  • You can use the Get queue list API action to retrieve the number of messages in a queue, which works as an alternative way to check if the clear queue message action succeeded on the Runtime.
Authorizations:
basicAuth
path Parameters
id
required
string

The unique ID assigned by the system to the container. The Runtime ID for Runtimes, Runtime clusters, and Runtime clouds is found in the user interface by navigating to Manage > Runtime Management and viewing the Runtime Information panel for the selected container.

Request Body schema:
optional
AtomId
required
string

The unique ID assigned by the system to the container.
The Runtime ID for Runtimes, Runtime clusters, and Runtime clouds is found in the user interface by navigating to Manage > Runtime Management and viewing the Runtime Information panel for the selected container.

QueueName
required
string

The name of the queue or topic. You can locate the queue or topic name by navigating to Manage > Runtime Management > Queue Management panel or by employing the ListQueues API action to retrieve the names of all queues on a given Runtime.

DLQ
boolean

When set to true, it deletes messages from the regular queue only.When set to false (default), it deletes messages from the regular queue.

SubscriberName
string

The subscriber name as it exists on the Runtime. You can find the subscriber name using the ListQueues API action or by looking up the Component ID of the process tied to the subscriber.

Note: The subscriber name does not necessarily equate to the Subscriber Name as is shown in Queue Management. If there is a process in Queue Management with the same name, use the Component ID of that process.

Responses

Response Schema:
AtomId
required
string

The unique ID assigned by the system to the container.
The Runtime ID for Runtimes, Runtime clusters, and Runtime clouds is found in the user interface by navigating to Manage > Runtime Management and viewing the Runtime Information panel for the selected container.

QueueName
required
string

The name of the queue or topic. You can locate the queue or topic name by navigating to Manage > Runtime Management > Queue Management panel or by employing the ListQueues API action to retrieve the names of all queues on a given Runtime.

DLQ
boolean

When set to true, it deletes messages from the regular queue only.When set to false (default), it deletes messages from the regular queue.

SubscriberName
string

The subscriber name as it exists on the Runtime. You can find the subscriber name using the ListQueues API action or by looking up the Component ID of the process tied to the subscriber.

Note: The subscriber name does not necessarily equate to the Subscriber Name as is shown in Queue Management. If there is a process in Queue Management with the same name, use the Component ID of that process.

Request samples

Content type
{
  • "QueueName": "QUEUE_NAME",
  • "AtomId": "ATOM_ID",
  • "SubscriberName": "SUBSCRIBER_ID",
  • "DLQ": "false"
}

Response samples

Content type
{
  • "@type": "QueueMessageResponse",
  • "message": "Request submitted to Request submitted to atom id: (atomId) to clear atom queue: (queue)"
}