Waiting for engine...
Skip to main content

Boomi Platform API Reference (1.0.0) - AtomWorkerLog

Toggle Pane
API docs by Redocly

License: Boomi API License and Rate Limits

Download OpenAPI Specification: Download

Download Atom worker log

The Download Atom worker log operation allows users to programmatically retrieve a link for downloading a given Execution worker's log. When a Cloud owner enables the Enable Download of Execution Artifacts and Worker Logs property on the Cloud Attachment Quotas tab (Cloud Management) of the Integration user interface, account users can employ the Download Atom worker log operation to retrieve a download link for viewing a specific Execution worker's logs. The functionality provided by the Download Atom worker log operation is similar to downloading Worker logs from the Workers panel in the Integration user interface (Manage --> Runtime Management --> select a Runtime cloud --> Workers panel --> Actions menu). Retrieving a worker log is an asynchronous process:

  1. The client sends a CREATE or POST request to the Boomi Enterprise Platform API that specifies a Cloud ID in the endpoint and an execution worker ID in the request body.

  2. The Enterprise platform returns a download URL for the specified Execution worker and a status code 202 while the request is in progress.

  3. To download the link to your web browser, press CTRL and then left-click on the link.

    Note: You can also copy and paste the link into your web browser to start the download. You might need to enter your sign-in credentials.

  4. The Enterprise platform downloads the SoaWorkerLog\log.zip file to the your local Downloads folder. You can open the worker log by extracting the zipped file.

Creates an AtomWorkerLog object

Allows users to programmatically retrieve a link for downloading a given Runtime workers log.

Authorizations:
basicAuth
Request Body schema:
optional
workerId
string

The name of an execution worker. Locate the name of an execution worker by navigating to the Runtime Workers panel in Manage > Runtime Management on the user interface.

Responses

Response Schema:
statusCode
string

The status code as one of the following:

  • 202 — status message: Beginning download.
  • 504 — status message: Runtime is unavailable.
message
string

The status message.

url
string

(statusCode 202 only) The URL for the download.

Request samples

Content type
{
  • "workerId": "worker-1c2345c-b6e7-8f9f-01e-2345678ad91-2020.08.31"
}

Response samples

Content type
{}