List Incidents (POST)

POST

https://api.devrev.ai/incidents.list

POST

/incidents.list

1 curl -X POST https://api.devrev.ai/incidents.list \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{}'

Try it

1 {
2   "incidents": [
3     {
4       "id": "foo",
5       "title": "foo",
6       "acknowledged_date": "2023-01-01T12:00:00.000Z",
7       "actual_close_date": "2023-01-01T12:00:00.000Z",
8       "applies_to_parts": [
9         {
10           "display_id": "foo",
11           "id": "foo",
12           "name": "foo",
13           "owned_by": [
14             {}
15           ],
16           "sync_metadata": {
17             "external_reference": "foo",
18             "origin_system": "foo"
19           }
20         }
21       ],
22       "artifacts": [
23         {
24           "id": "foo",
25           "display_id": "foo",
26           "file": {
27             "type": "foo",
28             "name": "foo",
29             "size": 42
30           }
31         }
32       ],
33       "body": "foo",
34       "created_by": {
35         "display_id": "foo",
36         "id": "foo",
37         "display_name": "foo",
38         "display_picture": {
39           "display_id": "foo",
40           "id": "foo",
41           "file": {
42             "type": "foo",
43             "name": "foo",
44             "size": 42
45           }
46         },
47         "email": "foo",
48         "full_name": "foo",
49         "state": "active"
50       },
51       "created_date": "2023-01-01T12:00:00.000Z",
52       "custom_fields": {},
53       "custom_schema_fragments": [
54         "foo"
55       ],
56       "display_id": "foo",
57       "identified_date": "2023-01-01T12:00:00.000Z",
58       "impact": {
59         "count": {
60           "id": 42,
61           "label": "foo",
62           "ordinal": 42,
63           "value": null
64         },
65         "customer_ids": [
66           {
67             "id": "foo",
68             "display_id": "foo",
69             "display_name": "foo"
70           }
71         ]
72       },
73       "mitigated_date": "2023-01-01T12:00:00.000Z",
74       "modified_by": {
75         "display_id": "foo",
76         "id": "foo",
77         "display_name": "foo",
78         "display_picture": {
79           "display_id": "foo",
80           "id": "foo",
81           "file": {
82             "type": "foo",
83             "name": "foo",
84             "size": 42
85           }
86         },
87         "email": "foo",
88         "full_name": "foo",
89         "state": "active"
90       },
91       "modified_date": "2023-01-01T12:00:00.000Z",
92       "owned_by": [
93         {
94           "display_id": "foo",
95           "id": "foo",
96           "display_name": "foo",
97           "display_picture": {
98             "display_id": "foo",
99             "id": "foo",
100             "file": {
101               "type": "foo",
102               "name": "foo",
103               "size": 42
104             }
105           },
106           "email": "foo",
107           "full_name": "foo",
108           "state": "active"
109         }
110       ],
111       "pia": [
112         {
113           "id": "foo",
114           "article_type": "article",
115           "display_id": "foo",
116           "resource": {
117             "artifacts": [
118               {
119                 "id": "foo",
120                 "display_id": "foo",
121                 "file": {
122                   "type": "foo",
123                   "name": "foo",
124                   "size": 42
125                 }
126               }
127             ],
128             "url": "foo"
129           },
130           "sync_metadata": {
131             "external_reference": "foo",
132             "origin_system": "foo"
133           },
134           "title": "foo"
135         }
136       ],
137       "playbooks": [
138         {
139           "id": "foo",
140           "article_type": "article",
141           "display_id": "foo",
142           "resource": {
143             "artifacts": [
144               {
145                 "id": "foo",
146                 "display_id": "foo",
147                 "file": {
148                   "type": "foo",
149                   "name": "foo",
150                   "size": 42
151                 }
152               }
153             ],
154             "url": "foo"
155           },
156           "sync_metadata": {
157             "external_reference": "foo",
158             "origin_system": "foo"
159           },
160           "title": "foo"
161         }
162       ],
163       "reported_by": {
164         "id": 42,
165         "label": "foo",
166         "ordinal": 42,
167         "value": null
168       },
169       "severity": {
170         "id": 42,
171         "label": "foo",
172         "ordinal": 42,
173         "value": null
174       },
175       "source": {
176         "id": 42,
177         "label": "foo",
178         "ordinal": 42,
179         "value": null
180       },
181       "stage": {
182         "stage": {
183           "id": "foo",
184           "display_id": "foo",
185           "name": "foo"
186         },
187         "state": {
188           "id": "foo",
189           "display_id": "foo",
190           "is_final": true,
191           "name": "foo"
192         }
193       },
194       "stock_schema_fragment": "don:core:dvrv-us-1:devo/example:custom_type_fragment/custom-type-fragment-id",
195       "subtype": "foo",
196       "sync_metadata": {
197         "external_reference": "foo",
198         "last_sync_in": {
199           "status": "failed",
200           "sync_date": "2023-01-01T12:00:00.000Z",
201           "sync_unit": {
202             "id": "foo",
203             "display_id": "foo",
204             "external_system_type": "adaas",
205             "is_archived": true,
206             "name": "foo",
207             "sync_run": {
208               "mode": "initial",
209               "progress": {
210                 "state": "completed"
211               }
212             },
213             "sync_type": "manual"
214           }
215         },
216         "last_sync_out": {
217           "status": "failed",
218           "sync_date": "2023-01-01T12:00:00.000Z",
219           "sync_unit": {
220             "id": "foo",
221             "display_id": "foo",
222             "external_system_type": "adaas",
223             "is_archived": true,
224             "name": "foo",
225             "sync_run": {
226               "mode": "initial",
227               "progress": {
228                 "state": "completed"
229               }
230             },
231             "sync_type": "manual"
232           }
233         },
234         "origin_system": "foo"
235       },
236       "tags": [
237         {
238           "tag": {
239             "id": "foo",
240             "name": "foo",
241             "display_id": "foo",
242             "style_new": {
243               "color": "foo"
244             }
245           },
246           "value": "foo"
247         }
248       ],
249       "target_close_date": "2023-01-01T12:00:00.000Z"
250     }
251   ],
252   "next_cursor": "foo",
253   "prev_cursor": "foo"
254 }

