List coordinate matrix cell rows
Canon module
GET/canon/coordinate-matrixcanonCoordinateMatrix.list
One of 90 coordinates: a department by a phase, counting participation. Returns a cursor page of coordinate matrix cell rows the caller may see. Coded list: the default order is numeric code order by `dept_code`, then `phase_code`. 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 CoordinateMatrixCell
| Field | Type | Required | Description |
|---|---|---|---|
| dept_code | DeptCode | Yes | Department class code from `xpms.dim_department` (Section 3.2).Constraints: pattern ^[0-9]000$ |
| phase_code | PhaseCode | Yes | Phase code from `xpms.dim_phase`, ordered by gate ordinal.Constraints: pattern ^[A-Z]{3}$ |
| element_count | integer | Yes | Elements participating at the coordinate.Constraints: range 0 to any |
{
"data": [
{
"dept_code": "0000",
"phase_code": "SCP",
"element_count": 42
},
{
"dept_code": "1000",
"phase_code": "SCP",
"element_count": 42
}
],
"next_cursor": null
}Code samples
curl -X GET "$XOS_BASE_URL/canon/coordinate-matrix" \
-H "Authorization: Bearer $XOS_API_KEY"for await (const row of xos.canonCoordinateMatrix.listAll()) {
console.log(row);
}for row in xos.canon_coordinate_matrix.list_all():
print(row)xos canon-coordinate-matrix list --all