Get Controlled Vocabularies

Retrieve all the controlled vocabularies available to the current user.

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: 592ms

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.

Responses
200

The Response Body will be a JSON-formatted list including the following properties.

  • metadata: Vocabulary metadata
    • values: Key/Value list
      • valueId
      • valueName
    • searchable: Toggle searchability
  • metadataDefinitionId
  • metadataDefinitionName
  • metadataDefinitionSearchField: Map search field for this metadata definition
  • metadataDefinitionType: Metadata definition type
  • createdEpoch: Create time in milliseconds
  • lastUpdatedEpoch: Update time in milliseconds
401

Unauthorized. Missing Authorization or AccessToken or Access Token expired

403

Forbidden. Missing X-API-key

get/metadata/vocabulary
Request samples 
Response samples 
application/json
[
  • {
    }
]