Get Controlled Vocabulary

Retrieve the Controlled Vocabulary and its attributes by Controlled Vocabulary Id

In response, it will contain the list of metadata key/value pair and metadata definition attributes like id, name, type and search fields etc.

Average Response Time: 472ms

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.

Responses
200

The Response Body will be a JSON object

401

Unauthorized. Missing Authorization or AccessToken or Access Token expired

403

Forbidden. Missing X-API-key

404

Wrong ID

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