Update an enrichment field

put/enrichmentFields/{enrichmentFieldId}

Updates an enrichment field.

Request Samples

1

Response Samples

1{
2  "items": [
3    {
4      "createdBy": "videmo",
5      "creationTimeStamp": "2024-04-18T14:18:10.256Z",
6      "enrichmentFieldDataTypeCode": "Text",
7      "enrichmentFieldId": "enrichmentIdExample1",
8      "enrichmentFieldName": "enrichmentNameExample1",
9      "links": [
10        {
11          "method": "GET",
12          "rel": "self",
13          "href": "/svi-alert/enrichmentFields/enrichmentIdExample1",
14          "uri": "/svi-alert/enrichmentFields/enrichmentIdExample1",
15          "type": "application/vnd.sas.investigation.triage.enrichment.field"
16        },
17        {
18          "method": "PUT",
19          "rel": "update",
20          "href": "/svi-alert/enrichmentFields/enrichmentIdExample1",
21          "uri": "/svi-alert/enrichmentFields/enrichmentIdExample1",
22          "type": "application/vnd.sas.investigation.triage.enrichment.field",
23          "responseType": "application/vnd.sas.investigation.triage.enrichment.field"
24        }
25      ],
26      "modifiedBy": "videmo",
27      "modifiedTimeStamp": "2024-04-18T14:18:10.256Z",
28      "solutionId": "sas_visual_investigator_default",
29      "version": 1
30    }
31  ]
32}

Path Parameters

NameTypeRequiredDescription
enrichmentFieldId
string
true

Specifies the identifier for the given enrichment field.

<= 36 characters

Request Body

An enrichment field representation.

NameTypeRequiredDescription
enrichmentFieldId
string
false
<= 36 characters
enrichmentFieldName
string
false
<= 100 characters
enrichmentFieldHeader
string
false
<= 1000 characters
enrichmentFieldLabel
string
false
<= 1000 characters
enrichmentFieldDescription
string
false
<= 510 characters
enrichmentFieldIdDataTypeCode
string
false
<= 20 characters
solutionId
string
false
<= 250 characters
creationTimeStamp
string
false
modifiedTimeStamp
string
false
createdBy
string
false
modifiedBy
string
false
links
array [Link]
false

A link representation.

Responses

StatusMeaningDescription
200OK

The request succeeded.

HeadersSchema
400Bad Request

The request was invalid.

Schema
404Not Found

No enrichment field exists at the requested path.

Schema
412Precondition Failed

The If-Match request header did not match the enrichment field's entity tag, or the If-Unmodified-Since request header did not match the enrichment field's last modified timestamp.

Schema
428Precondition Required

The request headers did not include a If-Match or If-Unmodified-Since precondition.

Schema
500Internal Server Error

The request could not be fulfilled because of an unexpected server error.

Schema