Get a canon gate criterion
Canon module
GET/canon/gate-criteria/{criterion_id}canonGateCriteria.get
A gate criterion. Blocking criteria stop the gate transition in the database. Returns one canon gate criterion with its `ETag`. A canon gate criterion 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 |
|---|---|---|---|
| criterion_id | CriterionId | Yes | Gate criterion identifier from `xpms.dim_gate_criterion`.Constraints: pattern ^G[1-9]\.[A-Z0-9_]+$ |
| 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: CanonGateCriterion
| Field | Type | Required | Description |
|---|---|---|---|
| gate | integer | Yes | Gate ordinal.Constraints: range 1 to any |
| criterion_id | CriterionId | Yes | Gate criterion identifier from `xpms.dim_gate_criterion`.Constraints: pattern ^G[1-9]\.[A-Z0-9_]+$ |
| statement | string | Yes | Criterion statement.Constraints: length 1 to 20000 |
| is_blocking | boolean | Yes | Whether the criterion blocks the gate. |
{
"gate": 1,
"criterion_id": "G1.BUDGET_ENVELOPE",
"statement": "A budget envelope exists and is approved.",
"is_blocking": true
}Code samples
curl -X GET "$XOS_BASE_URL/canon/gate-criteria/G1.BUDGET_ENVELOPE" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.canonGateCriteria.get("G1.BUDGET_ENVELOPE");response = xos.canon_gate_criteria.get("G1.BUDGET_ENVELOPE")xos canon-gate-criteria get G1.BUDGET_ENVELOPE