Lexicons

Get a Lexicon

Gets a Lexicon from a Project.

get/v2.0/lexicons/{lexiconId}

Request

Base URL
https://api-trial.cognigy.ai/testing
Auth
- API key in header X-API-Key
- or API key in query parameter api_key
- or API key in header x-cxone-authorization
- or OAuth 2
  Authorization code/auth/oauth2/authorize
  Password
  Token URL/auth/oauth2/token
TypeScript
https://skmtc.dev/cognigy/apis/simulator-openapi-rest-ful-api-reference/docs/v2.0/lexicons/:lexiconId/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

lexiconIdstring required

The unique identifier for the Lexicon.

Query parameters

metaOnlytrue | false

If set to true, returns only Lexicon metadata.

Headers

Accept'application/json' | 'application/hal+json' | 'application/xml' | 'text/xml' | 'text/csv'

The Accept header specifies the media type that the client expects in the response. Available options: application/json, application/hal+json, application/xml, text/xml, text/csv. The default value is application/json.

Response

Returns Lexicon Object

namestring

The name of the lexicon

descriptionstring

A meaningful description of the lexicon

referenceIdstring uuid

valuesunknown

_idstring

createdAtinteger

Unix-timestamp

lastChangedinteger

Unix-timestamp

createdBystring

lastChangedBystring

Example response

{
  "name": "EU countries",
  "description": "Countries members of the European Union, e.g. Spain",
  "createdAt": 1694518620,
  "lastChanged": 1694518620
}

Changes

No recorded changes to this operation across all 1 revision of this API.