Waiting for engine...
Skip to main content

Boomi Platform API Reference (1.0.0) - ProcessLog

Toggle Pane
API docs by Redocly

License: Boomi API License and Rate Limits

Download OpenAPI Specification: Download

Download Process Log

Runtime cloud owners and tenants in a Cloud can use the Download Process Log operation to download their accounts’ process run logs. You can use process logs for compliance, reporting, or diagnostic purposes. To download process logs, you must have access to the account and the environment in which the process exists. You must also have the View Results privilege. Because large process logs can take a while to download, the Platform API provides an asynchronous technique for requesting and downloading these logs.

Note: If you use a connector, rather than a direct http request, you will need to choose EXECUTE to obtain the process logs. To download the process log operation via a http request:

  1. The client sends a process log request to the Boomi Enterprise Platform API that specifies the process run ID and, optionally, the process run log level.
  2. The Enterprise platform returns a Log Download object that contains a URL with a unique process log ID.
  3. The client opens the URL to download the log.

Note: Process logs are purged 30 days after their creation.

Required Privileges

You need these privileges in the target environment:

Write access

  • API — Use the Boomi Platform API to access account data.
  • VIEW_RESULT — View and monitor process execution activity and logs.
  • user access to deployed environment and atom

Read access

  • N/A

Creates a ProcessLog object

Download process run logs.

Authorizations:
basicAuth
Request Body schema:
optional
executionId
string

The ID of the process run.

logLevel
string
Enum: "SEVERE" "WARNING" "INFO" "CONFIG" "FINE" "FINER" "FINEST" "ALL"

The process execution log level with ALL being the default.

If you do not specify the log level, you receive all types of logs. The log level is case sensitive; you must use all uppercase letters.

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
{
  • "executionId": "execution-3456789a-bcde-f012-3456-789abcdef012-2015.01.01",
  • "logLevel": "ALL"
}

Response samples

Content type
{}