QueryIncident

Returns a list of all events associated with the specified xMatters incident, and the status of each event.

Sample SOAP Request

Request Parameters

Name

Description

Type

Optional

incidentIdentifier

The identifier of the incident to query

string

no

Sample SOAP Response

Response Parameters

Name

Description

Type

event

List of events associated with the specified incident, including each event’s identifier, creation date, associated tokens, and status. The possible event statuses are as follows:

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

SoapEvent

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