Get a Locale - Cognigy Documentation

Authorizations

X-API-Key

string

header

required

Supply the API Key in the HTTP-Header

Headers

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

localeId

string

required

The unique identifier for the Locale.

Required string length: 24

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

Response

Returns the Locale 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 Locale.

Example:

"English"

primary

boolean

If set to true, the Locale is the primary Locale for the Agent.

nluLanguage

enum<string>

The BCP 47 language tag used for NLU for this Locale.

Available options:

ge-GE,

da-DK,

en-AU,

en-CA,

en-IN,

en-GB,

en-US,

de-DE,

ja-JP,

ko-KR,

es-ES,

nl-NL,

ar-AE,

fi-FI,

fr-FR,

it-IT,

nn-NO,

pl-PL,

sv-SE,

th-TH,

zh-CN,

vi-VN,

pt-BR,

ru-RU,

pt-PT,

tr-TR,

hi-IN,

bn-IN,

ta-IN

Example:

"en-US"

fallbackLocaleReference

string

The unique identifier for the fallback Locale.

Required string length: 24

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

_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}$