Get a std role

Módulo Canon

GET/canon/std/roles/{role_code}canonStdRoles.get

A Roles Library entry. Standard Library row, copied into each new org as editable org data. Returns one std role with its `ETag`. A std role 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

canonStdRoles.get: Parámetros de ruta y de consulta
Campo	Tipo	Obligatorio	Descripción
role_code	RoleCode	Sí	Workforce role code from `xpms.dim_role`, on URID grammar.Restricciones: pattern ^[0-9]000\.[0-9]{2}\.[0-9]{2}$
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: StdRole

canonStdRoles.get: StdRole
Campo	Tipo	Obligatorio	Descripción
role_code	RoleCode	Sí	Workforce role code from `xpms.dim_role`, on URID grammar.Restricciones: pattern ^[0-9]000\.[0-9]{2}\.[0-9]{2}$
class_code	DeptCode	Sí	Department class code from `xpms.dim_department` (Section 3.2).Restricciones: pattern ^[0-9]000$
job_title	string	Sí	Job title; the one home of the title.Restricciones: length 1 to 300
discipline	string	Sí	Discipline.Restricciones: length 1 to 200
rank	string	Sí	Rank.Restricciones: length 1 to 200
job_summary	string \| null	Sí	Job summary.Restricciones: length 1 to 20000
key_responsibilities	string \| null	Sí	Key responsibilities.Restricciones: length 1 to 20000
qualifications	string \| null	Sí	Qualifications.Restricciones: length 1 to 20000
physical_requirements	string \| null	Sí	Physical requirements.Restricciones: length 1 to 20000
required_certifications	string \| null	Sí	Required certifications.Restricciones: length 1 to 20000
default_clearance_tier	string \| null	Sí	Default clearance tier.Restricciones: length 1 to 200
default_radio_channel	string \| null	Sí	Default radio channel.Restricciones: length 1 to 200
notes	string \| null	Sí	Notes in the sheet.Restricciones: length 1 to 20000

{
  "role_code": "5000.50.01",
  "class_code": "4000",
  "job_title": "Head Rigger",
  "discipline": "Rigging",
  "rank": "Lead",
  "job_summary": "Leads the rigging crew.",
  "key_responsibilities": "Plans and signs off every point.",
  "qualifications": "ETCP Certified Rigger.",
  "physical_requirements": "Works at height.",
  "required_certifications": "ETCP",
  "default_clearance_tier": "Tier 2",
  "default_radio_channel": "RCH-004",
  "notes": "Union call."
}

Ejemplos de código

curl -X GET "$XOS_BASE_URL/canon/std/roles/5000.50.01" \
  -H "Authorization: Bearer $XOS_API_KEY"

const { data, etag } = await xos.canonStdRoles.get("5000.50.01");

response = xos.canon_std_roles.get("5000.50.01")

xos canon-std-roles get 5000.50.01