Get a canon locale

Módulo Canon

GET/canon/locales/{locale_code}canonLocales.get

A supported locale. Returns one canon locale with its `ETag`. A canon locale the caller may not see returns 404.

Requiere la capacidad canon.taxonomy.read.
Alcances de OAuth: canon.
Estados de error: 400, 401, 404, 429. Los errores son detalles de problema RFC 9457.

Parámetros de ruta y de consulta

canonLocales.get: Parámetros de ruta y de consulta
Campo	Tipo	Obligatorio	Descripción
locale_code	string	Sí	BCP 47 locale tag.Restricciones: pattern ^[a-z]{2,3}(-[A-Z]{2})?$
fields	Fields	No	Sparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Restricciones: pattern ^[a-z_][a-z0-9_](,[a-z_][a-z0-9_])*$

canonLocales.get: CanonLocale
Campo	Tipo	Obligatorio	Descripción
locale_code	string	Sí	BCP 47 locale tag.Restricciones: pattern ^[a-z]{2,3}(-[A-Z]{2})?$
name	string	Sí	Locale name.Restricciones: length 1 to 200
is_source	boolean	Sí	True for the source locale, en-US.
release_stage	"general" \| "beta"	Sí	Release stage.

{
  "locale_code": "en-US",
  "name": "English (United States)",
  "is_source": true,
  "release_stage": "general"
}

curl -X GET "$XOS_BASE_URL/canon/locales/en-US" \
  -H "Authorization: Bearer $XOS_API_KEY"

const { data, etag } = await xos.canonLocales.get("en-US");

response = xos.canon_locales.get("en-US")

xos canon-locales get en-US