List canon record kind rows

Módulo Canon

GET/canon/record-kindscanonRecordKinds.list

A record kind with its class, definition of done and title grammar. Returns a cursor page of canon record kind rows the caller may see. The default order is `record_kind` 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

canonRecordKinds.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 CanonRecordKind

canonRecordKinds.list: CanonRecordKind
Campo	Tipo	Obligatorio	Descripción
record_kind	RecordKind	Sí	Record kind from `xpms.dim_record_kind` (26 kinds, Section 3.10).Restricciones: pattern ^[A-Z0-9][A-Za-z0-9&'/.()-]( [A-Za-z0-9&'/.()-]+)$
definition	string	Sí	Definition, in sentence case.Restricciones: length 1 to 20000
definition_of_done	string	Sí	Definition of done.Restricciones: length 1 to 20000
record_class	RecordClass	Sí	Record class from `xpms.dim_record_kind`, derived from the kind.Restricciones: pattern ^[A-Z0-9][A-Za-z0-9&'/.()-]( [A-Za-z0-9&'/.()-]+)$
title_grammar	string	Sí	Title grammar validated on write.Restricciones: length 1 to 20000

{
  "data": [
    {
      "record_kind": "Task",
      "definition": "A unit of assigned work.",
      "definition_of_done": "Done against its acceptance.",
      "record_class": "Work",
      "title_grammar": "Imperative verb first."
    }
  ],
  "next_cursor": null
}

Ejemplos de código

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

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

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

xos canon-record-kinds list --all