List std sop rows

Canon module

GET/canon/std/sopscanonStdSops.list

A standard operating procedure. Standard Library row, copied into each new org as editable org data. Returns a cursor page of std sop rows the caller may see. The default order is `sop_id` 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

canonStdSops.list: 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 StdSop

canonStdSops.list: StdSop
Field	Type	Required	Description
sop_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}$
title	string \| null	Yes	SOP title.Constraints: length 1 to 200
operational_domain	string \| null	Yes	Operational domain.Constraints: length 1 to 300
revision	string \| null	Yes	Revision.Constraints: length 1 to 100
accountable_role_code	string \| null	Yes	Accountable role code.Constraints: length 1 to 100
required_ppe_compliance_tag	string \| null	Yes	Required PPE and compliance tags.Constraints: length 1 to 20000
prerequisites_and_hazards	string \| null	Yes	Prerequisites and hazards.Constraints: length 1 to 20000
procedure_step_1	string \| null	Yes	Procedure step 1.Constraints: length 1 to 20000
procedure_step_2	string \| null	Yes	Procedure step 2.Constraints: length 1 to 20000
procedure_step_3	string \| null	Yes	Procedure step 3.Constraints: length 1 to 20000
procedure_step_4	string \| null	Yes	Procedure step 4.Constraints: length 1 to 20000
reference_doc_id	string \| null	Yes	Reference document.Constraints: length 1 to 200
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
organization	string \| null	Yes	Organization as the sheet names it.Constraints: length 1 to 200
project	string \| null	Yes	Project as the sheet names it.Constraints: length 1 to 200

{
  "data": [
    {
      "sop_id": "SOP-001",
      "title": "Working at Height",
      "operational_domain": "Structural & Rigging Safety",
      "revision": "v2.0",
      "accountable_role_code": "5000.51.02",
      "required_ppe_compliance_tag": "TAG-002 OSHA",
      "prerequisites_and_hazards": "Verify the drop zone.",
      "procedure_step_1": "Inspect every hoist.",
      "procedure_step_2": "Lift to trim.",
      "procedure_step_3": "Load test.",
      "procedure_step_4": "Sign off.",
      "reference_doc_id": "DOC-004",
      "department": "5000 Production",
      "category": "5000.05.02",
      "sub_category": "Overhead Rigging",
      "status": "Active",
      "notes": "Primary life safety and incident response",
      "organization": "GHXSTSHIP",
      "project": "CSMIA26"
    }
  ],
  "next_cursor": null
}

Code samples

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

for await (const row of xos.canonStdSops.listAll()) {
  console.log(row);
}

for row in xos.canon_std_sops.list_all():
    print(row)

xos canon-std-sops list --all