Waiting for engine...
Skip to main content

Download Process Log operation

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 through the API, 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 awhile to download, the Boomi Enterprise 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.

Process Log object​

Specify the Process Log object in a CREATE operation to request the downloading of a process run log.

NameTypeDescription
executionIdstringThe ID of the process run.
logLevelstring(Optional) The process execution log level: SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST, or ALL (the default).

If you do not specify the log level, you receive all types of logs.

In REST calls, the log level is case sensitive. You must use all uppercase letters.
GETQUERYCREATEUPDATEEXECUTEDELETE
Not supportedNot supportedSupportedNot supportedNot supportedNot supported

RESTish implementation

Send an HTTP POST to:

https://api.boomi.com/api/rest/v1/accountId/ProcessLog

where accountId is the ID of the authenticating account for the request.

The following example requests the download of all types of logs for a process run whose ID is 3456789a-bcde-f0123-4567-89abcdef012.

XML request:

<ProcessLog xmlns="http://api.platform.boomi.com/" executionId="execution-3456789a-bcde-f012-3456-789abcdef012-2015.01.01" logLevel="ALL"/>

For a JSON request, send the request with the following HTTP header:

Content-Type: application/json

JSON request:

{
   "executionId" : "execution-3456789a-bcde-f012-3456-789abcdef012-2015.01.01",
   "logLevel" : "ALL"
}

SOAP Implementation

The following example requests the download of all types of logs for a process run whose ID is 3456789a-bcde-f0123-4567-89abcdef012.

Request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://api.platform.boomi.com/">
   <soapenv:Header>
      <wsse:Security
       xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
        <wsse:UsernameToken wsu:Id="UsernameToken" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
          <wsse:Username>ATOMSPHERE_USER_NAME</wsse:Username>
          <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">
 ATOMSPHERE_PASSWORD
          </wsse:Password>
        </wsse:UsernameToken>
      </wsse:Security>
   </soapenv:Header>
   <soapenv:Body>
      <api:create>
         <object xsi:type="api:ProcessLog" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
             executionId="execution-3456789a-bcde-f012-3456-789abcdef012-2015.01.01" logLevel="ALL">
         </object>
      </api:create>
   </soapenv:Body>
</soapenv:Envelope>

Log Download object​

The Log Download object is the response to a process log request.

NameTypeDescription
statusCodestringThe status code as one of the following:
- 202 — status message: Beginning download.
- 504 — status message: Atom is unavailable.
messagestringThe status message.
urlstring(statusCode 202 only) The URL for the download.

RESTish implementation

Here is the RESTish XML response to the example process log request shown above:

<bns:LogDownload statusCode="202" message="Beginning download." 
             url="http://localhost:8081/account/account-123456/api/download/ProcessLog-89abcdef-0123-4567-89ab-cdef01234567"
     xmlns:bns="http://api.platform.boomi.com/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>

Here is the JSON-formatted response to the example process log request shown above:

{
  "@type" : "LogDownload",
  "url" : "http://localhost:8081/account/account-123456/api/download/ProcessLog-89abcdef-0123-4567-89ab-cdef01234567",
  "message" : "Beginning download.",
  "statusCode" : 202
}

SOAP implementation

Here is the SOAP response to the example process log request shown above:

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <bns:createResponse xmlns:bns="http://api.platform.boomi.com/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
         <bns:result xsi:type="bns:LogDownload" statusCode="202" message="Beginning download." 
             url="http://localhost:8081/account/account-123456/api/download/ProcessLog-89abcdef-0123-4567-89ab-cdef01234567"/>
      </bns:createResponse>
   </S:Body>
</S:Envelope>

Download request responses​

The download URL specified in a Log Download response, such as http://localhost:8081/account/account-123456/api/download/ProcessLog-89abcdef-0123-4567-89ab-cdef01234567, is valid for a single request. These are the possible responses to an HTTP request to open a download URL:

Status code
Description

200 (OK)
The download is complete. The downloaded log is in the response body.

All subsequent requests to open the download URL returns 404 (Not Found).

202 (Accepted)
The download is in progress.

Before returning a final download response, you might receive multiple 202 responses.

204 (No Content)
Log data is not available.

All subsequent requests to open the download URL returns 404 (Not Found).

404 (Not Found)
A 200, 204, or 504 response was returned from a previous request to open this URL.

504 (Gateway Timeout)
The Runtime is unavailable. It might have timed out.

All subsequent requests to open the download URL returns 404 (Not Found).

On this Page