FindEvents

Searches for events based on the specified criteria.

Sample SOAP Request

Request Parameters

Name

Description

Type

Optional

searchParameters

Supported search parameters:

  • incidentIdentifier: if specified, limits returned events to those related to this incident ID (exact match).
  • startDate: if specified, limits returned events to those created after this time.  Should be specified in the the following format (GMT):

dd/mm/yyyy h:mm:ss AM/PM

  • endDate: if specified, limits returned events to those created before this time. Should be specified in the following format (GMT):

dd/mm/yyyy h:mm:ss AM/PM

  • eventStatusList: if specified, limits events to those with states among those specified.  Valid values are ACTIVE, TERMINATED, SUSPENDED, TERMINATED_BY_USER, TERMINATED_WITH_ERR and TERMINATED_EXTERNALLY.
  • datasource: indicates whether returned events are limited to runtime or archive

EventSearchParameters

no

Sample SOAP Response

Response Parameters

Name

Description

Type

event

List of events associated with the specified incident.  Each event listed includes the event identifier, the event creation date, the tokens associated with the event, and the status of the event.

The possible event statuses are as follows:

  • ACTIVE: the event is currently active
  • SUSPENDED: the event has been temporarily suspended
  • TERMINATED: the event has been terminated
  • TERMINATED_EXTERNAL: the event was terminated by an external source
  • TERMINATED_BY_USER: the event was terminated by a user
  • TERMINATED_WITH_ERR: the event was terminated because of an error

SoapFindEvent

serverTimestamp

Time corresponding to the server time when the request was made (this should match the associated persisted audit event)

string

status

Final status of the request

string

Standard SOAP Parameters

SOAP Response Status Messages