IncidentListRequest

The list of incidents to retrieve. The list can be filtered using the following elements:

• ServiceDeskName – The name of the service desk to query.
• Status – One or more status values to match. If no status values are supplied, then tickets are retrieved regardless of status.
• Priority – One or more priority values to match. If no priority values are supplied, then tickets are retrieved regardless of priority.
• Stage – One or more stage values to match. If no stage values are supplied, then tickets are retrieved regardless offstage.
• SummarySearch – a string or expression to search the summary of tickets.
• Organization – The name or partial name of organizations to match. If not supplied, then tickets are retrieved for all organizations within the scope.
• OrganizationStaff – The name of an organizational staff member. associated with tickets. If not supplied, then tickets are retrieved for all organizations within the scope.
• Machine – The name of a machine to match. If not supplied, then tickets are retrieved for all machines within the scope.
• MachineGroup – The name of a machine group to match. If not supplied, then tickets are retrieved for all machine groups within the scope.
• Assignee – The name or partial name of assignees to match. If not supplied, then tickers are retrieved for all assignees within scope.
• StartingIncident – When paging, this is the next incident number to retrieve. This value comes from the nextStartingIncident value of a previous GetIncidentList request.
• IncidentCount – When present, specifies the number of incidents to retrieve.
• SortField – When present, sorts the results on the field name.

SessionId

decimal

The web service session ID.

ReturnDescription

boolean

If true, the response includes a Description element for each incident in the list. If false, the Description element is not included in the response.

IncidentList

The list of matching incidents.

The following attributes are returned.

• totalIncidents – The total number of incidents that match the request.
• nextStartingIncident – the Id of the next incident to retrieve.

Each incident returns the following elements:

• ServiceDeskName
• IncidentNumber
• Summary - The summary line of the ticket.
• Description - The description of the incident. Provided only if the request includes the ReturnDescription element set to true.
• Status
• Stage
• CreateDateTime
• LastEditDateTime
• OrgID
• OrganizationName
• Machine
• MachineGroup
• IsUnread - The ticket has not yet been opened.

Method

string

The operation that requested this response.

TransactionID

decimal

The unique message ID for this message.

ErrorMessage

string

If blank, no error was returned.

ErrorLocation

string

If blank, no error was returned.