List canon phase rows

Canon module

GET/canon/phasescanonPhases.list

A gated phase. Nine phases with fixed, append-only ordinals. Returns a cursor page of canon phase rows the caller may see. Coded list: the default order is numeric code order by `gate`. 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

canonPhases.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 CanonPhase

canonPhases.list: CanonPhase
Field	Type	Required	Description
gate	integer	Yes	Gate ordinal.Constraints: range 1 to any
phase_code	PhaseCode	Yes	Phase code from `xpms.dim_phase`, ordered by gate ordinal.Constraints: pattern ^[A-Z]{3}$
phase	string	Yes	Phase name.Constraints: length 1 to 200
act_code	ActCode	Yes	Act from `xpms.dim_act`.Constraints: pattern ^[A-Z]+$
definition	string	Yes	Definition, in sentence case.Constraints: length 1 to 20000
gate_exit	string	Yes	What must be true to pass the gate.Constraints: length 1 to 20000
is_redefined	boolean	Yes	True when 4.0 kept the code but redefined the phase (Advance).

{
  "data": [
    {
      "gate": 1,
      "phase_code": "SCP",
      "phase": "Scope",
      "act_code": "PLAN",
      "definition": "What needs to happen.",
      "gate_exit": "Go or no-go ratified.",
      "is_redefined": false
    },
    {
      "gate": 2,
      "phase_code": "ENG",
      "phase": "Engage",
      "act_code": "PLAN",
      "definition": "What needs to happen.",
      "gate_exit": "Go or no-go ratified.",
      "is_redefined": false
    }
  ],
  "next_cursor": null
}

Code samples

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

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

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

xos canon-phases list --all