List phase coverage rows
Canon module
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.
- Requires the capability canon.taxonomy.read.
- OAuth scopes: canon.
- Cursor-paginated: limit, cursor, fields, sort and filter apply.
- Error statuses: 400, 401, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| limit | Limit | No | Page size. Default 50, maximum 200.Constraints: range 1 to 200 |
| cursor | Cursor | No | Opaque cursor from `next_cursor` of the previous page.Constraints: length 1 to any |
| 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_]*)*$ |
| 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).Constraints: 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. |
Response 200: a page of PhaseCoverage
| Field | Type | Required | Description |
|---|---|---|---|
| phase_code | PhaseCode | Yes | Phase code from `xpms.dim_phase`, ordered by gate ordinal.Constraints: pattern ^[A-Z]{3}$ |
| active_element_count | integer | Yes | Active elements in the phase.Constraints: range 0 to any |
| declared_gap | boolean | Yes | Whether the phase carries a declared gap. |
| gate | integer | null | Yes | Gate ordinal.Constraints: range 0 to any |
| phase | string | null | Yes | Phase label.Constraints: pattern ^[A-Z0-9][A-Za-z0-9&'/.()-]*( [A-Za-z0-9&'/.()-]+)*$ |
| element_count | integer | null | Yes | Elements participating in the phase.Constraints: range 0 to any |
| category_count | integer | null | Yes | Distinct categories among participating elements.Constraints: range 0 to any |
| has_active_element | boolean | null | Yes | True when at least one participating element is Active. |
| declared_gap_reason | string | null | Yes | Why the phase has no Active element, as its declared gap states it; null without one.Constraints: 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
}Code samples
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