List canon role rows

Módulo Canon

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.

Requiere la capacidad canon.taxonomy.read.
Alcances de OAuth: canon.
Paginación por cursor: se aplican limit, cursor, fields, sort y filter.
Estados de error: 400, 401, 429. Los errores son detalles de problema RFC 9457.

Parámetros de ruta y de consulta

canonRoles.list: Parámetros de ruta y de consulta
Campo	Tipo	Obligatorio	Descripción
limit	Limit	No	Page size. Default 50, maximum 200.Restricciones: range 1 to 200
cursor	Cursor	No	Opaque cursor from `next_cursor` of the previous page.Restricciones: length 1 to any
fields	Fields	No	Sparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Restricciones: 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).Restricciones: 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.

Respuesta 200: una página de CanonRole

canonRoles.list: CanonRole
Campo	Tipo	Obligatorio	Descripción
role_code	RoleCode	Sí	Workforce role code from `xpms.dim_role`, on URID grammar.Restricciones: pattern ^[0-9]000\.[0-9]{2}\.[0-9]{2}$
role	string	Sí	Role function name.Restricciones: length 1 to 200
dept_code	DeptCode	Sí	Department class code from `xpms.dim_department` (Section 3.2).Restricciones: pattern ^[0-9]000$
staffing_ratio	number \| null	Sí	Staffing ratio from canon: how many people one role holder covers.Restricciones: range 0 to any
ratio_basis	string \| null	Sí	Basis of the ratio.Restricciones: length 1 to 300
kit_basis	string \| null	Sí	Kit basis.Restricciones: length 1 to 300
job_title	string \| null	Sí	Job title.Restricciones: 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
}

Ejemplos de código

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