Get a canon department

Módulo Canon

GET/canon/departments/{dept_code}canonDepartments.get

A department class. Ten classes, always in numeric order. Returns one canon department with its `ETag`. A canon department the caller may not see returns 404.

Requiere la capacidad canon.taxonomy.read.
Alcances de OAuth: canon.
Estados de error: 400, 401, 404, 429. Los errores son detalles de problema RFC 9457.

Parámetros de ruta y de consulta

canonDepartments.get: Parámetros de ruta y de consulta
Campo	Tipo	Obligatorio	Descripción
dept_code	DeptCode	Sí	Department class code from `xpms.dim_department` (Section 3.2).Restricciones: pattern ^[0-9]000$
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_])*$

Respuesta 200: CanonDepartment

canonDepartments.get: 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

{
  "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"
}

Ejemplos de código

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

const { data, etag } = await xos.canonDepartments.get("4000");

response = xos.canon_departments.get("4000")

xos canon-departments get 4000