Get a canon act
Canon module
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.
- 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 |
|---|---|---|---|
| act_code | ActCode | Yes | Act from `xpms.dim_act`.Constraints: pattern ^[A-Z]+$ |
| 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: CanonAct
| Field | Type | Required | Description |
|---|---|---|---|
| ordinal | integer | Yes | Act ordinal.Constraints: range 1 to any |
| 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 |
{
"ordinal": 1,
"act_code": "PLAN",
"definition": "Everything before money is committed."
}Code samples
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