Get a canon tier
Canon module
GET/canon/tiers/{tier_code}canonTiers.get
A tier of experience. International is never a tier. Returns one canon tier with its `ETag`. A canon tier 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 |
|---|---|---|---|
| tier_code | TierCode | Yes | Tier of experience code from `xpms.dim_tier`.Constraints: pattern ^[0-9]{2}$ |
| 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: CanonTier
| Field | Type | Required | Description |
|---|---|---|---|
| tier_code | TierCode | Yes | Tier of experience code from `xpms.dim_tier`.Constraints: pattern ^[0-9]{2}$ |
| tier | string | Yes | Tier name.Constraints: length 1 to 200 |
{
"tier_code": "04",
"tier": "Physical"
}Code samples
curl -X GET "$XOS_BASE_URL/canon/tiers/04" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.canonTiers.get("04");response = xos.canon_tiers.get("04")xos canon-tiers get 04