get
/v2/Incidents
Returns a list of incidents based on privileges assigned to the authenticated Security Center user and filters specified in the query parameters.
Current limitation: the total results count value will always be null unless the IsRecipient filter is set.
Query parameters
expand
String
This query parameter allows you to retrieve sub-resources immediately instead of retrieving them in a separate request.
It is possible to expand multiple properties by delimiting them with commas, or specifying "all" to expand all sub-resources.
For the list of expandable sub-resources, please consult the **Incident** model in the **Models** section.
Example:
expand_example
dateTimeFrom
Date
date-time
This query parameter allows you to retrieve incidents that were triggered after the provided date.
<br />You can specify date in either of the following formats:
<br /><ul><li>Local date and time format: yyyy-mm-dd hh:mm:ss</li><li>UTC format: yyyy-mm-ddThh:mm:ssZ</li></ul>
Example:
2013-10-20T19:20:30+01:00
dateTimeTo
Date
date-time
This query parameter allows you to retrieve incidents that were triggered before the provided date.
<br />You can specify date in either of the following formats:
<br /><ul><li>Local date and time format: yyyy-mm-dd hh:mm:ss</li><li>UTC format: yyyy-mm-ddThh:mm:ssZ</li></ul>
Example:
2013-10-20T19:20:30+01:00
isRecipient
Boolean
This query parameter allows you to retrieve incidents for which you are a recipient or a supervisor
<br />You must specify either 'true' or 'false'.
<br /><br />Note: User cannot enable _IsRecipient_ filter and _Closed_ state filter at the same time.
Example:
true
incidentTypeIds
array[UUID]
uuid
This query parameter allows you to retrieve incidents that match the incident type identifier (the available types can be retrieved from a separate endpoint).
<br />It is possible to provide a list of identifiers by delimiting them with commas.
locationIds
array[UUID]
uuid
This query parameter allows you to retrieve incidents that match the location identifier.
<br />It is possible to provide a list of identifiers by delimiting them with commas.
ownerIds
array[UUID]
uuid
This query parameter allows you to retrieve incidents that match the user identifier.
<br />It is possible to provide a list of identifiers by delimiting them with commas.
priorityIds
array[UUID]
uuid
This query parameter allows you to retrieve incidents that match the incident priority identifier (the available priorities can be retrieved from a separate endpoint).
<br />It is possible to provide a list of identifiers by delimiting them with commas.
stateIds
array[UUID]
uuid
This query parameter allows you to retrieve incidents that match the incident state identifier (the available states can be retrieved from a separate endpoint).
<br />It is possible to provide a list of identifiers by delimiting them with commas.
<br /><br />Note: Users must have the _Third-party integration mode_ privilege or the _Incident report_ privilege.
additionalFields
array[String]
This query parameter allows you to retrieve incidents that matches every single additional field filter (each string item is a different field).
<br />The syntax we use to retrieve the additional field is in a LHS format with the fieldName, compare mode and value as the required information.
<br /><br />Format: fieldName[compareMode]=value
<br /><br />Note: Using box brackets([ ]) or the equal sign(=) as characters in the fieldName or value will break the LHS format.
<br /><br /> Compare Mode with data type:
<br />String and URL - Equals, NotEquals, Contains, DoesNotContain, StartsWith, DoesNotStartWith, EndsWith, DoesNotEndWith
<br />Number - Equals, NotEquals, GreaterThan, GreaterThanOrEquals, LessThan, LessThanOrEquals
<br />Boolean - Equals, NotEquals
<br /><br /> Examples:
<br />Name[Equals]=John (Retrieving every incident that has John as value for field name).
<br />NumberOfPeople[GreaterThan]=5 (Retrieving every incident that has more than 5 as value for field NumberOfPeople).
offset
Integer
int32
This query parameter allows you to set the number of items to be skipped.
<br />The default value for this parameter is 0.
Example:
56
limit
Integer
int32
This query parameter allows you to set the number of items to retrieve. Maximum value: 100.
<br />The default value for this parameter is 25.
Example:
56
sortBy
String
This query parameter allows you to sort the incident list based on specific incident properties defined in the Models page of this documentation.
<br />You can specify the sort preference in the following format: IncidentProperty.OrderParameter.
<br />The <em>IncidentProperty</em> should be replaced by one of the values from the <em>IncidentSortingProperties</em> enum defined in the Models page of this documentation.
<br />The <em>OrderParameter</em> should be replaced by one the following values:
<li>ascending or asc</li><li>descending or desc</li><br /><br />The default value is displayId.desc.
Example:
sortBy_example
CLIENT REQUEST
curl -X 'GET'
-H
'Accept: application/json'
'http://localhost/v2/Incidents?expand=expand_example&dateTimeFrom=2013-10-20T19:20:30+01:00&dateTimeTo=2013-10-20T19:20:30+01:00&isRecipient=true&incidentTypeIds=&locationIds=&ownerIds=&priorityIds=&stateIds=&additionalFields=&showEligibility=true&offset=56&limit=56&sortBy=sortBy_example'
Responses
Success
Body
TotalResultsCountIntegerint32
ResultsArray[none]
RESPONSE
{
"TotalResultsCount": 3,
"Results": [
{
"Id": "080af006-33d4-400a-bae8-dd7a7db85c3a",
"Name": "Incident One",
"TypeId": "1d5b8469-f22d-4460-9c9d-8fdc94bf7373",
"TypeRevision": 42,
"Description": "Description One",
"DisplayId": "1",
"ExternalId": "",
"RecipientsMode": 2,
"RecipientIds": [
"e77bf3ff-920b-44e2-8934-894ba63a0c32",
"f31afd00-2f96-4ac5-8f59-8786e38ced97",
"4f594cdc-f2dc-4032-8815-c097adaf2a7d"
],
"StateId": "775a9416-be54-4628-806e-80daf4dbae65",
"PendingStates": [],
"DisabledStates": [],
"PriorityId": "ef76b1e3-ea07-4254-bbcc-e750b29a36cc",
"OwnerId": "a152451d-2785-46e8-995a-835f67c040eb",
"TriggerTimeUtc": "2023-08-15T21:10:09.2771622Z",
"Location": {
"EntityId": "411eb140-b1b3-476f-a0ea-f6014f84bf63",
"Latitude": 45.478759,
"Longitude": -73.761054
},
"CurrentStepId": "bce3fae8-d22b-408a-872a-23b098d185d2",
"ProcedureId": "dc7646e7-d9c1-44c1-b894-0ae3488599d8",
"ProcedureRevision": 1234,
"IconId": "c2fdd46e-cc7d-4cfd-920d-71749fbe5b47",
"ArgbColor": "#AABBCCDD",
"ParentId": "93dae057-6b9a-41a2-a237-029ed5e4e28d",
"SoundId": "b91ec526-e90a-4ee2-9d90-4ca371f836f6",
"Issues": "None",
"_links": {
"Events": "/Incidents/080af006-33d4-400a-bae8-dd7a7db85c3a/Events",
"PossibleStateTransitions": "/Incidents/080af006-33d4-400a-bae8-dd7a7db85c3a/PossibleStateTransitions"
}
},
{
"Id": "0e5968b8-ec4f-4467-b8bc-788945988d3f",
"Name": "Incident Two",
"TypeId": "25b2baa2-6e44-456b-bacd-1208ed7e821b",
"TypeRevision": 42,
"Description": "",
"DisplayId": "2",
"ExternalId": "",
"RecipientsMode": 2,
"RecipientIds": [
"2eaee226-423b-4ac3-8043-e82f477762b9",
"4635199e-e6ca-4397-b345-4dbf5eb35c41",
"5dff31c0-7458-42d5-8221-d0774161e1b5"
],
"StateId": "775a9416-be54-4628-806e-80daf4dbae65",
"PendingStates": [],
"DisabledStates": [],
"PriorityId": "ef76b1e3-ea07-4254-bbcc-e750b29a36cc",
"OwnerId": "356f53a1-3f66-490a-9d0d-ad6ae020f6c3",
"TriggerTimeUtc": "2023-08-15T21:10:09.2772326Z",
"Location": {
"EntityId": "8dd74f64-cb2b-47e7-afd6-484e2c618e6c",
"Latitude": 45.478759,
"Longitude": -73.761054
},
"CurrentStepId": "d516319e-50d9-4565-949b-fb0e7f199c51",
"ProcedureId": "9554e297-f07d-4db3-a2ac-30c0842d3582",
"ProcedureRevision": 1234,
"IconId": "b41858b5-196f-4782-892d-42eb9a9ccb5d",
"ArgbColor": "#AABBCCDD",
"ParentId": "1ac23ff3-031c-4ce3-9f34-c20e94f05c01",
"SoundId": "794da312-0271-4380-97df-614aad3459fa",
"Issues": "None",
"_links": {
"Events": "/Incidents/0e5968b8-ec4f-4467-b8bc-788945988d3f/Events",
"PossibleStateTransitions": "/Incidents/0e5968b8-ec4f-4467-b8bc-788945988d3f/PossibleStateTransitions"
}
},
{
"Id": "3804d428-2277-4260-ba15-bd8df4a5eecd",
"Name": "Incident Three",
"TypeId": "49bdaa41-d898-49b1-b9c0-791e87397481",
"TypeRevision": 42,
"Description": "Description Three",
"DisplayId": "3",
"ExternalId": "",
"RecipientsMode": 2,
"RecipientIds": [
"455b8dc4-5f09-4593-a9a2-f50293146e75",
"4ac7e75e-372b-4fca-b704-8a989fb4c3c7",
"0fa3ab62-ce4e-4a7d-b4ee-d72a1b4016a9"
],
"StateId": "775a9416-be54-4628-806e-80daf4dbae65",
"PendingStates": [],
"DisabledStates": [],
"PriorityId": "ef76b1e3-ea07-4254-bbcc-e750b29a36cc",
"OwnerId": "7b5156ca-223f-49a5-8d83-571a3a154dad",
"TriggerTimeUtc": "2023-08-15T21:10:09.2772754Z",
"Location": {
"EntityId": "4a821a55-331f-43df-a536-fb67334bde55",
"Latitude": 45.478759,
"Longitude": -73.761054
},
"CurrentStepId": "3b6a730c-c2b6-4e07-b3bb-21385e574eeb",
"ProcedureId": "3309659a-453f-477c-a9f8-2aad30cdbeb1",
"ProcedureRevision": 1234,
"IconId": "6fbfb9d3-252b-419c-9c2a-81a4a5f9aae7",
"ArgbColor": "#AABBCCDD",
"ParentId": "02d873a1-75f6-4eb3-84ed-16344230e90a",
"SoundId": "b9e55c10-f3dc-414f-9069-4913d8fd6062",
"Issues": "None",
"_links": {
"Events": "/Incidents/3804d428-2277-4260-ba15-bd8df4a5eecd/Events",
"PossibleStateTransitions": "/Incidents/3804d428-2277-4260-ba15-bd8df4a5eecd/PossibleStateTransitions"
}
}
]
}