Waiting for engine...
Skip to main content

Boomi Platform API Reference (1.0.0) - ExecutionRecord

Toggle Pane
API docs by Redocly

License: Boomi API License and Rate Limits

Download OpenAPI Specification: Download

ExecutionRecord

Execution records correspond to the Executions search on the Process Reporting page in the user interface. The Execution Record object contains information about a process run, including the run date, status, process information, Runtime information, and error messages along with other fields.

Required Privileges

You need these privileges in the target environment:

Write access

  • N/A

Read access

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

Retrieves an instance of an ExecutionRecord object

  • Use the GET operation with the Execution Request object. You use the Execution Request object to asynchronously run an integration process on a given Atom using a CREATE operation. Therefore, the Execution Record GET operation allows you to poll for when the run request is complete.
  • The Execution Request object POST response returns a requestId. Use the requestId in a subsequent call to the Execution Record object, which provides a record of the successful process run.
  • Repeatedly poll the Execution Record object with requestId until the run record is available. If the ExecutionRecord is not available, it returns an HTTP 202 status code. When the ExecutionRecord is available, it returns the Execution Record object's payload.

Note: For long running processes, you may need to continue to poll ExecutionRecord until it returns a completed status such as COMPLETE or ERROR.

Authorizations:
basicAuth
path Parameters
id
required
string

Responses

Response Schema:
account
required
string

The ID of the account in which you ran this execution.

atomId
required
string

The ID of the Runtime the on which the process ran.

atomName
required
string

The name of the Runtime on which the process ran.

executionId
required
string

The ID of the execution.

executionTime
required
string <date-time>

The start date and time this run.

executionType
required
string
Enum: "exec_manual" "exec_sched" "exec_listener" "exec_listener_bridge" "exec_remote" "retry_manual" "retry_sched" "fiber" "sub_process" "test_manual" "test_sub_process" "unknown"

Indicates how initiation of the process run occurred. Possible values are:
- exec_listener (run initiated by a listener request)
- exec_manual (manual run)
- exec_sched (scheduled run)
- retry_manual (manual retry)
- retry_sched (scheduled retry)
- sub_process (subprocess call)
- test_manual (test mode run)

launcherID
required
string

The API Service component that kicks off the run.

Note: The Runtime must have the API Type set to Advanced on the Shared Web Server tab of Runtime Management to specify the launcherID.

message
required
string

Any error message returned from the run.

nodeId
required
string

The ID of the Molecule node in which the run occurred for a process run in a Runtime cluster or Runtime cloud. For a run occurring in a Runtime, this field is omitted.

originalExecutionId
required
string

The original execution ID, if this execution is a retry.

parentExecutionId
required
string

The ID of the run of the parent process, if this run and the parent process’ run were both subprocesses.

processId
required
string

The ID of the run process.

processName
required
string

The name of the run process.

recordedDate
required
string <date-time>

The end time when the process execution completes.

reportKey
required
string

The web service user that authenticated to make the run request.

Note: For Runtimes with an Authentication Type of External Provider, the reportKey is the API Key. Otherwise, it is the specified user name.

status
required
string

The status of the run. Possible values are:
- ABORTED
- ABORTED_RECOVERING
- COMPLETE
- COMPLETE_WARN
- DISCARDED
- ENQUEUED
- ERROR
- INPROCESS
- STARTED

topLevelExecutionId
required
string

The ID of the run of the top-level process, if this run is a subprocess.

executionDuration
integer <int64>

The number of milliseconds it took to run the process.

inboundDocumentCount
integer <int32>

The number of processed inbound documents.

inboundDocumentSize
integer <int64>

The aggregate size in bytes of the processed inbound documents.

inboundErrorDocumentCount
integer <int32>

The number of processed inbound documents with errors.

outboundDocumentCount
integer <int32>

The number of processed outbound documents.

outboundDocumentSize
integer <int64>

The aggregate size in bytes of the processed outbound documents.

Response samples

Content type
{
  • "account": "account1234",
  • "atomId": "3456789a-bcde-f0123-4567-89abcdef012",
  • "atomName": "Boomi Atom",
  • "executionDuration": "4827",
  • "executionId": "execution-110b23f4-567a-8d90-1234-56789e0b123d",
  • "executionTime": "2020-12-08T16:20:11Z",
  • "executionType": "exec_manual",
  • "inboundDocumentCount": "1",
  • "inboundDocumentSize": "0",
  • "inboundErrorDocumentCount": "0",
  • "launcherID": "string",
  • "message": "string",
  • "nodeId": "172_16_22_55[execution-110b23f4-567a-8d90-1234-56789e0b123d]",
  • "originalExecutionId": "string",
  • "outboundDocumentCount": "0",
  • "outboundDocumentSize": "0",
  • "parentExecutionId": "string",
  • "processId": "789abcde-f012-3456-789a-bcdef0123456",
  • "processName": "My First Process",
  • "recordedDate": "2019-08-24T14:15:22Z",
  • "reportKey": "string",
  • "status": "COMPLETE",
  • "topLevelExecutionId": "string"
}

Queries for an ExecutionRecord object(s)

For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to Query filters and Query paging.

Authorizations:
basicAuth
Request Body schema:
optional

Possible properties include: executionId, originalExecutionId, account, executionTime, status, executionType, processName, processId, atomName, atomId, inboundDocumentCount, outboundDocumentCount, executionDuration, message, reportKey, launcherId, nodeId, recordedDate

required
object
object

Responses

Response Schema:
numberOfResults
integer <int32>
queryToken
string

By default, the queryToken parameter is not available in the query response. It appears only when the query response contains more than 100 results. The maximum number of results returned per query is 100. To retrieve the next set of results, use the queryToken in the queryMore request.

Array of objects (ExecutionRecord)

Request samples

Content type
Example
{
  • "QueryFilter": {
    • "expression": {
      }
    },
  • "QuerySort": {
    • "sortField": [
      ]
    }
}

Response samples

Content type
{
  • "@type": "QueryResult",
  • "result": [
    • {
      },
    • {
      },
    • {
      },
    • {
      }
    ],
  • "numberOfResults": 4
}

Retrieves additional results for an ExecutionRecord query

To learn about using queryMore, refer to the topic Query paging.

Authorizations:
basicAuth
Request Body schema: text/plain
required
string

Responses

Response Schema:
numberOfResults
integer <int32>
queryToken
string

By default, the queryToken parameter is not available in the query response. It appears only when the query response contains more than 100 results. The maximum number of results returned per query is 100. To retrieve the next set of results, use the queryToken in the queryMore request.

Array of objects (ExecutionRecord)

Response samples

Content type
{
  • "@type": "QueryResult",
  • "result": [
    • {
      },
    • {
      },
    • {
      },
    • {
      }
    ],
  • "numberOfResults": 4
}