[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.ServiceAssembly: QPulseWebServices (in QPulseWebServices.dll) Version: 2.0.2.15
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
| Exception | Condition |
|---|---|
| ServiceFaultCode..::.AuthenticationFailed | The token provided could not be authenticated. |
| ServiceFaultCode..::.SessionInvalid | The Q-Pulse session was invalid. |