Waiting for engine...
Skip to main content

API actions

In addition to object-based operations, the Boomi Enterprise Platform API supports action-based operations that do not fall into the object/verb hierarchy.

Boomi supports the following action-based operations:

Important

To import these operations, you must select the EXECUTE connector action in the Boomi Enterprise Platform API and Partner API connectors. The Upgrade Java operation is not available for importing.

  • Cancel execution — cancel a process run that is currently running on a particular Runtime.

  • Change listener status — pause, resume, or restart listeners

  • Clear queue messages — clear all messages for a given Atom queue.

  • Connector document — retrieve a list of connector document data for a given process run.

  • Deploy component — (Legacy deployment, Deprecated) copy a component deployment from one environment to another.

  • Deploy process — (Legacy deployment, Deprecated) copy a process deployment from one environment to another.

  • Download AS2 artifacts log — asynchronously download the AS2 artifacts log for a particular Atom for a particular date.

  • Download Atom log — asynchronously download the Atom log for a particular Atom for a particular date.

  • Download Execution worker log — asynchronously download logs for a particular Execution worker**.

  • Download execution artifacts — asynchronously download run artifacts for a particular process.

  • Download process log — asynchronously download log(s) for a particular process run.

  • Execute process — asynchronously run a process on a particular Runtime.

  • Get assignable roles — retrieve the list of roles assignable under an account.

  • List queues — retrieve the list of queues associated with a given account.

  • Move queue request — move messages from one Atom queue to another.

  • Provision partner customer account — provision a partner customer account with specified features as a subordinate account of the partner account.

  • Purge Atom data — initiate the purge process for Atom data, like browse components and logs.

  • Rerun document — rerun one or more documents.

  • Roll back Java — roll back a runtime or container to use its previous version of .

  • Upgrade Java — upgrade a given container (runtime, Runtime cluster, Runtime cloud, Authentication Broker, or API Gateway, or ) to 's latest supported version of Java.