Get a canon urn namespace
Canon module
GET/canon/urn-namespaces/{kind}canonUrnNamespaces.get
A URN kind under `urn:xpms`. Returns one canon urn namespace with its `ETag`. A canon urn namespace 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 |
|---|---|---|---|
| kind | string | Yes | URN kind.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
| 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: 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}$ |
{
"kind": "category",
"table_name": "elements",
"key_column": "element_id",
"label_column": "item"
}Code samples
curl -X GET "$XOS_BASE_URL/canon/urn-namespaces/category" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.canonUrnNamespaces.get("category");response = xos.canon_urn_namespaces.get("category")xos canon-urn-namespaces get category