Saltar al contenido

Get a canon discipline

Módulo Canon

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.

  • 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

canonDisciplines.get: Parámetros de ruta y de consulta
CampoTipoObligatorioDescripción
disc_codeDiscCodeSíDiscipline code `DDDD.DD` from `xpms.dim_discipline`. Canon holds .01 to .49; tenant extensions hold .50 to .99.Restricciones: pattern ^[0-9]000\.[0-9]{2}$
fieldsFieldsNoSparse 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: CanonDiscipline

canonDisciplines.get: CanonDiscipline
CampoTipoObligatorioDescripción
disc_codeDiscCodeSíDiscipline code `DDDD.DD` from `xpms.dim_discipline`. Canon holds .01 to .49; tenant extensions hold .50 to .99.Restricciones: pattern ^[0-9]000\.[0-9]{2}$
dept_codeDeptCodeSíDepartment class code from `xpms.dim_department` (Section 3.2).Restricciones: pattern ^[0-9]000$
disciplinestringSíDiscipline name.Restricciones: length 1 to 200
sourcestringSíCanon source of the row.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
{
  "disc_code": "4000.01",
  "dept_code": "4000",
  "discipline": "Executive Leadership & Strategy",
  "source": "canon"
}

Ejemplos de código

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