List canon category rows

Canon module

GET/canon/categoriescanonCategories.list

A category, the finest URID grain. Returns a cursor page of canon category rows the caller may see. Coded list: the default order is numeric code order by `cat_urid`. Supports sparse fieldsets and the filter grammar.

Requires the capability canon.taxonomy.read.
OAuth scopes: canon.
Cursor-paginated: limit, cursor, fields, sort and filter apply.
Error statuses: 400, 401, 429. Errors are RFC 9457 problem details.

Path and query parameters

canonCategories.list: Path and query parameters
Field	Type	Required	Description
limit	Limit	No	Page size. Default 50, maximum 200.Constraints: range 1 to 200
cursor	Cursor	No	Opaque cursor from `next_cursor` of the previous page.Constraints: length 1 to any
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_])*$
sort	Sort	No	Sort keys, comma-separated; a leading `-` sorts descending. Without `sort`, the documented default order applies (coded lists sort in numeric code order).Constraints: pattern ^-?[a-z_][a-z0-9_](,-?[a-z_][a-z0-9_])*$
filter	Filter	No	Filter grammar `filter[field][op]=value`. Operators: eq, ne, lt, lte, gt, gte, in (comma-separated values), is_null (true or false) and contains. Conditions combine with AND.

Response 200: a page of CanonCategory

canonCategories.list: 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

{
  "data": [
    {
      "cat_urid": "0000.01.01",
      "disc_code": "0000.01",
      "category": "Production Leadership",
      "source": "canon",
      "xyz": "X"
    },
    {
      "cat_urid": "0000.02.01",
      "disc_code": "0000.02",
      "category": "Production Accounting",
      "source": "canon",
      "xyz": "X"
    }
  ],
  "next_cursor": null
}

Code samples

curl -X GET "$XOS_BASE_URL/canon/categories" \
  -H "Authorization: Bearer $XOS_API_KEY"

for await (const row of xos.canonCategories.listAll()) {
  console.log(row);
}

for row in xos.canon_categories.list_all():
    print(row)

xos canon-categories list --all