Get a collection of scenario fired event field descriptions

get/scenarioFiredEventMetadata/fields

Returns a collection of scenario fired event field descriptions.

Request Samples

1

Response Samples

1{
2 "name": "scenarioFiredEventFieldDescriptions",
3 "start": 0,
4 "count": 75,
5 "limit": 75,
6 "links": [
7 {
8 "method": "GET",
9 "rel": "collection",
10 "href": "/svi-alert/scenarioFiredEventMetadata/fields",
11 "type": "application/vnd.sas.collection",
12 "uri": "/svi-alert/scenarioFiredEventMetadata/fields"
13 },
14 {
15 "method": "GET",
16 "rel": "self",
17 "href": "/svi-alert/scenarioFiredEventMetadata/fields",
18 "type": "application/vnd.sas.collection",
19 "uri": "/svi-alert/scenarioFiredEventMetadata/fields"
20 }
21 ],
22 "items": [
23 {
24 "fieldName": "alertId",
25 "labelText": "Alert ID",
26 "headerText": "Alert ID",
27 "dataType": "STRING"
28 },
29 {
30 "fieldName": "alertingEventId",
31 "labelText": "Alerting event ID",
32 "headerText": "Alerting Event ID",
33 "dataType": "STRING"
34 },
35 {
36 "fieldName": "alertTriggerText",
37 "labelText": "Alert trigger text",
38 "headerText": "Alert Trigger Text",
39 "dataType": "STRING"
40 },
41 {
42 "fieldName": "alertTypeCode",
43 "labelText": "Alert type code",
44 "headerText": "Alert Type Code",
45 "dataType": "REFERENCE_DATA"
46 },
47 {
48 "fieldName": "alertTypeLabel",
49 "labelText": "Alert type label",
50 "headerText": "Alert Type Label",
51 "dataType": "STRING"
52 },
53 {
54 "fieldName": "alertVersionNumber",
55 "labelText": "Alert version number",
56 "headerText": "Alert Version Number",
57 "dataType": "SMALLINT"
58 },
59 {
60 "fieldName": "appliedSegmentCode",
61 "labelText": "Applied segment code",
62 "headerText": "Applied Segment Code",
63 "dataType": "STRING"
64 },
65 {
66 "fieldName": "contextEndTimeStamp",
67 "labelText": "Context end date-time",
68 "headerText": "Context End Date-Time",
69 "dataType": "TIMESTAMP"
70 },
71 {
72 "fieldName": "contextRelationshipName",
73 "labelText": "Context relationship name",
74 "headerText": "Context Relationship Name",
75 "dataType": "STRING"
76 },
77 {
78 "fieldName": "contextStartTimeStamp",
79 "labelText": "Context start date-time",
80 "headerText": "Context Start Date-Time",
81 "dataType": "TIMESTAMP"
82 },
83 {
84 "fieldName": "contextTimeStampFieldLabel",
85 "labelText": "Context date-time field label",
86 "headerText": "Context Date-Time Field Label",
87 "dataType": "STRING"
88 },
89 {
90 "fieldName": "contextTimeStampFieldName",
91 "labelText": "Context date-time field name",
92 "headerText": "Context Date-Time Field Name",
93 "dataType": "STRING"
94 },
95 {
96 "fieldName": "contributingObjects",
97 "labelText": "Contributing objects",
98 "headerText": "Contributing Objects",
99 "dataType": "JSON"
100 },
101 {
102 "fieldName": "createdBy",
103 "labelText": "Created by user ID",
104 "headerText": "Created By User ID",
105 "dataType": "STRING"
106 },
107 {
108 "fieldName": "createdByName",
109 "labelText": "Created by name",
110 "headerText": "Created By Name",
111 "dataType": "STRING"
112 },
113 {
114 "fieldName": "creationTimeStamp",
115 "labelText": "Event date-time",
116 "headerText": "Event Date-Time",
117 "dataType": "TIMESTAMP"
118 },
119 {
120 "fieldName": "currentDispositionComment",
121 "labelText": "Comment",
122 "headerText": "Comment",
123 "dataType": "STRING"
124 },
125 {
126 "fieldName": "currentDispositionResolutionCode",
127 "labelText": "Productivity rating code",
128 "headerText": "Productivity Rating Code",
129 "dataType": "REFERENCE_DATA"
130 },
131 {
132 "fieldName": "currentDispositionResolutionLabel",
133 "labelText": "Productivity rating label",
134 "headerText": "Productivity Rating Label",
135 "dataType": "STRING"
136 },
137 {
138 "fieldName": "currentProductiveTimeStamp",
139 "labelText": "Productivity date-time",
140 "headerText": "Productivity Date-Time",
141 "dataType": "TIMESTAMP"
142 },
143 {
144 "fieldName": "currentProductiveUserId",
145 "labelText": "Productivity user ID",
146 "headerText": "Productivity User ID",
147 "dataType": "STRING"
148 },
149 {
150 "fieldName": "currentProductiveUserName",
151 "labelText": "Productivity user name",
152 "headerText": "Productivity User Name",
153 "dataType": "STRING"
154 },
155 {
156 "fieldName": "deploymentId",
157 "labelText": "Deployment ID",
158 "headerText": "Deployment ID",
159 "dataType": "STRING"
160 },
161 {
162 "fieldName": "displayFlag",
163 "labelText": "Display flag",
164 "headerText": "Display Flag",
165 "dataType": "BOOLEAN"
166 },
167 {
168 "fieldName": "displayFormat",
169 "labelText": "Display format",
170 "headerText": "Display Format",
171 "dataType": "STRING"
172 },
173 {
174 "fieldName": "displayOrder",
175 "labelText": "Display order",
176 "headerText": "Display Order",
177 "dataType": "INTEGER"
178 },
179 {
180 "fieldName": "displayTypeCode",
181 "labelText": "Display type code",
182 "headerText": "Display Type Code",
183 "dataType": "STRING"
184 },
185 {
186 "fieldName": "duplicatedFlag",
187 "labelText": "Duplicated flag",
188 "headerText": "Duplicated Flag",
189 "dataType": "BOOLEAN"
190 },
191 {
192 "fieldName": "duplicatedFromId",
193 "labelText": "Duplicated from ID",
194 "headerText": "Duplicated From ID",
195 "dataType": "STRING"
196 },
197 {
198 "fieldName": "entitySegmentCode",
199 "labelText": "Entity segment code",
200 "headerText": "Entity Segment Code",
201 "dataType": "STRING"
202 },
203 {
204 "fieldName": "externalReplicationEntityLabel",
205 "labelText": "External replication entity label",
206 "headerText": "External Replication Entity Label",
207 "dataType": "STRING"
208 },
209 {
210 "fieldName": "externalReplicationEntityName",
211 "labelText": "External replication entity name",
212 "headerText": "External Replication Entity Name",
213 "dataType": "STRING"
214 },
215 {
216 "fieldName": "externalReplicationEntitySFEIdFieldLabel",
217 "labelText": "External replication entity scenario fired event ID field label",
218 "headerText": "External Replication Entity Scenario Fired Event ID Field Label",
219 "dataType": "STRING"
220 },
221 {
222 "fieldName": "externalReplicationEntitySFEIdFieldName",
223 "labelText": "External replication entity scenario fired event ID field name",
224 "headerText": "External Replication Entity Scenario Fired Event ID Field Name",
225 "dataType": "STRING"
226 },
227 {
228 "fieldName": "maximumScore",
229 "labelText": "Maximum score",
230 "headerText": "Maximum Score",
231 "dataType": "INTEGER"
232 },
233 {
234 "fieldName": "meanScore",
235 "labelText": "Mean score",
236 "headerText": "Mean Score",
237 "dataType": "INTEGER"
238 },
239 {
240 "fieldName": "messageTemplateText",
241 "labelText": "Message",
242 "headerText": "Message",
243 "dataType": "STRING"
244 },
245 {
246 "fieldName": "messageValuesJson",
247 "labelText": "Message values JSON",
248 "headerText": "Message Values JSON",
249 "dataType": "JSON"
250 },
251 {
252 "fieldName": "messageValuesJsonAsText",
253 "labelText": "Message text values",
254 "headerText": "Message Text Values",
255 "dataType": "STRING"
256 },
257 {
258 "fieldName": "minimumScore",
259 "labelText": "Minimum score",
260 "headerText": "Minimum Score",
261 "dataType": "INTEGER"
262 },
263 {
264 "fieldName": "modelName",
265 "labelText": "Model name",
266 "headerText": "Model Name",
267 "dataType": "STRING"
268 },
269 {
270 "fieldName": "modifiedBy",
271 "labelText": "Modified by user ID",
272 "headerText": "Modified By User ID",
273 "dataType": "STRING"
274 },
275 {
276 "fieldName": "modifiedByName",
277 "labelText": "Modified by name",
278 "headerText": "Modified By Name",
279 "dataType": "STRING"
280 },
281 {
282 "fieldName": "modifiedTimeStamp",
283 "labelText": "Modified date-time",
284 "headerText": "Modified Date-Time",
285 "dataType": "TIMESTAMP"
286 },
287 {
288 "fieldName": "originDataText",
289 "labelText": "Origin data text",
290 "headerText": "Origin Data Text",
291 "dataType": "STRING"
292 },
293 {
294 "fieldName": "reasonCode",
295 "labelText": "Disposition reason code",
296 "headerText": "Disposition Reason Code",
297 "dataType": "REFERENCE_DATA"
298 },
299 {
300 "fieldName": "reasonLabel",
301 "labelText": "Disposition reason label",
302 "headerText": "Disposition Reason Label",
303 "dataType": "STRING"
304 },
305 {
306 "fieldName": "receivedScenarioFiredEntityId",
307 "labelText": "Received scenario fired object ID",
308 "headerText": "Received Scenario Fired Object ID",
309 "dataType": "STRING"
310 },
311 {
312 "fieldName": "receivedScenarioFiredEntityLabel",
313 "labelText": "Received scenario fired entity label",
314 "headerText": "Received Scenario Fired Entity Label",
315 "dataType": "STRING"
316 },
317 {
318 "fieldName": "receivedScenarioFiredEntityType",
319 "labelText": "Received scenario fired entity name",
320 "headerText": "Received Scenario Fired Entity Name",
321 "dataType": "STRING"
322 },
323 {
324 "fieldName": "recommendedQueueId",
325 "labelText": "Recommended queue ID",
326 "headerText": "Recommended Queue ID",
327 "dataType": "STRING"
328 },
329 {
330 "fieldName": "recommendedQueueName",
331 "labelText": "Recommended queue name",
332 "headerText": "Recommended Queue Name",
333 "dataType": "STRING"
334 },
335 {
336 "fieldName": "replicateFlag",
337 "labelText": "Replicate flag",
338 "headerText": "Replicate Flag",
339 "dataType": "BOOLEAN"
340 },
341 {
342 "fieldName": "replicationPolicy",
343 "labelText": "Replication policy",
344 "headerText": "Replication Policy",
345 "dataType": "STRING"
346 },
347 {
348 "fieldName": "ruleId",
349 "labelText": "Rule ID",
350 "headerText": "Rule ID",
351 "dataType": "STRING"
352 },
353 {
354 "fieldName": "runStartTimeStamp",
355 "labelText": "Run date-time",
356 "headerText": "Run Date-Time",
357 "dataType": "TIMESTAMP"
358 },
359 {
360 "fieldName": "scenarioDescription",
361 "labelText": "Scenario description",
362 "headerText": "Scenario Description",
363 "dataType": "STRING"
364 },
365 {
366 "fieldName": "scenarioFiredEntityId",
367 "labelText": "Scenario fired object ID",
368 "headerText": "Scenario Fired Object ID",
369 "dataType": "STRING"
370 },
371 {
372 "fieldName": "scenarioFiredEntityLabel",
373 "labelText": "Scenario fired entity label",
374 "headerText": "Scenario Fired Entity Label",
375 "dataType": "STRING"
376 },
377 {
378 "fieldName": "scenarioFiredEntityType",
379 "labelText": "Scenario fired entity name",
380 "headerText": "Scenario Fired Entity Name",
381 "dataType": "STRING"
382 },
383 {
384 "fieldName": "scenarioFiredEventId",
385 "labelText": "Scenario fired event ID",
386 "headerText": "Scenario Fired Event ID",
387 "dataType": "STRING"
388 },
389 {
390 "fieldName": "scenarioId",
391 "labelText": "Scenario ID",
392 "headerText": "Scenario ID",
393 "dataType": "STRING"
394 },
395 {
396 "fieldName": "scenarioName",
397 "labelText": "Scenario name",
398 "headerText": "Scenario Name",
399 "dataType": "STRING"
400 },
401 {
402 "fieldName": "scenarioOriginCode",
403 "labelText": "Scenario origin code",
404 "headerText": "Scenario Origin Code",
405 "dataType": "STRING"
406 },
407 {
408 "fieldName": "score",
409 "labelText": "Score",
410 "headerText": "Score",
411 "dataType": "INTEGER"
412 },
413 {
414 "fieldName": "segmentGroupId",
415 "labelText": "Segment group ID",
416 "headerText": "Segment Group ID",
417 "dataType": "STRING"
418 },
419 {
420 "fieldName": "suppressedFlag",
421 "labelText": "Suppressed",
422 "headerText": "Suppressed",
423 "dataType": "BOOLEAN"
424 },
425 {
426 "fieldName": "value",
427 "labelText": "Value",
428 "headerText": "Value",
429 "dataType": "STRING | BOOLEAN | DOUBLE | TIMESTAMP"
430 },
431 {
432 "fieldName": "valueBoolean",
433 "labelText": "Value boolean",
434 "headerText": "Value Boolean",
435 "dataType": "BOOLEAN"
436 },
437 {
438 "fieldName": "valueNumeric",
439 "labelText": "Value numeric",
440 "headerText": "Value Numeric",
441 "dataType": "DOUBLE"
442 },
443 {
444 "fieldName": "valueText",
445 "labelText": "Value text",
446 "headerText": "Value Text",
447 "dataType": "STRING"
448 },
449 {
450 "fieldName": "valueTimeStamp",
451 "labelText": "Value date-time",
452 "headerText": "Value Date-Time",
453 "dataType": "TIMESTAMP"
454 },
455 {
456 "fieldName": "valueType",
457 "labelText": "Value type",
458 "headerText": "Value Type",
459 "dataType": "STRING"
460 },
461 {
462 "fieldName": "version",
463 "labelText": "Version",
464 "headerText": "Version",
465 "dataType": "INTEGER"
466 },
467 {
468 "fieldName": "weight",
469 "labelText": "Weight",
470 "headerText": "Weight",
471 "dataType": "INTEGER"
472 }
473 ]
474}

Responses

StatusMeaningDescription
200OK

The request succeeded.

HeadersSchema