Boomi Platform API Reference (1.0.0) - ExecutionRequest

License: Boomi API License and Rate Limits

Download OpenAPI Specification: Download

ExecutionRequest

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

Note: You must have the Execute privilege 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:

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 Runtime on which to run the process. The response returns a requestId.
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).
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 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.
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.

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.

Creates an ExecutionRequest object

Submits the process to run and returns results immediately. The operation does not wait for the run to complete.

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 Runtime or its associated Environment.

Authorizations:

basicAuth

Request Body schema:
application/json
optional

required	object (ExecutionRequestDynamicProcessProperties) 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.
required	object (ExecutionRequestProcessProperties) The full list of Process properties within the specified Runtime, Runtime cluster, or cloud, where each property is defined by their name and value.
atomId required	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 Runtime 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.
processName	string
recordUrl	string (Response-only field) The ID of the process run. This field is returned in the initial POST response and is used in the subsequent call to find the corresponding run record.
requestId	string

Responses

Response Schema:
application/json

required	object (ExecutionRequestDynamicProcessProperties) 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.
required	object (ExecutionRequestProcessProperties) The full list of Process properties within the specified Runtime, Runtime cluster, or cloud, where each property is defined by their name and value.
atomId required	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 Runtime 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.
processName	string
recordUrl	string (Response-only field) The ID of the process run. This field is returned in the initial POST response and is used in the subsequent call to find the corresponding run record.
requestId	string

Request samples

Payload

Content type

application/json

{"@type": "ExecutionRequest",
"atomId": "3456789a-bcde-f0123-4567-89abcdef012",
"processId": "789abcde-f012-3456-789a-bcdef0123456",
"DynamicProcessProperties": {"DynamicProcessProperty": [{"name": "property1",
"value": "value1"
}
]
},
"ProcessProperties": {"ProcessProperty": [{"componentId": "456789a-bcde-f0123-4567-89abcdef012",
"ProcessPropertyValue": [{"key": "key1",
"value": "property1"
}
]
}
]
}
}

Response samples

200
403
410
503