incidents
Retrieves a list of incidents by filtering on a limited set of URI parameters
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| isSignedOff |
Indicates whether or not the item has been signed off/locked. |
boolean |
None. |
| signedOffStartDate |
Used for filtering. Only includes items which have a signed off date greater than or equal to the date provided. ISO-8601 format. yyyy-mm-dd, such as 1989-05-22 or MMM-dd-yyyy (MAY-22-1989) |
string |
None. |
| signedOffEndDate |
Used for filtering. Only includes items which have a signed off date less than or equal to the date provided. ISO-8601 format. yyyy-mm-dd, such as 1989-05-22 or MMM-dd-yyyy (MAY-22-1989) |
string |
None. |
| title |
Used for searching for a partial or complete match to the item's title. You can specify this column for sorting. |
string |
None. |
| sort |
Sort by the specified URI parameter. Sort can be applied to title and IsSignedOff fields. i.e. url?sort=title or url?sort=IsSignedOff. The default sort direction is ascending. |
string |
None. |
| sortDirection |
Sorts in ascending or descending order. "Asc" for ascending order, or "Desc" for descending order. |
string |
None. |
Body Parameters
None.
Response Information
Standard Responses
A list of incidents that match the filtering criteria applied to the requested site and below
| Name | Description | Type | Additional information |
|---|---|---|---|
| pagingInfo | PagingInfoDto |
None. |
|
| values | Collection of FormSummaryDto |
None. |
|
| links | Collection of LinkDto |
None. |
Error Responses
| HTTP Status Code | Error Message | Type | Additional Information |
|---|