Return a collection of alerts

get/strategies/{strategyId}/alerts

Returns a collection of alerts with a given strategy identifier.

Request Samples

Response Samples


1{
2  "name": "alerts",
3  "start": 0,
4  "count": 1,
5  "links": [
6    {
7      "method": "GET",
8      "rel": "collection",
9      "href": "/svi-alert/alerts",
10      "uri": "/svi-alert/alerts",
11      "type": "application/vnd.sas.collection"
12    },
13    {
14      "method": "GET",
15      "rel": "self",
16      "href": "/svi-alert/alerts?sortBy=creationTimeStamp:descending,alertSk:ascending&start=0&limit=10",
17      "uri": "/svi-alert/alerts?sortBy=creationTimeStamp:descending,alertSk:ascending&start=0&limit=10",
18      "type": "application/vnd.sas.collection"
19    },
20    {
21      "method": "GET",
22      "rel": "next",
23      "href": "/svi-alert/alerts?sortBy=creationTimeStamp:descending,alertSk:ascending&start=10&limit=10",
24      "uri": "/svi-alert/alerts?sortBy=creationTimeStamp:descending,alertSk:ascending&start=10&limit=10",
25      "type": "application/vnd.sas.collection"
26    },
27    {
28      "method": "GET",
29      "rel": "last",
30      "href": "/svi-alert/alerts?sortBy=creationTimeStamp:descending,alertSk:ascending&start=10&limit=10",
31      "uri": "/svi-alert/alerts?sortBy=creationTimeStamp:descending,alertSk:ascending&start=10&limit=10",
32      "type": "application/vnd.sas.collection"
33    }
34  ],
35  "items": [
36    {
37      "creationTimeStamp": "2024-04-12T10:02:48.662Z",
38      "modifiedTimeStamp": "2024-04-12T10:02:48.721Z",
39      "createdBy": "sas.svi-alert",
40      "modifiedBy": "sas.svi-alert",
41      "links": [
42        {
43          "method": "GET",
44          "rel": "self",
45          "href": "/svi-alert/alerts/393b5860-84ca-44d0-b5c9-1e62b57feb9e",
46          "uri": "/svi-alert/alerts/393b5860-84ca-44d0-b5c9-1e62b57feb9e",
47          "type": "application/vnd.sas.investigation.triage.alert"
48        },
49        {
50          "method": "GET",
51          "rel": "queue",
52          "href": "/svi-alert/queues/insurance_investigations",
53          "uri": "/svi-alert/queues/insurance_investigations",
54          "type": "application/vnd.sas.investigation.triage.queue"
55        }
56      ],
57      "version": 1,
58      "domainId": "insurance_domain",
59      "alertId": "393b5860-84ca-44d0-b5c9-1e62b57feb9e",
60      "alertVersion": 1,
61      "alertVersionTimeStamp": "2024-04-12T10:02:48.662Z",
62      "actionableEntityType": "tdc_policy",
63      "actionableEntityId": "CMLACALILINKED01069638",
64      "actionableEntityLabel": "CMLACALILINKED01069638",
65      "initialScore": 100,
66      "currentScore": 100,
67      "highScore": 100,
68      "alertOriginCode": "SA",
69      "alertTypeCode": "DEFAULT",
70      "statusTimeStamp": "2024-04-12T10:02:48.662Z",
71      "enrichmentJson": {},
72      "suppressFlag": false,
73      "holdFlag": false,
74      "routeFlag": false,
75      "queueEntryTimeStamp": "2024-04-12T10:02:48.679Z",
76      "alertServiceCount": 0,
77      "systemServiceTimeStamp": "2024-04-12T10:02:48.714Z",
78      "alertStatusId": "ACTIVE",
79      "initialAlertingEventId": "2230681b-165b-44b7-b120-8bef2e8d1d1a",
80      "currentAlertingEventId": "2230681b-165b-44b7-b120-8bef2e8d1d"
81    }
82  ]
83}

Path Parameters

Name	Type	Required	Description
strategyId	string	true	Specifies the identifier of the strategy from which to retrieve the alerts. <= 36 characters

Query Parameters

Name	Type	Required	Description
filter	string	false	The criteria for filtering the items. See Filtering in REST APIs. <= 1000 characters
limit	integer<int32>	false	Specifies the maximum number of items to return. The default value is 10. >= 1 Default: 10
sortBy	string	false	The criteria for sorting the items. See Sorting in REST APIs. <= 1000 characters Default: creationTimeStamp:descending
start	integer<int32>	false	Specifies the index of the first item to return. The default value is 0. >= 0 Default: 0
userId	string	false	Specifies the identifier for the given user. <= 36 characters

Responses

Status	Meaning	Description
200	OK	The request succeeded.	Headers	Schema
400	Bad Request	The request was invalid.		Schema
404	Not Found	No strategy exists at the requested path.		Schema
500	Internal Server Error	The request could not be fulfilled because of an unexpected server error.		Schema