execution_record

Boomi AtomSphere API: Execution Record Object

boomi_cicd.util.execution_record.get_completed_execution_status(request_id, request_interval_sec=10, max_wait_sec=300)[source]

Sends a GET request to the Boomi AtomSphere API to retrieve the completed execution status for a given request ID. The function keeps sending requests until the status is not ‘INPROCESS’ or until the maximum wait time is exceeded. This function will return the final status of the process execution.

Parameters:

request_id (str) – The request ID from Execution Request.
request_interval_sec (int) – The interval in seconds between each request. Default is 10 seconds.
max_wait_sec (int) – The maximum time in seconds to keep making a request. Default is 300 seconds, 5 minutes.

Returns:

The response from the Atomsphere API ExecutionRecord call. The dict will contain executionId and status.

Return type:

dict

Raises:

TimeoutError – If the maximum wait time is exceeded, a TimeoutError is raised.

boomi_cicd.util.execution_record.get_execution_record(request_id)[source]

Sends a GET request to the Boomi AtomSphere API to retrieve the execution record for a given request ID. The request ID can be obtained from execution_request.create_execution_request().

Parameters:: request_id (str) – The requeste id from Execution Request.
Returns:: The response from the Atomsphere API ExecutionRecord call.
Return type:: requests.Response

boomi_cicd.util.execution_record.get_execution_status(request_id, request_internal_sec=10, max_wait_sec=300)[source]

Sends a GET request to the Boomi AtomSphere API to retrieve the execution status for a given request ID. The function keeps sending requests until the status code is not 202, which means the execution is still pending or until the maximum wait time is exceeded. This function will return whatever the status is within Process Reporting.