Get a canon unit alias

Módulo Canon

GET/canon/unit-aliases/{alias}canonUnitAliases.get

An alias of a controlled unit. Returns one canon unit alias with its `ETag`. A canon unit alias 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

canonUnitAliases.get: Parámetros de ruta y de consulta
Campo	Tipo	Obligatorio	Descripción
alias	string	Sí	Alias as written.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
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_])*$

canonUnitAliases.get: CanonUnitAlias
Campo	Tipo	Obligatorio	Descripción
alias	string	Sí	Alias as written.Restricciones: length 1 to 64
unit_code	string	Sí	Unit the alias maps to.Restricciones: length 1 to 64
dimension_code	string \| null	Sí	Dimension of the unit, once ratified.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$

{
  "alias": "ea",
  "unit_code": "ea",
  "dimension_code": "length"
}

curl -X GET "$XOS_BASE_URL/canon/unit-aliases/ea" \
  -H "Authorization: Bearer $XOS_API_KEY"

const { data, etag } = await xos.canonUnitAliases.get("ea");

response = xos.canon_unit_aliases.get("ea")

xos canon-unit-aliases get ea