List canon gate criterion rows

Módulo Canon

GET/canon/gate-criteriacanonGateCriteria.list

A gate criterion. Blocking criteria stop the gate transition in the database. Returns a cursor page of canon gate criterion rows the caller may see. Coded list: the default order is numeric code order by `gate`, then `criterion_id`. Supports sparse fieldsets and the filter grammar.

Requiere la capacidad canon.taxonomy.read.
Alcances de OAuth: canon.
Paginación por cursor: se aplican limit, cursor, fields, sort y filter.
Estados de error: 400, 401, 429. Los errores son detalles de problema RFC 9457.

Parámetros de ruta y de consulta

canonGateCriteria.list: Parámetros de ruta y de consulta
Campo	Tipo	Obligatorio	Descripción
limit	Limit	No	Page size. Default 50, maximum 200.Restricciones: range 1 to 200
cursor	Cursor	No	Opaque cursor from `next_cursor` of the previous page.Restricciones: length 1 to any
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_])*$
sort	Sort	No	Sort keys, comma-separated; a leading `-` sorts descending. Without `sort`, the documented default order applies (coded lists sort in numeric code order).Restricciones: pattern ^-?[a-z_][a-z0-9_](,-?[a-z_][a-z0-9_])*$
filter	Filter	No	Filter grammar `filter[field][op]=value`. Operators: eq, ne, lt, lte, gt, gte, in (comma-separated values), is_null (true or false) and contains. Conditions combine with AND.

Respuesta 200: una página de CanonGateCriterion

canonGateCriteria.list: CanonGateCriterion
Campo	Tipo	Obligatorio	Descripción
gate	integer	Sí	Gate ordinal.Restricciones: range 1 to any
criterion_id	CriterionId	Sí	Gate criterion identifier from `xpms.dim_gate_criterion`.Restricciones: pattern ^G[1-9]\.[A-Z0-9_]+$
statement	string	Sí	Criterion statement.Restricciones: length 1 to 20000
is_blocking	boolean	Sí	Whether the criterion blocks the gate.

{
  "data": [
    {
      "gate": 1,
      "criterion_id": "G1.BUDGET_ENVELOPE",
      "statement": "A budget envelope exists and is approved.",
      "is_blocking": true
    },
    {
      "gate": 2,
      "criterion_id": "G2.CONTRACTS",
      "statement": "A budget envelope exists and is approved.",
      "is_blocking": true
    }
  ],
  "next_cursor": null
}

Ejemplos de código

curl -X GET "$XOS_BASE_URL/canon/gate-criteria" \
  -H "Authorization: Bearer $XOS_API_KEY"

for await (const row of xos.canonGateCriteria.listAll()) {
  console.log(row);
}

for row in xos.canon_gate_criteria.list_all():
    print(row)

xos canon-gate-criteria list --all