Get a canon unit alias
Canon module
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.
- Requires the capability canon.taxonomy.read.
- OAuth scopes: canon.
- Error statuses: 400, 401, 404, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| alias | string | Yes | Alias as written.Constraints: 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.Constraints: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$ |
Response 200: CanonUnitAlias
| Field | Type | Required | Description |
|---|---|---|---|
| alias | string | Yes | Alias as written.Constraints: length 1 to 64 |
| unit_code | string | Yes | Unit the alias maps to.Constraints: length 1 to 64 |
| dimension_code | string | null | Yes | Dimension of the unit, once ratified.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
{
"alias": "ea",
"unit_code": "ea",
"dimension_code": "length"
}Code samples
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