Lists incidents.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.

acknowledged_dateobjectOptional

Provides ways to specify date ranges on objects.

actual_close_dateobjectOptional

Provides ways to specify date ranges on objects.

applies_to_partslist of stringsOptional

Filters for incidents that apply to any of the provided parts.

created_bylist of stringsOptional

Filters for incidents created by any of the provided users.

created_dateobjectOptional

Provides ways to specify date ranges on objects.

cursorstringOptionalformat: "text"

The cursor to resume iteration from. If not provided, then iteration starts from the beginning.

custom_fieldsobjectOptional

Filters for custom fields.

identified_dateobjectOptional

Provides ways to specify date ranges on objects.

limitintegerOptional

The maximum number of items.

mitigated_dateobjectOptional

Provides ways to specify date ranges on objects.

modeenumOptional

The iteration mode to use. If “after”, then entries after the provided cursor will be returned, or if no cursor is provided, then from the beginning. If “before”, then entries before the provided cursor will be returned, or if no cursor is provided, then from the end. Entries will always be returned in the specified sort-by order.

Allowed values:

modified_dateobjectOptional

Provides ways to specify date ranges on objects.

owned_bylist of stringsOptional

Filters for incidents owned by any of the provided users.

pialist of stringsOptional

Filters for incidents with any of the provided PIAs.

playbookslist of stringsOptional

Filters for incidents with any of the provided playbooks.

related_docslist of stringsOptional

Filters for incidents with any of the provided related docs.

reported_bylist of longsOptional

Filters for incidents with any of the provided reporters.

severitylist of longsOptional

Filters for incidents containing any of the provided severities.

sort_bylist of stringsOptional

The list of fields to sort the items by and how to sort them.

stagelist of stringsOptional

Filters for incidents in any of the provided stages.

staged_infoobjectOptional

subtypelist of stringsOptional

Filters for incidents with any of the provided subtypes.

sync_metadataobjectOptional

target_close_dateobjectOptional

Provides ways to specify date ranges on objects.

titlelist of stringsOptional

Filters for incidents by the provided titles.

sourcelist of longsOptionalDeprecated

Filters for incidents with any of the provided sources.

Response

Success.

incidentslist of objects

The matching incidents.

next_cursorstring or nullformat: "text"

The cursor used to iterate subsequent results in accordance to the sort order. If not set, then no later elements exist.

prev_cursorstring or nullformat: "text"

The cursor used to iterate preceding results in accordance to the sort order. If not set, then no prior elements exist.

Headers

Request

Response

Errors