Saltar al contenido

List canon supersession rows

Módulo Canon

GET/canon/supersessionscanonSupersessions.list

A supersession edge. The graph stays acyclic. Returns a cursor page of canon supersession rows the caller may see. The default order is `domain`, then `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

canonSupersessions.list: Parámetros de ruta y de consulta
CampoTipoObligatorioDescripción
limitLimitNoPage size. Default 50, maximum 200.Restricciones: range 1 to 200
cursorCursorNoOpaque cursor from `next_cursor` of the previous page.Restricciones: length 1 to any
fieldsFieldsNoSparse 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_]*)*$
sortSortNoSort 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_]*)*$
filterFilterNoFilter 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 CanonSupersession

canonSupersessions.list: CanonSupersession
CampoTipoObligatorioDescripción
codestringSíCode that was superseded.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
successor_codestringSíCode that supersedes it.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
domainstringSíCode domain, such as phase.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
labelstringSíLabel the superseded code carried.Restricciones: length 1 to 300
reasonstringSíWhy the code was superseded.Restricciones: length 1 to 2000
{
  "data": [
    {
      "code": "DIS",
      "successor_code": "SCP",
      "domain": "phase",
      "label": "Discovery",
      "reason": "Renamed in 4.0."
    }
  ],
  "next_cursor": null
}

Ejemplos de código

curl -X GET "$XOS_BASE_URL/canon/supersessions" \
  -H "Authorization: Bearer $XOS_API_KEY"
for await (const row of xos.canonSupersessions.listAll()) {
  console.log(row);
}
for row in xos.canon_supersessions.list_all():
    print(row)
xos canon-supersessions list --all