Event object

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 Atom 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.

Structure

<Event>
    <eventId/>
    <accountId/>
    <atomId/>
    <atomName/>
    <eventLevel/>
    <eventDate/>
    <status/>
    <eventType/>
    <executionId/>
    <title/>
    <updateDate/>
    <startTime/>
    <endTime/>
    <errorDocumentCount/>
    <inboundDocumentCount/>
    <outboundDocumentCount/>
    <processName/>
    <recordDate/>
    <error/>
    <environment/>
    <classification/>
    <errorType>
    <erroredStepLabel>
    <erroredStepType>
</Event>

Field	Type	Description
Filter	Filter	Filter
eventId	string	The ID of the event.
accountId	string	The ID of the account in which this event occurred.
atomId	string	The ID of the Runtime on which the event occurred.
atomName	string	The name of the Atom on which the event occurred.
eventLevel	string	The notification level of the event (INFO, WARNING, ERROR).
eventDate	dateTime - yyyy-MM-dd'T'HH:mm:ss'Z', for example, 2011-01-31T15:32:00Z	The date and time the event occurred.
status	string	User-specified message for an event of type user.notification. For other types of events, the event status — for example, COMPLETE, ERROR.
eventType	string	The type of the event (atom.status, process.execution, process.missedSchedule, user.notification).
executionId	string	The run ID of the process (for applicable events).
title	string	For an event of type user.notification, the title of the originating step.
updateDate	dateTime - yyyy-MM-dd'T'HH:mm:ss'Z', for example, 2011-01-31T15:32:00Z	The date and time the event was last updated.
startTime	dateTime - yyyy-MM-dd'T'HH:mm:ss'Z', for example, 2011-01-31T15:32:00Z	The start date and time of the run (for applicable events).
endTime	dateTime - yyyy-MM-dd'T'HH:mm:ss'Z', for example, 2011-01-31T15:32:00Z	The end date and time of the run (for applicable events).
errorDocumentCount	int	The number of documents in an error status for the run (for applicable events).
inboundDocumentCount	int	The number of inbound documents for the run (for applicable events).
outboundDocumentCount	int	The number of outbound documents for the run (for applicable events).
processName	string	The name of the process (for applicable events).
recordDate	dateTime - yyyy-MM-dd'T'HH:mm:ss'Z', for example, 2011-01-31T15:32:00Z	The date and time the event recorded.
error	string	The error message (for applicable events).
environment	string	The name of the environment in which the process ran, or to which the Atom is attached. If you do not enable environments in the account, the QUERY does not return this field in the QUERY result.
classification	string	The classification (PROD or TEST) associated with the environment in which the process ran, or to which the Atom is attached. The classification PROD is returned in the QUERY result if you do not enable environments in the account.
errorType	string	DOCUMENT, if the error applied to one or more documents, or PROCESS, if the error occurred at the process level (for applicable events).
erroredStepLabel	string	The label of the step in which the error occurred (for applicable events).
erroredStepType	string	The type of the step in which the error occurred — for example, Start, Connector (for applicable events).
topLevelProcessId	string	The ID of the parent process.
processId	string	The ID of the sub-process ONLY when using the ‘Notify’ shape with the 'Generate Platform Event' option and when the process is executed in the 'General' and 'Bridge' modes.

Supported operations

GET	QUERY	CREATE	UPDATE	EXECUTE	DELETE

You can use the following fields as QUERY filters for the Event object:

Field	Allowed values
eventId	Any string value
accountId	Any string value
atomId	Any string value
atomName	Any string value
eventLevel	INFO, WARNING, or ERROR
eventDate	Date with the format yyyy-MM-dd'T'HH:mm:ss'Z', for example, 2016-01-31T15:32:00Z
status	Any string value
eventType	atom.status, process.execution, process.missedSchedule, user.notification
executionId	Any string value
title	Any string value
updateDate	Date with the format yyyy-MM-dd'T'HH:mm:ss'Z', for example, 2016-01-31T15:32:00Z
startTime	Date with the format yyyy-MM-dd'T'HH:mm:ss'Z' for example, 2016-01-31T15:32:00Z
endTime	Date with the format yyyy-MM-dd'T'HH:mm:ss'Z' for example, 2016-01-31T15:32:00Z
errorDocumentCount	Integer
inboundDocumentCount	Integer
outboundDocumentCount	Integer
processName	Any string value
error	Any string value
environment	Alphanumeric GUID (filter by environment ID)
classification	PROD or TEST
recordDate	Date with the format yyyy-MM-dd'T'HH:mm:ss'Z' (for example, 2016-01-31T15:32:00Z)

