List canon role rows

Canon module

GET/canon/rolescanonRoles.list

A workforce role with its staffing ratio. Returns a cursor page of canon role rows the caller may see. Coded list: the default order is numeric code order by `role_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

canonRoles.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 CanonRole

canonRoles.list: CanonRole
Field	Type	Required	Description
role_code	RoleCode	Yes	Workforce role code from `xpms.dim_role`, on URID grammar.Constraints: pattern ^[0-9]000\.[0-9]{2}\.[0-9]{2}$
role	string	Yes	Role function name.Constraints: length 1 to 200
dept_code	DeptCode	Yes	Department class code from `xpms.dim_department` (Section 3.2).Constraints: pattern ^[0-9]000$
staffing_ratio	number \| null	Yes	Staffing ratio from canon: how many people one role holder covers.Constraints: range 0 to any
ratio_basis	string \| null	Yes	Basis of the ratio.Constraints: length 1 to 300
kit_basis	string \| null	Yes	Kit basis.Constraints: length 1 to 300
job_title	string \| null	Yes	Job title.Constraints: length 1 to 200

{
  "data": [
    {
      "role_code": "0000.50.01",
      "role": "Client sponsorship",
      "dept_code": "0000",
      "staffing_ratio": 250,
      "ratio_basis": "Guests",
      "kit_basis": "Per person",
      "job_title": "Head Rigger"
    },
    {
      "role_code": "0000.50.02",
      "role": "Operator leadership",
      "dept_code": "0000",
      "staffing_ratio": 250,
      "ratio_basis": "Guests",
      "kit_basis": "Per person",
      "job_title": "Head Rigger"
    }
  ],
  "next_cursor": null
}

Code samples

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

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

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

xos canon-roles list --all