Waiting for engine...
Skip to main content

Boomi Platform API Reference (1.0.0) - ExecutionSummaryRecord

Toggle Pane
API docs by Redocly

License: Boomi API License and Rate Limits

Download OpenAPI Specification: Download

ExecutionSummaryRecord

The Execution Summary Record object enables the retrieval of run information for processes that use the Low Latency option. You can use this information to populate the Real-time Dashboard in the user interface. Each object represents a block of time and contains summary information for runs occurring during that time block.

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.

Queries for an ExecutionSummaryRecord 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: processId, timeBlock, atomId, status, reportKey, launcherId

required
object
required
ExecutionSummaryRecordSimpleExpression (object) or ExecutionSummaryRecordGroupingExpression (object) (ExecutionSummaryRecordExpression)
One of
operator
required
string
Enum: "EQUALS" "LIKE" "NOT_EQUALS" "IS_NULL" "IS_NOT_NULL" "BETWEEN" "GREATER_THAN" "GREATER_THAN_OR_EQUAL" "LESS_THAN" "LESS_THAN_OR_EQUAL" "CONTAINS" "NOT_CONTAINS"
property
required
string
Enum: "processId" "timeBlock" "atomId" "status" "reportKey" "launcherId"
argument
Array of strings

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 (ExecutionSummaryRecord)

Request samples

Content type
Example
{
  • "QueryFilter": {
    • "expression": {
      }
    }
}

Response samples

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

Retrieves additional results for an ExecutionSummaryRecord 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 (ExecutionSummaryRecord)

Response samples

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