Waiting for engine...
Skip to main content

Boomi Platform API Reference (1.0.0) - Event

Toggle Pane
API docs by Redocly

License: Boomi API License and Rate Limits

Download OpenAPI Specification: Download

Run In Postman

For more information about Postman collections, forking, and making your first API call, refer to the Working with Boomi APIs on Postman page.

Event

Event records correspond to the notifications that are available in the RSS feeds and sent in email notifications. The Event object returns information about the different types of events, including process run events, user notifications, and Runtime monitoring events. The Event object returns process details information via the user.notification record, such as topLevelProcessId, processId, and processName.

Note: Purging of event records occurs after seven days.

Required Privileges

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 Event 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: eventId, accountId, atomId, atomName, eventLevel, eventDate, status, eventType, executionId, title, updateDate, startTime, endTime, errorDocumentCount, inboundDocumentCount, outboundDocumentCount, processName, recordDate, error, environment, classification

required
object
required
EventSimpleExpression (object) or EventGroupingExpression (object) (EventExpression)
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: "eventId" "accountId" "atomId" "atomName" "eventLevel" "eventDate" "status" "eventType" "executionId" "title" "updateDate" "startTime" "endTime" "errorDocumentCount" "inboundDocumentCount" "outboundDocumentCount" "processName" "recordDate" "error" "environment" "classification"
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 (Event)

Request samples

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

Response samples

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

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

Response samples

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