Get a std role
Canon module
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.
- 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 |
|---|---|---|---|
| role_code | RoleCode | Yes | Workforce role code from `xpms.dim_role`, on URID grammar.Constraints: 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.Constraints: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$ |
Response 200: StdRole
| Field | Type | Required | Description |
|---|---|---|---|
| role_code | RoleCode | Yes | Workforce role code from `xpms.dim_role`, on URID grammar.Constraints: pattern ^[0-9]000\.[0-9]{2}\.[0-9]{2}$ |
| class_code | DeptCode | Yes | Department class code from `xpms.dim_department` (Section 3.2).Constraints: pattern ^[0-9]000$ |
| job_title | string | Yes | Job title; the one home of the title.Constraints: length 1 to 300 |
| discipline | string | Yes | Discipline.Constraints: length 1 to 200 |
| rank | string | Yes | Rank.Constraints: length 1 to 200 |
| job_summary | string | null | Yes | Job summary.Constraints: length 1 to 20000 |
| key_responsibilities | string | null | Yes | Key responsibilities.Constraints: length 1 to 20000 |
| qualifications | string | null | Yes | Qualifications.Constraints: length 1 to 20000 |
| physical_requirements | string | null | Yes | Physical requirements.Constraints: length 1 to 20000 |
| required_certifications | string | null | Yes | Required certifications.Constraints: length 1 to 20000 |
| default_clearance_tier | string | null | Yes | Default clearance tier.Constraints: length 1 to 200 |
| default_radio_channel | string | null | Yes | Default radio channel.Constraints: length 1 to 200 |
| notes | string | null | Yes | Notes in the sheet.Constraints: 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."
}Code samples
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