List canon grain rows

Módulo Canon

GET/canon/grainscanonGrains.list

Grain: class, unit or lot (Section 3.9). Returns a cursor page of canon grain rows the caller may see. The default order is `grain` 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

canonGrains.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 CanonGrain

canonGrains.list: CanonGrain
Campo	Tipo	Obligatorio	Descripción
grain	GrainCode	Sí	Grain from `xpms.dim_grain` (Section 3.9).Restricciones: pattern ^[a-z]+$
counts	string	Sí	What it counts.Restricciones: length 1 to 300
identified_by	string	Sí	How it is identified.Restricciones: length 1 to 300
answers	string	Sí	What it answers.Restricciones: length 1 to 300
note	string \| null	Sí	Note from the Bible.Restricciones: length 1 to 20000

{
  "data": [
    {
      "grain": "unit",
      "counts": "One physical thing",
      "identified_by": "Serial or asset tag",
      "answers": "Where is this one?",
      "note": "Tracked individually."
    }
  ],
  "next_cursor": null
}

Ejemplos de código

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

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

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

xos canon-grains list --all