Get a canon department

Canon module

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.

Requires the capability canon.taxonomy.read.
OAuth scopes: canon.
Error statuses: 400, 401, 404, 429. Errors are RFC 9457 problem details.

Path and query parameters

canonDepartments.get: Path and query parameters
Field	Type	Required	Description
dept_code	DeptCode	Yes	Department class code from `xpms.dim_department` (Section 3.2).Constraints: pattern ^[0-9]000$
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_])*$

Response 200: CanonDepartment

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

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

Code samples

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