Get a canon discipline
Canon module
GET/canon/disciplines/{disc_code}canonDisciplines.get
A discipline within a department class. Returns one canon discipline with its `ETag`. A canon discipline 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
| Field | Type | Required | Description |
|---|---|---|---|
| disc_code | DiscCode | Yes | Discipline code `DDDD.DD` from `xpms.dim_discipline`. Canon holds .01 to .49; tenant extensions hold .50 to .99.Constraints: pattern ^[0-9]000\.[0-9]{2}$ |
| 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: CanonDiscipline
| Field | Type | Required | Description |
|---|---|---|---|
| disc_code | DiscCode | Yes | Discipline code `DDDD.DD` from `xpms.dim_discipline`. Canon holds .01 to .49; tenant extensions hold .50 to .99.Constraints: pattern ^[0-9]000\.[0-9]{2}$ |
| dept_code | DeptCode | Yes | Department class code from `xpms.dim_department` (Section 3.2).Constraints: pattern ^[0-9]000$ |
| discipline | string | Yes | Discipline 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}$ |
{
"disc_code": "4000.01",
"dept_code": "4000",
"discipline": "Executive Leadership & Strategy",
"source": "canon"
}Code samples
curl -X GET "$XOS_BASE_URL/canon/disciplines/4000.01" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.canonDisciplines.get("4000.01");response = xos.canon_disciplines.get("4000.01")xos canon-disciplines get 4000.01