Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

DescribeCustomVocabularyMetadata

Provides metadata information about a custom vocabulary.

Request Syntax


GET /bots/botId/botversions/botVersion/botlocales/localeId/customvocabulary/DEFAULT/metadata HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

botId

The unique identifier of the bot that contains the custom vocabulary.

Length Constraints: Fixed length of 10.

Pattern: ^[0-9a-zA-Z]+$

Required: Yes

botVersion

The bot version of the bot to return metadata for.

Length Constraints: Minimum length of 1. Maximum length of 5.

Pattern: ^(DRAFT|[0-9]+)$

Required: Yes

localeId

The locale to return the custom vocabulary information for. The locale must be en_GB.

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "botId": "string",
   "botVersion": "string",
   "creationDateTime": number,
   "customVocabularyStatus": "string",
   "lastUpdatedDateTime": number,
   "localeId": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

botId

The identifier of the bot that contains the custom vocabulary.

Type: String

Length Constraints: Fixed length of 10.

Pattern: ^[0-9a-zA-Z]+$

botVersion

The version of the bot that contains the custom vocabulary to describe.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 5.

Pattern: ^(DRAFT|[0-9]+)$

creationDateTime

The date and time that the custom vocabulary was created.

Type: Timestamp

customVocabularyStatus

The status of the custom vocabulary. If the status is Ready the custom vocabulary is ready to use.

Type: String

Valid Values: Ready | Deleting | Exporting | Importing | Creating

lastUpdatedDateTime

The date and time that the custom vocabulary was last updated.

Type: Timestamp

localeId

The locale that contains the custom vocabulary to describe.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServerException

The service encountered an unexpected condition. Try your request again.

HTTP Status Code: 500

ResourceNotFoundException

You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.

HTTP Status Code: 404

ServiceQuotaExceededException

You have reached a quota for your bot.

HTTP Status Code: 402

ThrottlingException

Your request rate is too high. Reduce the frequency of requests.

HTTP Status Code: 429

ValidationException

One of the input parameters in your request isn't valid. Check the parameters and try your request again.

HTTP Status Code: 400