QueryEvent

Returns the status of a specified xMatters event. The statuses of all notifications associated with the event are also returned.

Sample SOAP Request

Request Parameters

Name

Description

Type

Optional

eventIdentifier

Identifier of the event to query

long

no

Sample SOAP Response

Response Parameters

Name

Description

Type

eventCreatedTimestamp

Time when the specified event was created.

string

eventStatus

The status of the specified event:

  • ACTIVE: event currently active
  • NOTIFICATION_IN_PROCESS: event cannot be queried because a notification is in process (try again later)
  • 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

string

eventTokens

Collection of name/value pairs representing the input parameters of the specified event

ListEventTokens

incidentIdentifier

Identifier for the incident with which the specified event is associated

string

notifications

List of scheduled notifications and their statuses, qualified by Group, Team, User and Device. See below for a list of possible statuses.

Group and Person notifications include a futureNotificationTime element that contains the time for the next scheduled notification (if there is one) in GMT, in the following format:

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

NotificationList

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

Notification statuses

The following sections list the statuses possible for each type of notification.

Group:
Team:
Person:
Device:

Standard SOAP Parameters

SOAP Response Status Messages