Get a collection of alerting event field descriptions

get/alertingEventMetadata/fields

Returns a collection of alerting event field descriptions.

Request Samples

1

Response Samples

1{
2 "links": [
3 {
4 "method": "GET",
5 "rel": "collection",
6 "href": "/svi-alert/alertingEventMetadata/fields",
7 "uri": "/svi-alert/alertingEventMetadata/fields",
8 "type": "application/vnd.sas.collection",
9 "itemType": "application/vnd.sas.investigation.triage.alerting.event.field.description"
10 },
11 {
12 "method": "GET",
13 "rel": "self",
14 "href": "/svi-alert/alertingEventMetadata/fields",
15 "uri": "/svi-alert/alertingEventMetadata/fields",
16 "type": "application/vnd.sas.collection",
17 "itemType": "application/vnd.sas.investigation.triage.alerting.event.field.description"
18 }
19 ],
20 "accept": "application/vnd.sas.investigation.triage.alerting.event.field.description+json;version=1",
21 "name": "alertingEventFieldDescriptions",
22 "start": 0,
23 "count": 27,
24 "items": [
25 {
26 "fieldName": "actionableEntityId",
27 "labelText": "Actionable entity ID",
28 "headerText": "Actionable Entity ID",
29 "dataType": "STRING",
30 "isEnrichment": false
31 },
32 {
33 "fieldName": "actionableEntityLabel",
34 "labelText": "Actionable entity label",
35 "headerText": "Actionable Entity Label",
36 "dataType": "STRING",
37 "isEnrichment": false
38 },
39 {
40 "fieldName": "actionableEntityType",
41 "labelText": "Actionable entity type",
42 "headerText": "Actionable Entity Type",
43 "dataType": "STRING",
44 "isEnrichment": false
45 },
46 {
47 "fieldName": "alertId",
48 "labelText": "Alert ID",
49 "headerText": "Alert ID",
50 "dataType": "STRING",
51 "isEnrichment": false
52 },
53 {
54 "fieldName": "alertingEventId",
55 "labelText": "Alerting event ID",
56 "headerText": "Alerting Event ID",
57 "dataType": "STRING",
58 "isEnrichment": false
59 },
60 {
61 "fieldName": "alertOriginCode",
62 "labelText": "Alert origin",
63 "headerText": "Alert Origin",
64 "dataType": "STRING",
65 "isEnrichment": false
66 },
67 {
68 "fieldName": "alertTriggerText",
69 "labelText": "Trigger text",
70 "headerText": "Trigger Text",
71 "dataType": "STRING",
72 "isEnrichment": false
73 },
74 {
75 "fieldName": "alertTypeCode",
76 "labelText": "Alert type",
77 "headerText": "Alert Type",
78 "dataType": "STRING",
79 "isEnrichment": false
80 },
81 {
82 "fieldName": "alertVersionNumber",
83 "labelText": "Alert version",
84 "headerText": "Alert Version",
85 "dataType": "SMALLINT",
86 "isEnrichment": false
87 },
88 {
89 "fieldName": "createdBy",
90 "labelText": "Created user",
91 "headerText": "Created User",
92 "dataType": "STRING",
93 "isEnrichment": false
94 },
95 {
96 "fieldName": "creationTimeStamp",
97 "labelText": "Created date/time",
98 "headerText": "Created Date/Time",
99 "dataType": "TIMESTAMP",
100 "isEnrichment": false
101 },
102 {
103 "fieldName": "domainId",
104 "labelText": "Alert domain ID",
105 "headerText": "Alert domain ID",
106 "dataType": "STRING",
107 "isEnrichment": false
108 },
109 {
110 "fieldName": "enrichment",
111 "labelText": "Enrichment",
112 "headerText": "Enrichment",
113 "dataType": "JSON",
114 "isEnrichment": false
115 },
116 {
117 "fieldName": "enrichment.test",
118 "labelText": "Test",
119 "dataType": "STRING",
120 "headerText": "Test",
121 "isEnrichment": true
122 },
123 {
124 "fieldName": "jobId",
125 "labelText": "Job ID",
126 "headerText": "Job ID",
127 "dataType": "STRING",
128 "isEnrichment": false
129 },
130 {
131 "fieldName": "modelName",
132 "labelText": "Model",
133 "headerText": "Model",
134 "dataType": "STRING",
135 "isEnrichment": false
136 },
137 {
138 "fieldName": "modifiedBy",
139 "labelText": "Last update user",
140 "headerText": "Last Update User",
141 "dataType": "STRING",
142 "isEnrichment": false
143 },
144 {
145 "fieldName": "modifiedTimeStamp",
146 "labelText": "Last update date/time",
147 "headerText": "Last Update Date/Time",
148 "dataType": "TIMESTAMP",
149 "isEnrichment": false
150 },
151 {
152 "fieldName": "receivedDomainId",
153 "labelText": "Provided domain",
154 "headerText": "Provided Domain",
155 "dataType": "STRING",
156 "isEnrichment": false
157 },
158 {
159 "fieldName": "receivedRecommendedQueueId",
160 "labelText": "Provided recommended queue",
161 "headerText": "Provided Recommended Queue",
162 "dataType": "STRING",
163 "isEnrichment": false
164 },
165 {
166 "fieldName": "receivedScore",
167 "labelText": "Provided score",
168 "headerText": "Provided Score",
169 "dataType": "INTEGER",
170 "isEnrichment": false
171 },
172 {
173 "fieldName": "recommendedQueueId",
174 "labelText": "Recommended queue",
175 "headerText": "Recommended Queue",
176 "dataType": "STRING",
177 "isEnrichment": false
178 },
179 {
180 "fieldName": "rollingCalculationTimeStamp",
181 "labelText": "Timestamp of score calculation",
182 "headerText": "Timestamp of Score Calculation",
183 "dataType": "TIMESTAMP",
184 "isEnrichment": false
185 },
186 {
187 "fieldName": "score",
188 "labelText": "Score",
189 "headerText": "Score",
190 "dataType": "INTEGER",
191 "isEnrichment": false
192 },
193 {
194 "fieldName": "scoreAggregationPolicy",
195 "labelText": "Policy for score calculation",
196 "headerText": "Policy For Score Calculation",
197 "dataType": "STRING",
198 "isEnrichment": false
199 },
200 {
201 "fieldName": "scoreDescription",
202 "labelText": "Description for score",
203 "headerText": "Description For Score",
204 "dataType": "STRING",
205 "isEnrichment": false
206 },
207 {
208 "fieldName": "version",
209 "labelText": "Version",
210 "headerText": "Version",
211 "dataType": "INTEGER",
212 "isEnrichment": false
213 }
214 ],
215 "limit": 27,
216 "version": 2
217}

Responses

StatusMeaningDescription
200OK

The request succeeded.

HeadersSchema