List phase coverage rows

Módulo Canon

GET/canon/phase-coveragecanonPhaseCoverage.list

Coverage of a phase: Active elements or a declared gap. Returns a cursor page of phase coverage rows the caller may see. The default order is `phase_code` ascending. 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

canonPhaseCoverage.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 PhaseCoverage

canonPhaseCoverage.list: PhaseCoverage
Campo	Tipo	Obligatorio	Descripción
phase_code	PhaseCode	Sí	Phase code from `xpms.dim_phase`, ordered by gate ordinal.Restricciones: pattern ^[A-Z]{3}$
active_element_count	integer	Sí	Active elements in the phase.Restricciones: range 0 to any
declared_gap	boolean	Sí	Whether the phase carries a declared gap.
gate	integer \| null	Sí	Gate ordinal.Restricciones: range 0 to any
phase	string \| null	Sí	Phase label.Restricciones: pattern ^[A-Z0-9][A-Za-z0-9&'/.()-]( [A-Za-z0-9&'/.()-]+)$
element_count	integer \| null	Sí	Elements participating in the phase.Restricciones: range 0 to any
category_count	integer \| null	Sí	Distinct categories among participating elements.Restricciones: range 0 to any
has_active_element	boolean \| null	Sí	True when at least one participating element is Active.
declared_gap_reason	string \| null	Sí	Why the phase has no Active element, as its declared gap states it; null without one.Restricciones: length 1 to 300

{
  "data": [
    {
      "phase_code": "SCP",
      "active_element_count": 120,
      "declared_gap": false,
      "gate": 3,
      "phase": "Advance",
      "element_count": 42,
      "category_count": 7,
      "has_active_element": true,
      "declared_gap_reason": null
    }
  ],
  "next_cursor": null
}

Ejemplos de código

curl -X GET "$XOS_BASE_URL/canon/phase-coverage" \
  -H "Authorization: Bearer $XOS_API_KEY"

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

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

xos canon-phase-coverage list --all