Get a canon record kind

Módulo Canon

GET/canon/record-kinds/{record_kind}canonRecordKinds.get

A record kind with its class, definition of done and title grammar. Returns one canon record kind with its `ETag`. A canon record kind the caller may not see returns 404.

Requiere la capacidad canon.taxonomy.read.
Alcances de OAuth: canon.
Estados de error: 400, 401, 404, 429. Los errores son detalles de problema RFC 9457.

Parámetros de ruta y de consulta

canonRecordKinds.get: Parámetros de ruta y de consulta
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&'/.()-]+)$
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_])*$

Respuesta 200: CanonRecordKind

canonRecordKinds.get: 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

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

Ejemplos de código

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

const { data, etag } = await xos.canonRecordKinds.get("Task");

response = xos.canon_record_kinds.get("Task")

xos canon-record-kinds get Task