Get a canon record subtype
Canon module
GET/canon/record-subtypes/{record_subtype}canonRecordSubtypes.get
A kind-scoped record subtype. Returns one canon record subtype with its `ETag`. A canon record subtype 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_subtype | RecordSubtype | Yes | Kind-scoped record subtype from `xpms.dim_record_subtype`. A subtype of one kind cannot be stored on another.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: CanonRecordSubtype
| 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&'/.()-]+)*$ |
| record_subtype | RecordSubtype | Yes | Kind-scoped record subtype from `xpms.dim_record_subtype`. A subtype of one kind cannot be stored on another.Constraints: pattern ^[A-Z0-9][A-Za-z0-9&'/.()-]*( [A-Za-z0-9&'/.()-]+)*$ |
| unspsc_segment | string | null | Yes | UNSPSC segment code and name.Constraints: length 1 to 200 |
{
"record_kind": "Task",
"record_subtype": "Design",
"unspsc_segment": "52160000 Audio and visual equipment and accessories"
}Code samples
curl -X GET "$XOS_BASE_URL/canon/record-subtypes/Design" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.canonRecordSubtypes.get("Design");response = xos.canon_record_subtypes.get("Design")xos canon-record-subtypes get Design