📄️ 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.
📄️ Cancel execution operation
You can use the cancelExecution operation to cancel a current process run on a particular {conKeyRefs.UCAtomRuntime}.
📄️ Change listener status operation
You can use the changeListenerStatus operation to pause, resume, or restart listeners. You can change the status of a single listener or all listeners for a {conKeyRefs.AtomRuntime}, {conKeyRefs.UCMoleculeRuntimeCluster}, or {conKeyRefs.UCAtomCloud_RuntimeCloud}.
📄️ Clear queue messages operation
Use the Clear queue messages operation to programmatically delete all messages in a {conKeyRefs.UCAtomRuntime} queue for a given {conKeyRefs.UCAtomRuntime}, {conKeyRefs.UCMoleculeRuntimeCluster}, or {conKeyRefs.UCAtomCloudRuntimeCloud}.
📄️ Connection Licensing operation
The Connection Licensing operation provides a detailed response to the Test and Production connector classes that have been deployed to one or more environments.
📄️ Connector Document operation
You can programmatically download and view connector document data for a Generic Connector Record.
📄️ Deploy component operation (Legacy deployment, Deprecated)
You can use the deployComponent operation to copy a component deployment from one environment to another.
📄️ Deploy process operation (Legacy deployment, Deprecated)
You can use the deployProcess operation to copy a process deployment from one environment to another.
📄️ Download AS2 Artifacts Log operation
You can use the Download AS2 Artifacts Log operation to request and download AS2 artifacts logs.
📄️ Download Atom Log operation
You can use the Download Atom Log operation to request and download Atom logs.
📄️ Download Atom worker log operation
The Download Atom worker log operation allows users to programmatically retrieve a link for downloading a given {conKeyRefs.UCAtomWorkerExecutionWorker}'s log.
📄️ Download Process Log operation
{conKeyRefs.UCAtomCloudRuntimeCloud} owners and tenants in a Cloud can use the Download Process Log operation to download their accounts’ process run logs. You can use process logs for compliance, reporting, or diagnostic purposes.
📄️ Download execution artifacts operation
The Download execution artifacts operation allows users to programmatically retrieve a link for downloading detailed information about a given process run.
📄️ Download shared web server log operation
You can use the Download shared web server log operation to programmatically retrieve the web server logs from your runtime or {conKeyRefs.UCAtomCloudRuntimeCloud} attachment.
📄️ Execute Process operation
You use the Execute Process operation to asynchronously run a process on a particular {conKeyRefs.UCAtomRuntime}.
📄️ Get Assignable Roles operation
You can use the Get Assignable Roles operation to retrieve a list of roles that are assignable under a account.
📄️ 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.
📄️ List queues operation
Use the List queues 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.
📄️ Move queue request operation
Use the Move queue request operation to programmatically move messages from one Atom queue to another using the CREATE operation.
📄️ Provision Partner Customer Account operation
Partners can use the Provision Partner Customer Account operation by to programmatically provision accounts for their customers as secondary accounts of the partner account.
📄️ Purge Atom Cloud attachment operation
You can use the Purge Atom Cloud attachment operation to programmatically start the purge process for test and browse components, logs, processed documents, and temporary data for a {conKeyRefs.UCAtomCloudRuntimeCloud} attachment.
📄️ Rerun Document operation
The Rerun Document object allows you to reprocess one or more documents from a previous run. You can rerun documents from a process’ Start shape or Trading Partner shape only.
📄️ Roll back Java operation
Use the Roll back Java operation to programmatically return a {conKeyRefs.AtomRuntime}, {conKeyRefs.UCMoleculeRuntimeCluster}, {conKeyRefs.UCAtomCloud_RuntimeCloud}, Authentication Broker, or Gateway to use the previous version of Java with an EXECUTE operation.
📄️ Upgrade Java operation
Use the Upgrade Java operation to programmatically download and run the Java upgrader script for a specified {conKeyRefs.AtomRuntime}, {conKeyRefs.UCMoleculeRuntimeCluster}, {conKeyRefs.UCAtomCloud_RuntimeCloud}, or API Gateway.
