List canon discipline team rows
Módulo Canon
GET/canon/discipline-teamscanonDisciplineTeams.list
A canon team that works in a discipline. Returns a cursor page of canon discipline team rows the caller may see. The default order is `disc_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
| 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 CanonDisciplineTeam
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| disc_code | DiscCode | Sí | Discipline code `DDDD.DD` from `xpms.dim_discipline`. Canon holds .01 to .49; tenant extensions hold .50 to .99.Restricciones: pattern ^[0-9]000\.[0-9]{2}$ |
| team_id | TeamId | Sí | Canon team identifier from `xpms.dim_team`.Restricciones: pattern ^[0-9]000-T[0-9]{2}$ |
{
"data": [
{
"disc_code": "4000.01",
"team_id": "4000-T01"
}
],
"next_cursor": null
}Ejemplos de código
curl -X GET "$XOS_BASE_URL/canon/discipline-teams" \
-H "Authorization: Bearer $XOS_API_KEY"for await (const row of xos.canonDisciplineTeams.listAll()) {
console.log(row);
}for row in xos.canon_discipline_teams.list_all():
print(row)xos canon-discipline-teams list --all