Waiting for engine...
Skip to main content

Boomi Platform API Reference (1.0.0) - MoveQueueRequest

Toggle Pane
API docs by Redocly

License: Boomi API License and Rate Limits

Download OpenAPI Specification: Download

Move queue request

Use the Move queue request operation to programmatically move messages from one Runtime queue to another using the CREATE operation.

You must have the Runtime Management privilege to use the Move queue request operation. To move messages between Runtime queues, they must reside on the same Runtime and be of the same type (for example, Point-to-Point or Publish/Subscribe).

Creates a MoveQueueRequest object

Moves messages from one Runtime queue to another.

  • You must have the Runtime Management privilege to use the Move queue request operation.
  • You can only move messages between queues of the same type. For example, moving queue messages from a point-to-point queue to a Publish/Subscribe queue results in an error.
  • Any Runtime queues that you specify in the request must currently exist on the Runtime. For clarification, you cannot create a new endpoint using the CREATE operation.
  • You must supply the AtomID, SourceQueue, QueueName, DLQ, and DestinationQueue fields in the request.
  • If the operation returns an error, it logs a message in the Runtime, Runtime cluster, or Runtime cloud, but is not sent to the platform.
  • You cannot track move updates directly through this operation. Instead, to see if the action is in progress or complete, use the Queue Management API or the ListQueues API to observe the number of messages in the queue.
Authorizations:
basicAuth
Request Body schema:
optional
AtomId
required
string

(Required) The Runtime ID that the queue or topic exists under and where you can find it in Runtime Management. You can find the Runtime ID for Runtimes, Runtime clusters, and Runtime clouds in the user interface by navigating to Manage > Runtime Management and viewing the Runtime Information panel for a selected container.

required
object (QueueAttributes)

(Required) An instance of a generalized queue object indicating the queue from which to send or obtain the messages. Contains information describing the desired queue.

required
object (QueueAttributes)

(Required) An instance of a generalized queue object indicating the queue from which to send or obtain the messages. Contains information describing the desired queue.

Responses

Response Schema:
AtomId
required
string

(Required) The Runtime ID that the queue or topic exists under and where you can find it in Runtime Management. You can find the Runtime ID for Runtimes, Runtime clusters, and Runtime clouds in the user interface by navigating to Manage > Runtime Management and viewing the Runtime Information panel for a selected container.

required
object (QueueAttributes)

(Required) An instance of a generalized queue object indicating the queue from which to send or obtain the messages. Contains information describing the desired queue.

required
object (QueueAttributes)

(Required) An instance of a generalized queue object indicating the queue from which to send or obtain the messages. Contains information describing the desired queue.

Request samples

Content type
{
  • "AtomId": "Atom_ID",
  • "SourceQueue": {
    • "QueueName": "queue1",
    • "SubscriberName": "SUBSCRIBER_ID",
    • "DLQ": "true"
    },
  • "DestinationQueue": {
    • "QueueName": "pubsub1",
    • "SubscriberName": "SUBSCRIBER_ID",
    • "DLQ": "false"
    }
}

Response samples

Content type
{
  • "@type": "QueueMessageResponse",
  • "message": "Request submitted to atom id: <atomId> to move queue messages from <queue_name> to <queue_name>"
}