Vocabularies

Submit Custom Vocabulary

Submits a Custom Vocabulary for asynchronous processing.

SecurityAccessToken
Request
Request Body schema: application/json

Custom Vocabulary Definition

metadata
string or null <= 512 characters

Optional metadata that was provided during submission

callback_url
string or null <= 1024 characters
Deprecated

Deprecated. Use notification_config instead. Optional callback url to invoke when processing is complete. If this parameter is used to pass in the callback url, the callback url will be visible in the response. It is recommended to provide webhooks with the notification_config parameter as authorization headers can be included and both the callback url and auth headers will be encrypted when stored.

object or null

Optional configuration for a callback url to invoke when processing is complete, in addition to auth headers if they are needed to invoke the callback url. Cannot be set if callback_url is set. This option will not be visible in the submission response.

required
Array of objects [ 1 .. 50 ] items
Responses
200

Custom Vocabulary Job Details

400

Bad Request

401

Request Unauthorized

403

User does not have permission to access this deployment

404

Deployment does not support this API

post/vocabularies
Request samples
application/json
{
  • "metadata": "example metadata",
  • "notification_config": {},
  • "custom_vocabularies": [
    ]
}
Response samples
application/json
{}

Get List of Custom Vocabularies

Gets a list of most recent custom vocabularies' processing information

SecurityAccessToken
Request
query Parameters
limit
integer [ 0 .. 1000 ]

Limits the number of custom vocabulary details returned, default is 100, max is 1000

Responses
200

List of Custom Vocabularies' Processing Details

400

Bad Request

401

Request Unauthorized

403

User does not have permission to access this deployment

404

Deployment does not support this API

get/vocabularies
Request samples 
Response samples 
application/json
[
  • {},
  • {
    },
  • {
    }
]
Get Custom Vocabulary
Gets the custom vocabulary processing information


SecurityAccessToken 
Request 
path Parameters
id
required
string
Id of a custom vocabulary


 
Responses 
200
Custom Vocabulary Job Details


401
Request Unauthorized


403
User does not have permission to access this deployment


404
Custom Vocabulary Not Found


get/vocabularies/{id}
Request samples 
Response samples 
application/json
{}
Delete Custom Vocabulary
Deletes a custom vocabulary. All data related to the custom vocabulary, such as webhooks and metadata, will be permanently deleted. A custom vocabulary can only be deleted once it's completed (either with success or failure).


SecurityAccessToken 
Request 
path Parameters
id
required
string
Id of a custom vocabulary


 
Responses 
204
Custom vocabulary was successfully deleted


401
Request Unauthorized


403
User does not have permission to access this deployment


404
Custom Vocabulary Not Found


409
Invalid Deletion State


delete/vocabularies/{id}
Request samples 
Response samples 
application/problem+json
{
  • "title": "Authorization has been denied for this request",
  • "status": 401
}