List canon department rows

Canon module

GET/canon/departmentscanonDepartments.list

A department class. Ten classes, always in numeric order. Returns a cursor page of canon department rows the caller may see. Coded list: the default order is numeric code order by `dept_code`. 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

canonDepartments.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 CanonDepartment

canonDepartments.list: CanonDepartment
Field	Type	Required	Description
dept_code	DeptCode	Yes	Department class code from `xpms.dim_department` (Section 3.2).Constraints: pattern ^[0-9]000$
department	string	Yes	Department 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}$
note	string \| null	Yes	Note from the Bible.Constraints: length 1 to 20000
executive_lead	string \| null	Yes	Executive lead of the department.Constraints: length 1 to 200
core_function	string \| null	Yes	Core function of the department.Constraints: length 1 to 2000
scope	string \| null	Yes	Scope of the department.Constraints: length 1 to 2000

{
  "data": [
    {
      "dept_code": "0000",
      "department": "Executive",
      "source": "canon",
      "note": "Environment replaces the 3.0 label.",
      "executive_lead": "Executive Producer",
      "core_function": "Governance, master project control & compliance",
      "scope": "Master operations & overall accountability"
    },
    {
      "dept_code": "4000",
      "department": "Environment",
      "source": "canon",
      "note": "Environment replaces the 3.0 label.",
      "executive_lead": "Executive Producer",
      "core_function": "Governance, master project control & compliance",
      "scope": "Master operations & overall accountability"
    }
  ],
  "next_cursor": null
}

Code samples

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

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

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

xos canon-departments list --all