List canon department rows

Módulo Canon

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.

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

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

canonDepartments.list: CanonDepartment
Campo	Tipo	Obligatorio	Descripción
dept_code	DeptCode	Sí	Department class code from `xpms.dim_department` (Section 3.2).Restricciones: pattern ^[0-9]000$
department	string	Sí	Department name.Restricciones: length 1 to 200
source	string	Sí	Canon source of the row.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
note	string \| null	Sí	Note from the Bible.Restricciones: length 1 to 20000
executive_lead	string \| null	Sí	Executive lead of the department.Restricciones: length 1 to 200
core_function	string \| null	Sí	Core function of the department.Restricciones: length 1 to 2000
scope	string \| null	Sí	Scope of the department.Restricciones: 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
}

Ejemplos de código

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