Get a canon phase
Módulo Canon
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.
- Requiere la capacidad canon.taxonomy.read.
- Alcances de OAuth: canon.
- Estados de error: 400, 401, 404, 429. Los errores son detalles de problema RFC 9457.
Parámetros de ruta y de consulta
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| phase_code | PhaseCode | Sí | Phase code from `xpms.dim_phase`, ordered by gate ordinal.Restricciones: pattern ^[A-Z]{3}$ |
| 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_]*)*$ |
Respuesta 200: CanonPhase
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| gate | integer | Sí | Gate ordinal.Restricciones: range 1 to any |
| phase_code | PhaseCode | Sí | Phase code from `xpms.dim_phase`, ordered by gate ordinal.Restricciones: pattern ^[A-Z]{3}$ |
| phase | string | Sí | Phase name.Restricciones: length 1 to 200 |
| act_code | ActCode | Sí | Act from `xpms.dim_act`.Restricciones: pattern ^[A-Z]+$ |
| definition | string | Sí | Definition, in sentence case.Restricciones: length 1 to 20000 |
| gate_exit | string | Sí | What must be true to pass the gate.Restricciones: length 1 to 20000 |
| is_redefined | boolean | Sí | 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
}Ejemplos de código
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