Get a canon touchpoint
Canon module
GET/canon/touchpoints/{touchpoint_id}canonTouchpoints.get
A five-sense touchpoint with Base, Elevated and Premium grades. Returns one canon touchpoint with its `ETag`. A canon touchpoint 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 |
|---|---|---|---|
| touchpoint_id | TouchpointId | Yes | Five-sense touchpoint identifier from `xpms.dim_touchpoint`.Constraints: pattern ^[A-Z]{3}-[0-9]{2}$ |
| 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: CanonTouchpoint
| Field | Type | Required | Description |
|---|---|---|---|
| touchpoint_id | TouchpointId | Yes | Five-sense touchpoint identifier from `xpms.dim_touchpoint`.Constraints: pattern ^[A-Z]{3}-[0-9]{2}$ |
| sense | string | Yes | Sense the touchpoint addresses.Constraints: length 1 to 200 |
| brief_element | string | Yes | Brief element.Constraints: length 1 to 200 |
| category | string | Yes | Touchpoint category.Constraints: length 1 to 200 |
| item | string | Yes | Touchpoint item.Constraints: length 1 to 200 |
| base | string | Yes | Base grade description.Constraints: length 1 to 20000 |
| elevated | string | Yes | Elevated grade description.Constraints: length 1 to 20000 |
| premium | string | Yes | Premium grade description.Constraints: length 1 to 20000 |
| optional_upgrades | string | null | Yes | Optional upgrades.Constraints: length 1 to 20000 |
{
"touchpoint_id": "SGT-01",
"sense": "Architecture (Sight)",
"brief_element": "Floor Plan",
"category": "Stage Configuration",
"item": "Ground-Level Stage",
"base": "Low-rise deck stage.",
"elevated": "Deck stage with skirted fascia.",
"premium": "Custom-fabricated floor stage.",
"optional_upgrades": "Stage-front lighting ribbon."
}Code samples
curl -X GET "$XOS_BASE_URL/canon/touchpoints/SGT-01" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.canonTouchpoints.get("SGT-01");response = xos.canon_touchpoints.get("SGT-01")xos canon-touchpoints get SGT-01