Get a collection of alerting events

get/alertingEvents

Returns a collection of alerting events based on the specified pagination, filtering, and sorting options.

Request Samples

Response Samples


1{
2  "name": "alertingEvents",
3  "start": 0,
4  "count": 37,
5  "limit": 2,
6  "links": [
7    {
8      "method": "GET",
9      "rel": "collection",
10      "href": "/svi-alert/alertingEvents",
11      "type": "application/vnd.sas.collection",
12      "uri": "/svi-alert/alertingEvents"
13    },
14    {
15      "method": "GET",
16      "rel": "self",
17      "href": "/svi-alert/alertingEvents?sortBy=creationTimeStamp:descending&start=0&limit=2",
18      "type": "application/vnd.sas.collection",
19      "uri": "/svi-alert/alertingEvents?sortBy=creationTimeStamp:descending&start=0&limit=2"
20    },
21    {
22      "method": "GET",
23      "rel": "next",
24      "href": "/svi-alert/alertingEvents?sortBy=creationTimeStamp:descending&start=2&limit=2",
25      "type": "application/vnd.sas.collection",
26      "uri": "/svi-alert/alertingEvents?sortBy=creationTimeStamp:descending&start=2&limit=2"
27    },
28    {
29      "method": "GET",
30      "rel": "last",
31      "href": "/svi-alert/alertingEvents?sortBy=creationTimeStamp:descending&start=36&limit=2",
32      "type": "application/vnd.sas.collection",
33      "uri": "/svi-alert/alertingEvents?sortBy=creationTimeStamp:descending&start=36&limit=2"
34    },
35    {
36      "responseType": "application/vnd.sas.collection",
37      "method": "POST",
38      "rel": "createAlertingEvents",
39      "href": "/svi-alert/alertingEvents",
40      "type": "application/vnd.sas.investigation.triage.alerting.data.nested",
41      "uri": "/svi-alert/alertingEvents"
42    }
43  ],
44  "items": [
45    {
46      "alertingEventId": "c221e167-27b5-4063-9fd4-dcd9e12335a8",
47      "actionableEntityId": "3",
48      "actionableEntityType": "tdc_customer",
49      "alertVersionNumber": 1,
50      "alertTypeCode": "MANUAL",
51      "alertTriggerText": "Car burned within one week of policy origination.",
52      "actionableEntityLabel": "Mark Thomas",
53      "version": 1,
54      "domainId": "insurance_domain",
55      "score": 1000,
56      "alertOriginCode": "MANUAL",
57      "enrichment": {},
58      "createdBy": "videmo",
59      "recommendedQueueId": "insurance_investigations",
60      "modifiedTimeStamp": "2019-02-12T22:04:05.162Z",
61      "modifiedBy": "sas.svi-alert",
62      "links": [
63        {
64          "method": "GET",
65          "rel": "self",
66          "href": "/svi-alert/alertingEvents/c221e167-27b5-4063-9fd4-dcd9e12335a8",
67          "type": "application/vnd.sas.investigation.triage.alerting.event.nested",
68          "uri": "/svi-alert/alertingEvents/c221e167-27b5-4063-9fd4-dcd9e12335a8"
69        }
70      ],
71      "creationTimeStamp": "2019-02-12T22:04:04.393Z",
72      "alertId": "36460871995",
73      "scoreAggregationPolicy": "ROLLING",
74      "receivedRecommendedQueueId": "insurance_investigations",
75      "rollingCalculationTimeStamp": "2019-02-12T22:04:04.827Z"
76    },
77    {
78      "alertingEventId": "d3533f2c-b148-4bcf-a1f1-93621b3aa1b3",
79      "actionableEntityId": "3",
80      "actionableEntityType": "tdc_customer",
81      "alertVersionNumber": 1,
82      "alertTypeCode": "MANUAL",
83      "alertTriggerText": "Car burned within one week of policy origination.",
84      "actionableEntityLabel": "Mark Thomas",
85      "version": 1,
86      "domainId": "insurance_domain",
87      "score": 1000,
88      "alertOriginCode": "MANUAL",
89      "enrichment": {},
90      "createdBy": "videmo",
91      "recommendedQueueId": "insurance_investigations",
92      "modifiedTimeStamp": "2019-02-12T21:53:29.163Z",
93      "modifiedBy": "sas.svi-alert",
94      "links": [
95        {
96          "method": "GET",
97          "rel": "self",
98          "href": "/svi-alert/alertingEvents/d3533f2c-b148-4bcf-a1f1-93621b3aa1b3",
99          "type": "application/vnd.sas.investigation.triage.alerting.event.nested",
100          "uri": "/svi-alert/alertingEvents/d3533f2c-b148-4bcf-a1f1-93621b3aa1b3"
101        }
102      ],
103      "creationTimeStamp": "2019-02-12T21:53:28.665Z",
104      "alertId": "36460871995",
105      "scoreAggregationPolicy": "ROLLING",
106      "receivedRecommendedQueueId": "insurance_investigations",
107      "rollingCalculationTimeStamp": "2019-02-12T21:53:28.925Z"
108    }
109  ],
110  "version": 2,
111  "accept": "application/vnd.sas.investigation.triage.alerting.event.nested+json",
112  "description": "OK."
113}

Query Parameters

Name	Type	Required	Description
deep	boolean	false	Specifies whether to return additional data. Default: false
filter	string	false	The criteria for filtering the items. See Filtering in REST APIs. <= 1000 characters
includeScenarioFiredEventLabels	boolean	false	Specifies whether to include scenario fired event labels in the response. This parameter is only applicable when the 'deep' parameter is set to true. This has a small performance overhead. Default: false
limit	integer	false	Specifies the maximum number of items to return. The default value is 10. >= 0 Default: 10
sortBy	string	false	The criteria for sorting the items. See Sorting in REST APIs. <= 1000 characters Default: creationTimeStamp:descending
start	integer	false	Specifies the index of the first item to return. The default value is 0. >= 0 Default: 0

Responses

Status	Meaning	Description
200	OK	The request succeeded.	Headers	Schema
400	Bad Request	The request was invalid.		Schema