Get a collection of alert field descriptions

get/alertMetadata/fields

Returns a collection of alert field descriptions.

Request Samples

1

Response Samples

1{
2 "name": "fieldDescriptions",
3 "start": 0,
4 "count": 6,
5 "limit": 6,
6 "links": [
7 {
8 "method": "GET",
9 "rel": "collection",
10 "href": "/svi-alert/alerts/fields",
11 "type": "application/vnd.sas.collection",
12 "uri": "/svi-alert/alerts/fields"
13 },
14 {
15 "method": "GET",
16 "rel": "self",
17 "href": "/svi-alert/alerts/fields",
18 "type": "application/vnd.sas.collection",
19 "uri": "/svi-alert/alerts/fields"
20 }
21 ],
22 "items": [
23 {
24 "isEnrichment": false,
25 "fieldName": "currentAlertingEventId",
26 "headerText": "Alerting-Event ID",
27 "labelText": "Alerting-event ID",
28 "type": "Text",
29 "dataType": "STRING",
30 "version": 1
31 },
32 {
33 "isEnrichment": false,
34 "fieldName": "queueId",
35 "headerText": "Queue ID",
36 "labelText": "Queue ID",
37 "type": "Text",
38 "dataType": "STRING",
39 "version": 1
40 },
41 {
42 "isEnrichment": false,
43 "fieldName": "dispositionDataJson",
44 "headerText": "Disposition Data",
45 "labelText": "Disposition data",
46 "type": "JSON",
47 "dataType": "JSON",
48 "version": 1
49 },
50 {
51 "isEnrichment": false,
52 "fieldName": "alertTriggerText",
53 "headerText": "Alert-Trigger Text",
54 "labelText": "Alert-trigger text",
55 "type": "Text",
56 "dataType": "STRING",
57 "version": 1
58 },
59 {
60 "isEnrichment": false,
61 "fieldName": "highScore",
62 "headerText": "High Score",
63 "labelText": "High score",
64 "type": "Integer",
65 "dataType": "INTEGER",
66 "version": 1
67 },
68 {
69 "isEnrichment": false,
70 "fieldName": "alertServiceCount",
71 "headerText": "Alert Service Count",
72 "labelText": "Alert service count",
73 "type": "Small Integer",
74 "dataType": "SMALLINT",
75 "version": 1
76 }
77 ],
78 "version": 2,
79 "accept": "application/vnd.sas.investigation.triage.field.description+json",
80 "description": "OK."
81}

Responses

StatusMeaningDescription
200OK

The request succeeded.

HeadersSchema