The filter operators that are available are:

BETWEEN
EQUALS
LIKE
GREATER_THAN
GREATER_THAN_OR_EQUAL
LESS_THAN
LESS_THAN_OR_EQUAL

For general information about the structure of QUERY filters and how to handle paged results, see the Query filters and Query paging topics.

SOAP implementation

The following example query returns all event records logged during the last seven days with an executionId of execution-01234567-89AB-CDEF-0123-456789ABCDEF-2013.04.23.

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:query>
         <api:objectType>Event</api:objectType>
         <api:queryConfig>
             <api:QueryFilter>
               <api:expression operator="EQUALS" property="executionId"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="api:SimpleExpression">
                 <api:argument>execution-01234567-89AB-CDEF-0123-456789ABCDEF-2013.04.23</api:argument>
               </api:expression>
             </api:QueryFilter>
         </api:queryConfig>
      </api:query>
   </soapenv:Body>
</soapenv:Envelope>

Response:

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <bns:queryResponse xmlns:bns="http://api.platform.boomi.com/" 
          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
         <bns:results numberOfResults="100">
            <bns:result xsi:type="bns:Event">
               <bns:eventId>event-89ABCDEF-0123-4567-89AB-CDEF01234567</bns:eventId>
               <bns:accountId>account-123456</bns:accountId>
               <bns:atomId>CDEF0123-4567-89AB-CDEF-0123456789AB</bns:atomId>
               <bns:atomName>My Desktop Atom</bns:atomName>
               <bns:eventLevel>INFO</bns:eventLevel>
               <bns:eventDate>2013-04-23T16:28:56Z</bns:eventDate>
               <bns:status>Notification message text</bns:status>
               <bns:eventType>user.notification</bns:eventType>
               <bns:executionId>execution-01234567-89AB-CDEF-0123-456789ABCDEF-2013.04.23</bns:executionId>
               <bns:title>Notify</bns:title>
               <bns:updateDate>2013-04-23T16:28:56Z</bns:updateDate>
               <bns:errorDocumentCount>0</bns:errorDocumentCount>
               <bns:inboundDocumentCount>0</bns:inboundDocumentCount>
               <bns:outboundDocumentCount>0</bns:outboundDocumentCount>
               <bns:processName>Read Disk Files</bns:processName>
               <bns:processId>2f7e86c4-32c1-4582-afca-f5f2302fd334</bns:processId>
               <bns:topLevelProcessId>2f7e86c4-32c1-4582-afca-f5f2302fd334</bns:topLevelProcessId>
               <bns:recordDate>2013-04-23T16:29:09Z</bns:recordDate>
               <bns:environment>Operational</bns:environment>
               <bns:classification>PROD</bns:classification>
            </bns:result>
            ...
            <bns:result xsi:type="bns:Event">
               <bns:eventId>event-9ABCDEF0-1234-5678-9ABC-DEF012345678</bns:eventId>
               <bns:accountId>account-123456</bns:accountId>
               <bns:atomId>CDEF0123-4567-89AB-CDEF-0123456789AB</bns:atomId>
               <bns:atomName>My Desktop Atom</bns:atomName>
               <bns:eventLevel>INFO</bns:eventLevel>
               <bns:eventDate>2013-04-23T16:28:55Z</bns:eventDate>
               <bns:status>COMPLETE</bns:status>
               <bns:eventType>process.execution</bns:eventType>
               <bns:executionId>execution-01234567-89AB-CDEF-0123-456789ABCDEF-2013.04.23</bns:executionId>
               <bns:updateDate>2013-04-23T16:28:55Z</bns:updateDate>
               <bns:startTime>2013-04-23T16:28:55Z</bns:startTime>
               <bns:endTime>2013-04-23T16:28:56Z</bns:endTime>
               <bns:errorDocumentCount>0</bns:errorDocumentCount>
               <bns:inboundDocumentCount>50</bns:inboundDocumentCount>
               <bns:outboundDocumentCount>0</bns:outboundDocumentCount>
               <bns:recordDate>2013-04-23T16:29:09Z</bns:recordDate>
               <bns:environment>Operational</bns:environment>
               <bns:classification>PROD</bns:classification>
            </bns:result>
         </bns:results>
      </bns:queryResponse>
   </S:Body>
</S:Envelope>

The maximum number of results returned per QUERY response is 100. This response includes a queryToken element, which means there are more than 100 results to retrieve. The Query paging topic describes how to use a queryMore call to retrieve more results.

Structure​

Supported operations​

SOAP implementation​

Structure

Supported operations

SOAP implementation