Waiting for engine...
Skip to main content

Boomi Platform API Reference (1.0.0) - ExecutionArtifacts

Toggle Pane
API docs by Redocly

License: Boomi API License and Rate Limits

Download OpenAPI Specification: Download

Download execution artifacts

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:

  1. 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.
  2. The Enterprise platform returns a download URL for the specified run ID and a status code 202 while the request is in progress.
  3. 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.

  4. The Enterprise platform downloads the ExecutionArtifacts\log.zip file to the your local Downloads folder. Then, you can open the file by extracting the zip file.

Creates an ExecutionArtifacts object

Allows you to retrieve a link for downloading detailed information about a given process run.

  • 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. To retrieve the download link for file containing a process execution artifacts,
  1. First create a CREATE (or POST) request to https://api.boomi.com/api/rest/v1/<accountId>/ExecutionArtifacts where accountId is the ID of the account authenticating the request.
  2. Populate the request body with the executionId, which is the identifier of the given run process.
  3. Send the request and either open or copy and paste the URL from the response into your web browser.
Authorizations:
basicAuth
Request Body schema:
optional
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.

Responses

Response Schema:
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.

Request samples

Content type
{
  • "executionId": "execution-3456789a-bcde-f012-3456-789abcdef012-2015.01.01"
}

Response samples

Content type
{}