Get a canon category
Canon module
GET/canon/categories/{cat_urid}canonCategories.get
A category, the finest URID grain. Returns one canon category with its `ETag`. A canon category 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 |
|---|---|---|---|
| cat_urid | Urid | Yes | Category URID `DDDD.DD.DD` from `xpms.dim_category` (Section 3.3). There is no fourth segment.Constraints: pattern ^[0-9]000\.[0-9]{2}\.[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: CanonCategory
| Field | Type | Required | Description |
|---|---|---|---|
| cat_urid | Urid | Yes | Category URID `DDDD.DD.DD` from `xpms.dim_category` (Section 3.3). There is no fourth segment.Constraints: pattern ^[0-9]000\.[0-9]{2}\.[0-9]{2}$ |
| disc_code | DiscCode | Yes | Discipline code `DDDD.DD` from `xpms.dim_discipline`. Canon holds .01 to .49; tenant extensions hold .50 to .99.Constraints: pattern ^[0-9]000\.[0-9]{2}$ |
| category | string | Yes | Category name.Constraints: length 1 to 200 |
| source | string | Yes | Canon source of the row.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
| xyz | Xyz | null | Yes |
{
"cat_urid": "4000.01.01",
"disc_code": "4000.01",
"category": "Production Leadership",
"source": "canon",
"xyz": "X"
}Code samples
curl -X GET "$XOS_BASE_URL/canon/categories/4000.01.01" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.canonCategories.get("4000.01.01");response = xos.canon_categories.get("4000.01.01")xos canon-categories get 4000.01.01