Create a Controlled Vocabulary.

Create a Controlled Vocabulary. User must have permission to create a controlled vocabulary.

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

SecurityApiKeyAuth or BasicAuth
Request
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
name
string

Vocabulary Name

values
Array of strings

List of vocabulary values

Responses
200

The Response Body is a JSON object.

400

returns JSON object with error description.

401

Unauthorized. Missing Authorization or AccessToken or Access Token expired

403

Forbidden. Missing X-API-key

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