Execute Process operation

You use the Execute Process operation to asynchronously run a process on a particular Runtime.

Important

The Execution Request object leverages the existing functionality provided by the Execute Process operation. Although both are available for use, Boomi recommends using the Execution Request object. For more information about detailing additional benefits, refer to the Execution Request object topic.

The Execute Process operation is an asynchronous call that submits the process to run and returns results immediately. The operation does not wait for the run to complete.

Parameters

The following parameters are required to perform the executeProcess operation:

Parameter
Description

processId or processName
The ID or name of the process to be run. If using the name, it must be unique within the account.

atomId
The ID of the Runtime on which to run the process.

Note: The API also accepts dynamic process properties. Their specified values override corresponding values persisted from previous runs. Dynamic process property names must match exactly. The API does not accept process property components.

RESTish implementation

To perform the executeProcess operation, send an HTTP POST to:

https://api.boomi.com/api/rest/v1/accountId/executeProcess where accountId is the user's account ID.

XML request:

<ProcessExecutionRequest processId="789abcde-f012-3456-789a-bcdef0123456" atomId="3456789a-bcde-f012-3456-789abcdef012" xmlns="http://api.platform.boomi.com/">
    <ProcessProperties>
        <ProcessProperty>
            <Name>priority</Name>
            <Value>medium</Value>
        </ProcessProperty>
    </ProcessProperties>
</ProcessExecutionRequest>

For a JSON request, send the request with the following HTTP header:

Content-Type: application/json

JSON request

{  "ProcessProperties" : {
  	 "@type" : "ProcessProperties",
    "ProcessProperty" : [
      {
         "@type" : "",
         "Name" : "priority",
         "Value": "medium"
      }
    ]
  },
  "processId" : "789abcde-f012-3456-789a-bcdef0123456",
  "atomId" : "3456789a-bcde-f012-3456-789abcdef012"
}

A successful executeProcess call returns an HTTP status code of 200.