Skip to main content
GET
/
v2.0
/
lexicons
/
{lexiconId}
Get a Lexicon
curl --request GET \
  --url https://api-trial.cognigy.ai/new/v2.0/lexicons/{lexiconId} \
  --header 'X-API-Key: <api-key>'
{
  "name": "EU countries",
  "description": "Countries members of the European Union, e.g. Spain",
  "referenceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "values": "<unknown>",
  "_id": "<string>",
  "createdAt": 1694518620,
  "lastChanged": 1694518620,
  "createdBy": "<string>",
  "lastChangedBy": "<string>"
}

Authorizations

ā€‹
X-API-Key
string
header
required

Supply the API Key in the HTTP-Header

Headers

ā€‹
Accept
enum<string>

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.

Available options:
application/json,
application/hal+json,
application/xml,
text/xml,
text/csv

Path Parameters

ā€‹
lexiconId
string
required

The unique identifier for the Lexicon.

Required string length: 24
Pattern: ^[a-z0-9]{24}$

Query Parameters

ā€‹
metaOnly
enum<boolean>

If set to true, returns only Lexicon metadata.

Available options:
true,
false

Response

Returns Lexicon Object

The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.

ā€‹
name
string

The name of the lexicon

Example:

"EU countries"

ā€‹
description
string

A meaningful description of the lexicon

Example:

"Countries members of the European Union, e.g. Spain"

ā€‹
referenceId
string<uuid>
ā€‹
values
any
ā€‹
_id
string
Required string length: 24
Pattern: ^[a-z0-9]{24}$
ā€‹
createdAt
integer

Unix-timestamp

Required range: 0 <= x <= 2147483647
Example:

1694518620

ā€‹
lastChanged
integer

Unix-timestamp

Required range: 0 <= x <= 2147483647
Example:

1694518620

ā€‹
createdBy
string
Required string length: 24
Pattern: ^[a-z0-9]{24}$
ā€‹
lastChangedBy
string
Required string length: 24
Pattern: ^[a-z0-9]{24}$