Next Topic

Previous Topic

Book Contents

GetIncidentList

Retrieve a list of incidents matching the request criteria. The request is:

IncidentRequest

 

The incident to retrieve. This has the following fields:

  • 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.
  • Summary – 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.

The response is the following:

IncidentList

 

The list of matching incidents. This has the following attributes and elements:

  • totalIncidents – The total number of incidents that match the request.
  • nextStartingIncident – the Id of the next incident to retrieve.
  • Incident – zero or more incident matching the request criteria.

SessionId

Decimal

The web service session ID.