Execution Request object

Use the Execution Request object to asynchronously run an integration process on a given Atom using a CREATE operation.

note

You must have the Executeprivilege for the intended environment to use this object.

The action provided by the Execution Request object is similar to running a process from Process Reporting in the user interface.

Retrieving the run record:

Use the Execution Request object with the Execution Record object to retrieve the run record, as described in the following steps.

Requesting a process run is an asynchronous process:

1. Send a POST request to the Execution Request object with a request body that specifies both the ID of the process that you want to run and the desired Atom on which to run the process. The response returns a requestId.

2. Using the requestId returned in Step 1, make a subsequent call to the Execution Record object to retrieve detailed information about the process run (in other words, the run record).

3. Repeatedly poll the Execution Record object with the requestId until the run record is available. If the ExecutionRecord is not available yet, it returns an HTTP 202 status code.

Benefits of using the Execution Request object

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. The Execution Request object provides these additional benefits:

• A means for you to correlate the run request to the actual run, which helps a developer know whether a test passed or failed in the result.

• Support for passing process property component property values in addition to dynamic process properties. Currently, the Execute Process operation supports passing dynamic process properties only.

• Additional validations to ensure that you deploy process properly and can be run.

• Returns a requestId that you can use in a subsequent call to the Execution Record object. The Execute Process operation does not return a requestId value.

Structure

<ExecutionRequest requestId="" recordUrl="" processId="" atomId="" xmlns="http://api.platform.boomi.com/">
    <DynamicProcessProperties>
        <DynamicProcessProperty name="" value=""/>
        <DynamicProcessProperty name="" value=""/>
    </DynamicProcessProperties>
    <ProcessProperties>
         <ProcessProperty componentId="">
	     <ProcessPropertyValue key="" value=""/>
	     <ProcessPropertyValue key="" value=""/>
          </ProcessProperty>
    </ProcessProperties>
</ExecutionRequest>

Field	Type	Description
atomId	string	The ID of the Runtime on which to run the process. Locate the Runtime ID by navigating to Manage > Runtime Management on the user interface, and viewing the Atom Information panel for a selected Runtime.
processId	string	The ID of the process to run. You can find ID of a process by locating the process' Component ID in the Revision History dialog on the user interface.
recordUrl	string	(Response-only field) The full endpoint URL used to make a second call to the Execution Record object. This URL is provided for your convenience in the recordUrl field of the initial POST response.
ProcessProperty	string	The full list of Process properties within the specified Runtime, Runtime cluster, or Cloud, where each property is defined by their name and value.
DynamicProcessProperty	string	The full list of Dynamic Process properties within the specified Runtime, Runtime cluster, or Cloud, where each property is defined by their name and value.

note

• This API object accepts dynamic process properties and process properties components. Their specified values override corresponding values persisted from previous runs. The dynamic process property names must match exactly. For additional clarity, the properties you provide in the request override persisted properties or extensions. This object does not validate property component IDs, property keys, or field values. The object does not error in these cases and as a result, those properties are not set.

• Also, if environment extensions are used to set property values, those values override anything passed in the API call.

Supported operations

GET	QUERY	CREATE	UPDATE	EXECUTE	DELETE
Not Supported	Not Supported	Supported	Not Supported	Not Supported	Not Supported

Using the CREATE operation

• The Execution Request response returns a requestID, which you use to make a subsequent call to the Execution Record object to retrieve detailed information about the process run.

• This operation returns an error when the client:

  • Fails authentication or does not have the correct permissions
  • Supplies an invalid Account ID
  • Supplies an invalid Runtime ID
  • Attempts to reach a deleted Atom
  • Supplies an invalid Process ID
  • Missing privileges to run processes on the given Atom or its associated Environment

SOAP implementation

CREATE operation

To run a process, send a POST request to:

https://api.boomi.com/api/soap/v1/<accountID>?wsdl

where accountID is the ID of the account authenticating the request.

note

You can find the Account ID for an account by navigating to Settings > Account Information and Setup in the user interface.

Sample SOAP request:

<?xml version='1.0' encoding='UTF-8'?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <create xmlns="http://api.platform.boomi.com/">
<object xmlns="" xmlns:ns1="http://api.platform.boomi.com/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" atomId="3456789a-bcde-f0123-4567-89abcdef012" processId="789abcde-f012-3456-789a-bcdef0123456" xsi:type="ns1:ExecutionRequest" /><accountId xmlns="" /></create>
  </soap:Body>
  </soap:Envelope>

Sample SOAP response:

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
    <S:Body>
        <bns:createResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:bns="http://api.platform.boomi.com/">
            <result xsi:type="bns:ExecutionRequest" processId="789abcde-f012-3456-789a-bcdef0123456" atomId="3456789a-bcde-f0123-4567-89abcdef012" requestId="executionrecord-110b23f4-567a-8d90-1234-56789e0b123d" recordUrl="https://api.boomi.com/api/rest/v1/account1234/ExecutionRecord/async/executionrecord-110b23f4-567a-8d90-1234-56789e0b123d"/>
        </bns:createResponse>
    </S:Body>
</S:Envelope>