List canon element rows

Canon module

GET/canon/elementscanonElements.list

A catalog element, the unit of the catalog. Returns a cursor page of canon element rows the caller may see. Coded list: the default order is numeric code order by `element_id`. Supports sparse fieldsets and the filter grammar.

Requires the capability canon.taxonomy.read.
OAuth scopes: canon.
Cursor-paginated: limit, cursor, fields, sort and filter apply.
Error statuses: 400, 401, 429. Errors are RFC 9457 problem details.

Path and query parameters

canonElements.list: Path and query parameters
Field	Type	Required	Description
limit	Limit	No	Page size. Default 50, maximum 200.Constraints: range 1 to 200
cursor	Cursor	No	Opaque cursor from `next_cursor` of the previous page.Constraints: length 1 to any
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_])*$
sort	Sort	No	Sort keys, comma-separated; a leading `-` sorts descending. Without `sort`, the documented default order applies (coded lists sort in numeric code order).Constraints: pattern ^-?[a-z_][a-z0-9_](,-?[a-z_][a-z0-9_])*$
filter	Filter	No	Filter grammar `filter[field][op]=value`. Operators: eq, ne, lt, lte, gt, gte, in (comma-separated values), is_null (true or false) and contains. Conditions combine with AND.

Response 200: a page of CanonElement

canonElements.list: 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

{
  "data": [
    {
      "element_id": "0000.51.01-XOS-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"
    },
    {
      "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"
    }
  ],
  "next_cursor": null
}

Code samples

curl -X GET "$XOS_BASE_URL/canon/elements" \
  -H "Authorization: Bearer $XOS_API_KEY"

for await (const row of xos.canonElements.listAll()) {
  console.log(row);
}

for row in xos.canon_elements.list_all():
    print(row)

xos canon-elements list --all