Get a canon unit dimension
Canon module
GET/canon/unit-dimensions/{dimension_code}canonUnitDimensions.get
A controlled unit and the dimension it measures. Returns one canon unit dimension with its `ETag`. A canon unit dimension 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 |
|---|---|---|---|
| dimension_code | string | Yes | Dimension code.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: CanonUnitDimension
| Field | Type | Required | Description |
|---|---|---|---|
| dimension_code | string | Yes | Dimension code.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
| name | string | Yes | Dimension name.Constraints: pattern ^[A-Z0-9][A-Za-z0-9&'/.()-]*( [A-Za-z0-9&'/.()-]+)*$ |
{
"dimension_code": "length",
"name": "Length"
}Code samples
curl -X GET "$XOS_BASE_URL/canon/unit-dimensions/length" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.canonUnitDimensions.get("length");response = xos.canon_unit_dimensions.get("length")xos canon-unit-dimensions get length