Boomi Platform API Reference (1.0.0) - cancelExecution

Toggle Pane

• cancelExecution
  • postcancelExecution operation

API docs by Redocly

License: Boomi API License and Rate Limits

Download OpenAPI Specification: Download

For more information about Postman collections, forking, and making your first API call, refer to the Working with Boomi APIs on Postman page.

cancelExecution

You can use the cancelExecution object to cancel a current process run on a particular runtime. To cancel a process run, you must have the Execute privilege and access to both the process and the runtime on which the process is currently running.

cancelExecution operation

To perform a cancelExecution operation, send an HTTP POST to:

https://api.boomi.com/api/rest/v1/{accountId}/cancelExecution/{executionId}

where accountId is the user's account ID and executionId is the ID of the process running on a runtime.

A successful cancelExecution call returns an HTTP status code of 202. An error message appears if you cannot cancel the run because the runtime is not running.

Authorizations:

basicAuth

path Parameters

executionId required

string A unique identifier assigned by the system to a running process

Responses

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}/cancelExecution/{executionId}

Response samples

• 202
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

• "message": "Operation completed successfully."

}