List std sop rows

Módulo Canon

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.

Requiere la capacidad canon.taxonomy.read.
Alcances de OAuth: canon.
Paginación por cursor: se aplican limit, cursor, fields, sort y filter.
Estados de error: 400, 401, 429. Los errores son detalles de problema RFC 9457.

Parámetros de ruta y de consulta

canonStdSops.list: Parámetros de ruta y de consulta
Campo	Tipo	Obligatorio	Descripción
limit	Limit	No	Page size. Default 50, maximum 200.Restricciones: range 1 to 200
cursor	Cursor	No	Opaque cursor from `next_cursor` of the previous page.Restricciones: length 1 to any
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_])*$
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).Restricciones: 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.

Respuesta 200: una página de StdSop

canonStdSops.list: StdSop
Campo	Tipo	Obligatorio	Descripción
sop_id	StdCode	Sí	Natural code of a Standard Library row (Section 2.1).Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
title	string \| null	Sí	SOP title.Restricciones: length 1 to 200
operational_domain	string \| null	Sí	Operational domain.Restricciones: length 1 to 300
revision	string \| null	Sí	Revision.Restricciones: length 1 to 100
accountable_role_code	string \| null	Sí	Accountable role code.Restricciones: length 1 to 100
required_ppe_compliance_tag	string \| null	Sí	Required PPE and compliance tags.Restricciones: length 1 to 20000
prerequisites_and_hazards	string \| null	Sí	Prerequisites and hazards.Restricciones: length 1 to 20000
procedure_step_1	string \| null	Sí	Procedure step 1.Restricciones: length 1 to 20000
procedure_step_2	string \| null	Sí	Procedure step 2.Restricciones: length 1 to 20000
procedure_step_3	string \| null	Sí	Procedure step 3.Restricciones: length 1 to 20000
procedure_step_4	string \| null	Sí	Procedure step 4.Restricciones: length 1 to 20000
reference_doc_id	string \| null	Sí	Reference document.Restricciones: length 1 to 200
department	string \| null	Sí	Department as the sheet names it.Restricciones: length 1 to 200
category	string \| null	Sí	Category code or name as the sheet gives it.Restricciones: length 1 to 200
sub_category	string \| null	Sí	Sub-category as the sheet names it.Restricciones: length 1 to 200
status	string \| null	Sí	Row status in the sheet.Restricciones: length 1 to 200
notes	string \| null	Sí	Notes in the sheet.Restricciones: length 1 to 20000
organization	string \| null	Sí	Organization as the sheet names it.Restricciones: length 1 to 200
project	string \| null	Sí	Project as the sheet names it.Restricciones: 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
}

Ejemplos de código

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