List canon urn namespace rows

Canon module

GET/canon/urn-namespacescanonUrnNamespaces.list

A URN kind under `urn:xpms`. Returns a cursor page of canon urn namespace rows the caller may see. The default order is `kind` ascending. 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

canonUrnNamespaces.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 CanonUrnNamespace

canonUrnNamespaces.list: CanonUrnNamespace
Field	Type	Required	Description
kind	string	Yes	URN kind.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
table_name	string	Yes	xpms table holding the kind.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
key_column	string	Yes	Natural key column of that table.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
label_column	string	Yes	Column holding the display label.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$

{
  "data": [
    {
      "kind": "category",
      "table_name": "elements",
      "key_column": "element_id",
      "label_column": "item"
    }
  ],
  "next_cursor": null
}

Code samples

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

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

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

xos canon-urn-namespaces list --all