List std role rows
Canon module
GET/canon/std/rolescanonStdRoles.list
A Roles Library entry. Standard Library row, copied into each new org as editable org data. Returns a cursor page of std role rows the caller may see. The default order is `role_code` ascending. Supports sparse fieldsets and the filter grammar.
- Requires the capability canon.taxonomy.read.
- OAuth scopes: canon.
- Cursor-paginated: limit, cursor, fields, sort and filter apply.
- Error statuses: 400, 401, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| limit | Limit | No | Page size. Default 50, maximum 200.Constraints: range 1 to 200 |
| cursor | Cursor | No | Opaque cursor from `next_cursor` of the previous page.Constraints: length 1 to any |
| 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_]*)*$ |
| sort | Sort | No | Sort keys, comma-separated; a leading `-` sorts descending. Without `sort`, the documented default order applies (coded lists sort in numeric code order).Constraints: pattern ^-?[a-z_][a-z0-9_]*(,-?[a-z_][a-z0-9_]*)*$ |
| filter | Filter | No | Filter grammar `filter[field][op]=value`. Operators: eq, ne, lt, lte, gt, gte, in (comma-separated values), is_null (true or false) and contains. Conditions combine with AND. |
Response 200: a page of 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 |
{
"data": [
{
"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."
}
],
"next_cursor": null
}Code samples
curl -X GET "$XOS_BASE_URL/canon/std/roles" \
-H "Authorization: Bearer $XOS_API_KEY"for await (const row of xos.canonStdRoles.listAll()) {
console.log(row);
}for row in xos.canon_std_roles.list_all():
print(row)xos canon-std-roles list --all