Download execution artifacts operation

The Download execution artifacts operation allows users to programmatically retrieve a link for downloading detailed information about a given process run.

Execution artifacts provide granular information about a process run. After downloading, you can view process and data logs, metrics such as how long it took for a process shape to run, and more. The functionality provided by the Download execution artifacts operation is similar to the act of downloading execution artifacts from the Process Reporting page in the user interface (Manage > Process Reporting > Actions menu > View Extended Information).

note

When a Cloud owner enables the Enable Download of Execution Artifacts and Worker Logs property on the Cloud Attachment Quotas tab (Manage > Cloud Management) of the Integration user interface, account users can employ the Download execution artifacts operation to retrieve a download link for viewing process execution artifacts.

Retrieving a process' execution artifacts is an asynchronous process:

You send a CREATE (or POST) request to the Boomi Enterprise Platform API that specifies an account ID in the endpoint and a run ID in the request body.
The Enterprise platform returns a download URL for the specified run ID and a status code 202 while the request is in progress.
Press CTRL and left-click on the link to initiate the download in their default browser.

note
You can also copy and paste the link into your web browser to begin the download. The browser might require you to enter your sign-in credentials.
The Enterprise platform downloads the ExecutionArtifacts_<executionId>_log.zip file to the your local Downloads folder. Then, you can open the file by extracting the zip file.

Structure

POST request body:

<ExecutionArtifacts xmlns="http://api.platform.boomi.com/" executionId=""/>

POST response:

<bns:LogDownload url="hhttp://api.platform.boomi.com/account/..." message="" url="" statusCode=""/>

Field	Type	Description
Filter	Filter	Filter
executionId	string	The ID of the given process run. You can access the run ID in the View Extended Information dialog (Manage > Process Reporting > Action menu) on the user interface.
message	string	A message stating that the download is initiated.
statusCode	string	The 202 status code returned from a POST or CREATE request that starts a download link and is in progress.
url	string	The URL that initiates the artifacts download to local storage.

Supported operations

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

Using the CREATE operation

You must have the Runtime Management privilege to perform the CREATE operation. If you have the Runtime Management Read Access privilege, you cannot download execution artifacts.
Additionally, as the Cloud owner, you must select the Enable Download of Execution Artifacts and Worker Logs property for your account. This property permits you to download process execution data, and you can access it from the Cloud Attachment Quota tab of Manage > Cloud Management.
After providing the endpoint and a request body containing the execution ID, the CREATE response returns a download URL that you can open (or copy and paste) in your web browser, which initiates the file download to your local drive.

SOAP implementation

CREATE operation

Sample SOAP request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://api.platform.boomi.com/">
<soapenv:Header/>
<soapenv:Body>
      <api:create>
         <object xsi:type="api:ExecutionArtifacts" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
             executionId="execution-3456789a-bcde-f012-3456-789abcdef012-2015.01.01">
         </object>
      </api:create>
   </soapenv:Body>
   </soapenv:Envelope>

Sample SOAP response:

<?xml version='1.0' encoding='UTF-8'?>
<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:LogDownload" url="http://api.platform.boomi.com/account/account-123456/api/download/ExecutionArtifacts-dfd12f34-58d6-7890-bdb1-f23456789012" message="Beginning download." statusCode="202"/>
        </bns:createResponse>
    </S:Body>
</S:Envelope>

Structure​

Supported operations​

Using the CREATE operation​

SOAP implementation​

Structure

Supported operations

Using the CREATE operation

SOAP implementation