Get a canon phase
Canon module
GET/canon/phases/{phase_code}canonPhases.get
A gated phase. Nine phases with fixed, append-only ordinals. Returns one canon phase with its `ETag`. A canon phase 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 |
|---|---|---|---|
| phase_code | PhaseCode | Yes | Phase code from `xpms.dim_phase`, ordered by gate ordinal.Constraints: pattern ^[A-Z]{3}$ |
| 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: 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). |
{
"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
}Code samples
curl -X GET "$XOS_BASE_URL/canon/phases/SCP" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.canonPhases.get("SCP");response = xos.canon_phases.get("SCP")xos canon-phases get SCP