[This is preliminary documentation and is subject to change.]

Enables a user to search for incidents records. This method is an alternative to SearchIncidentsCompact(). Where SearchIncidentsCompact() returns only the Incident Numbers, SearchIncidents() returns full descriptions of found records.

Namespace: QPulseWebServices.Contracts.Service
Assembly: QPulseWebServices.Contracts (in QPulseWebServices.Contracts.dll) Version: 2.100.591.48

Syntax

C#
Incident[] GetIncidents(
	string token,
	IncidentQuery query,
	bool includeOccurrences
)

Parameters

token
Type: System..::..String
An authentication token previously requested from the Core service.
query
Type: QPulseWebServices.Contracts.Data..::..IncidentQuery
The query against which to search for incidents.
includeOccurrences
Type: System..::..Boolean
Whether to include occurrence records as children of the incident record. (These records can be retrieved asynchronously using the occurrence service).

Return Value

An Array of Incidents

Remarks

REST Availability: Supports HTTP POST

Exceptions

ExceptionCondition
ServiceFaultCode..::..AuthenticationFailedThe token provided could not be authenticated.
ServiceFaultCode..::..SessionInvalidThe Q-Pulse session was invalid.

See Also