Get enrichment fields

get/enrichmentFields

Returns enrichment fields using a standard filter.

Request Samples

Response Samples


1{
2  "name": "enrichmentFields",
3  "start": 0,
4  "count": 2,
5  "links": [
6    {
7      "method": "GET",
8      "rel": "collection",
9      "href": "/svi-alert/enrichmentFields",
10      "uri": "/svi-alert/enrichmentFields",
11      "type": "application/vnd.sas.collection"
12    },
13    {
14      "method": "GET",
15      "rel": "self",
16      "href": "/svi-alert/enrichmentFields?sortBy=creationTimeStamp:descending&start=0&limit=10",
17      "uri": "/svi-alert/enrichmentFields?sortBy=creationTimeStamp:descending&start=0&limit=10",
18      "type": "application/vnd.sas.collection"
19    },
20    {
21      "method": "POST",
22      "rel": "createEnrichmentField",
23      "href": "/svi-alert/enrichmentFields",
24      "uri": "/svi-alert/enrichmentFields",
25      "type": "application/vnd.sas.investigation.triage.enrichment.field",
26      "responseType": "application/vnd.sas.investigation.triage.enrichment.field"
27    }
28  ],
29  "items": [
30    {
31      "createdBy": "videmo",
32      "creationTimeStamp": "2024-04-18T14:18:10.256Z",
33      "enrichmentFieldDataTypeCode": "Text",
34      "enrichmentFieldId": "enrichmentIdExample1",
35      "enrichmentFieldName": "enrichmentNameExample1",
36      "links": [
37        {
38          "method": "GET",
39          "rel": "self",
40          "href": "/svi-alert/enrichmentFields/enrichmentIdExample1",
41          "uri": "/svi-alert/enrichmentFields/enrichmentIdExample1",
42          "type": "application/vnd.sas.investigation.triage.enrichment.field"
43        },
44        {
45          "method": "PUT",
46          "rel": "update",
47          "href": "/svi-alert/enrichmentFields/enrichmentIdExample1",
48          "uri": "/svi-alert/enrichmentFields/enrichmentIdExample1",
49          "type": "application/vnd.sas.investigation.triage.enrichment.field",
50          "responseType": "application/vnd.sas.investigation.triage.enrichment.field"
51        }
52      ],
53      "modifiedBy": "videmo",
54      "modifiedTimeStamp": "2024-04-18T14:18:10.256Z",
55      "solutionId": "sas_visual_investigator_default",
56      "version": 1
57    },
58    {
59      "createdBy": "videmo",
60      "creationTimeStamp": "2024-04-18T14:17:43.389Z",
61      "enrichmentFieldDataTypeCode": "Text",
62      "enrichmentFieldDescription": "${enrichment_description}",
63      "enrichmentFieldHeader": "${enrichment_header}",
64      "enrichmentFieldId": "enrichmentIdExample",
65      "enrichmentFieldLabel": "${enrichment_label}",
66      "enrichmentFieldName": "enrichmentNameExample",
67      "links": [
68        {
69          "method": "GET",
70          "rel": "self",
71          "href": "/svi-alert/enrichmentFields/enrichmentIdExample",
72          "uri": "/svi-alert/enrichmentFields/enrichmentIdExample",
73          "type": "application/vnd.sas.investigation.triage.enrichment.field"
74        },
75        {
76          "method": "PUT",
77          "rel": "update",
78          "href": "/svi-alert/enrichmentFields/enrichmentIdExample",
79          "uri": "/svi-alert/enrichmentFields/enrichmentIdExample",
80          "type": "application/vnd.sas.investigation.triage.enrichment.field",
81          "responseType": "application/vnd.sas.investigation.triage.enrichment.field"
82        }
83      ],
84      "modifiedBy": "videmo",
85      "modifiedTimeStamp": "2024-04-18T14:17:43.389Z",
86      "solutionId": "sas_visual_investigator_default",
87      "version": 1
88    }
89  ],
90  "limit": 10,
91  "version": 2
92}

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. 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. Default: 0

Header Parameters

Name	Type	Required	Description
Accept-Item	string	false	Specifies the media type of the items returned. Allowed value: application/vnd.sas.investigation.triage.enrichment.field+json

Responses

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