Execute Automation

Triggers a "Start Process" automation that has already been configured for the organization. This enqueues the automation for asynchronous execution; it does not run the automation synchronously. The response is returned as soon as the automation has been queued, not once it has finished running.

The automation to run is identified by its operation IRI, which can be found by getting or searching for a metadata resource through the API. Automations that are not categorized as "Start Process" operations are rejected.

Access requirement: Requires an admin token. It also requires admin access to the organization.

Body Params
string
required

Operation IRI identifying which automation to execute, of the form "system:automation/{automationId}/.../Operation". Found by getting or searching for a metadata resource. Only the automation id embedded in this IRI is used to identify the automation; the automation's own stored configuration determines the operation that runs.

string
required

Organization agent ID that owns the automation to execute.

string
required

IRI of the metadata resource the automation should act on.

Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json