Update Controlled Vocabulary

Update a Controlled Vocabulary. User must have permission to update a controlled vocabulary.

In response, it will contain the object of metadata definition attributes like id, name, type and search fields etc.

Average Response Time: 482ms

SecurityApiKeyAuth or BasicAuth
Request
path Parameters
id
required
string

Specify a Controlled Vocabulary ID.

header Parameters
X-API-Key
required
string

Customer-specific API key required to invoke API.

Authorization
required
string

Provided by Authentication Token creation operation

AccessToken
required
string

JWT token provided by Authentication Token creation operation.

Content-Type
required
string
Value: "application/json"
Request Body schema: application/json
required

The Request Body will be a JSON-formatted object including the following properties. Each property here is an operation. All of these operations can be applied in a single request. After updating the Controlled Vocabulary, execute /metadata/apply POST request to apply the new changes.

name
string

New name of the Controlled Vocabulary

add
Array of strings

JSON Array with new values to add into the Controlled Vocabulary

Array of objects (ControlledVocabularyUpdateRequest_update)

Payload to update existing values by their IDs

object (ControlledVocabulary)
Responses
200

The Response Body will be a JSON-formatted object having operation as key and each operation including the following properties.

401

Unauthorized. Missing Authorization or AccessToken or Access Token expired

403

Forbidden. Missing X-API-key

404

Wrong ID

patch/metadata/vocabulary/{id}
Request samples
application/json
{
  • "name": "Color List"
}
Response samples
application/json
{
  • "createdEpoch": 1613877219787,
  • "customerId": "157167185123342",
  • "lastUpdatedEpoch": 1613877219787,
  • "metadataDefinitionId": "6c921f5c-24c2-40b9-8718-3ad2d4a6be54",
  • "metadataDefinitionName": "Colors",
  • "metadataDefinitionSearchField": "colors",
  • "metadataDefinitionType": "controlledVocabulary",
  • "metadataDocument": {
    }
}