Get a canon record kind
Canon module
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.
- Requires the capability canon.taxonomy.read.
- OAuth scopes: canon.
- Error statuses: 400, 401, 404, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| record_kind | RecordKind | Yes | Record kind from `xpms.dim_record_kind` (26 kinds, Section 3.10).Constraints: 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.Constraints: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$ |
Response 200: CanonRecordKind
| Field | Type | Required | Description |
|---|---|---|---|
| record_kind | RecordKind | Yes | Record kind from `xpms.dim_record_kind` (26 kinds, Section 3.10).Constraints: pattern ^[A-Z0-9][A-Za-z0-9&'/.()-]*( [A-Za-z0-9&'/.()-]+)*$ |
| definition | string | Yes | Definition, in sentence case.Constraints: length 1 to 20000 |
| definition_of_done | string | Yes | Definition of done.Constraints: length 1 to 20000 |
| record_class | RecordClass | Yes | Record class from `xpms.dim_record_kind`, derived from the kind.Constraints: pattern ^[A-Z0-9][A-Za-z0-9&'/.()-]*( [A-Za-z0-9&'/.()-]+)*$ |
| title_grammar | string | Yes | Title grammar validated on write.Constraints: 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."
}Code samples
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