Get a canon element
Canon module
GET/canon/elements/{element_id}canonElements.get
A catalog element, the unit of the catalog. Returns one canon element with its `ETag`. A canon element 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 |
|---|---|---|---|
| element_id | ItemId | Yes | Catalog item identifier `{URID}-{ORG}-{SEQ}` (Section 3.6).Constraints: pattern ^[0-9]000\.[0-9]{2}\.[0-9]{2}-[A-Z0-9]+-[0-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: CanonElement
| Field | Type | Required | Description |
|---|---|---|---|
| element_id | ItemId | Yes | Catalog item identifier `{URID}-{ORG}-{SEQ}` (Section 3.6).Constraints: pattern ^[0-9]000\.[0-9]{2}\.[0-9]{2}-[A-Z0-9]+-[0-9]+$ |
| urid | Urid | Yes | Category URID `DDDD.DD.DD` from `xpms.dim_category` (Section 3.3). There is no fourth segment.Constraints: pattern ^[0-9]000\.[0-9]{2}\.[0-9]{2}$ |
| item | string | Yes | Element name.Constraints: length 1 to 200 |
| common_name | string | null | Yes | Common name.Constraints: length 1 to 200 |
| kind | string | Yes | Element kind.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
| unit_basis | string | Yes | Unit basis of the element.Constraints: length 1 to 64 |
| xyz | Xyz | Yes | XYZ schema-family tag (Section 3.6): X Resource, Y Process, Z Timeline.Constraints: pattern ^[XYZ]$ |
| xyz_basis | string | Yes | Basis for the XYZ tag.Constraints: length 1 to 300 |
| grade | string | Yes | Experience grade of the element: Standard, Base, Elevated or Premium.Constraints: pattern ^[A-Z0-9][A-Za-z0-9&'/.()-]*( [A-Za-z0-9&'/.()-]+)*$ |
| description | string | null | Yes | Description, sentence case.Constraints: length 1 to 4000 |
| specification | string | null | Yes | Specification.Constraints: length 1 to 4000 |
| tier_code | TierCode | Yes | Tier of experience code from `xpms.dim_tier`.Constraints: pattern ^[0-9]{2}$ |
| lead_time_hours | number | null | Yes | Lead time in hours. |
| crew | string | null | Yes | Crew the element needs.Constraints: length 1 to 300 |
| unspsc | string | null | Yes | UNSPSC identifier; recorded, never minted.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
| lifecycle_state | string | Yes | Lifecycle state from the shared vocabulary.Constraints: pattern ^[A-Z0-9][A-Za-z0-9&'/.()-]*( [A-Za-z0-9&'/.()-]+)*$ |
| purchase_account | GlAccountCode | null | Yes | |
| default_cost_center | string | null | Yes | Default cost center (dimension 1) of the element.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
| external_ref | string | null | Yes | External reference of the element.Constraints: length 1 to 200 |
{
"element_id": "4000.01.01-XPMS-001",
"urid": "4000.01.01",
"item": "Ground Stage Deck",
"common_name": "Stage deck",
"kind": "rental",
"unit_basis": "ea",
"xyz": "X",
"xyz_basis": "Physical inventory",
"grade": "Standard",
"description": "Line array for outdoor stages.",
"specification": "12 cabinets per side.",
"tier_code": "04",
"lead_time_hours": 48,
"crew": "2 audio technicians",
"unspsc": "52161512",
"lifecycle_state": "Active",
"purchase_account": "5400",
"default_cost_center": "CC-CORP",
"external_ref": "TECH-VIDO-CAMR-001 · 5000.050.00"
}Code samples
curl -X GET "$XOS_BASE_URL/canon/elements/4000.01.01-XPMS-001" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.canonElements.get("4000.01.01-XPMS-001");response = xos.canon_elements.get("4000.01.01-XPMS-001")xos canon-elements get 4000.01.01-XPMS-001