List canon provenance rows

Módulo Canon

GET/canon/provenancescanonProvenances.list

A provenance rank. A lower rank never overwrites a populated higher-rank field. Returns a cursor page of canon provenance rows the caller may see. The default order is `provenance` 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

canonProvenances.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 CanonProvenance

canonProvenances.list: CanonProvenance
Campo	Tipo	Obligatorio	Descripción
provenance	Provenance	Sí	Provenance from `xpms.dim_provenance` (Section 3.8); a lower rank never overwrites a higher one.Restricciones: pattern ^[a-z]+$
rank	integer	Sí	Rank, higher wins.Restricciones: range 0 to any
definition	string	Sí	Definition, in sentence case.Restricciones: length 1 to 20000
may_overwrite	string	Sí	What this provenance may overwrite.Restricciones: length 1 to 300
max_confidence	AssertionLabel	Sí	Assertion label from `xpms.dim_assertion_rank` (Section 3.8).Restricciones: pattern ^[A-Z]+$

{
  "data": [
    {
      "provenance": "operator",
      "rank": 80,
      "definition": "A tenant human entering a fact.",
      "may_overwrite": "Any field not canon-locked",
      "max_confidence": "QUOTED"
    }
  ],
  "next_cursor": null
}

Ejemplos de código

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

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

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

xos canon-provenances list --all