Get a canon act
Módulo Canon
GET/canon/acts/{act_code}canonActs.get
An act: a presentation grouping of gates, never a control point. Returns one canon act with its `ETag`. A canon act 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 |
|---|---|---|---|
| act_code | ActCode | Sí | Act from `xpms.dim_act`.Restricciones: pattern ^[A-Z]+$ |
| 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: CanonAct
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| ordinal | integer | Sí | Act ordinal.Restricciones: range 1 to any |
| 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 |
{
"ordinal": 1,
"act_code": "PLAN",
"definition": "Everything before money is committed."
}Ejemplos de código
curl -X GET "$XOS_BASE_URL/canon/acts/PLAN" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.canonActs.get("PLAN");response = xos.canon_acts.get("PLAN")xos canon-acts get PLAN