Get a std verbiage
Canon module
GET/canon/std/verbiage/{record_id}canonStdVerbiage.get
A controlled vocabulary term. Standard Library row, copied into each new org as editable org data. Returns one std verbiage with its `ETag`. A std verbiage 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 |
|---|---|---|---|
| record_id | StdCode | Yes | Natural code of a Standard Library row (Section 2.1).Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
| 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: StdVerbiage
| Field | Type | Required | Description |
|---|---|---|---|
| record_id | StdCode | Yes | Natural code of a Standard Library row (Section 2.1).Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
| verbiage | string | null | Yes | Term.Constraints: length 1 to 200 |
| title | string | null | Yes | Title.Constraints: length 1 to 500 |
| body | string | null | Yes | Text.Constraints: length 1 to 20000 |
| description | string | null | Yes | When the text is used.Constraints: length 1 to 20000 |
| department | string | null | Yes | Department as the sheet names it.Constraints: length 1 to 200 |
| category | string | null | Yes | Category code or name as the sheet gives it.Constraints: length 1 to 200 |
| sub_category | string | null | Yes | Sub-category as the sheet names it.Constraints: length 1 to 200 |
| status | string | null | Yes | Row status in the sheet.Constraints: length 1 to 200 |
| notes | string | null | Yes | Notes in the sheet.Constraints: length 1 to 20000 |
{
"record_id": "SOP-001",
"verbiage": "Load-In",
"title": "Load-In Announcement",
"body": "All crew to the loading dock.",
"description": "Read at the start of load-in.",
"department": "5000 Production",
"category": "5000.05.02",
"sub_category": "Overhead Rigging",
"status": "Active",
"notes": "Primary life safety and incident response"
}Code samples
curl -X GET "$XOS_BASE_URL/canon/std/verbiage/SOP-001" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.canonStdVerbiage.get("SOP-001");response = xos.canon_std_verbiage.get("SOP-001")xos canon-std-verbiage get SOP-001