Get a canon urn namespace
Módulo Canon
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.
- Requiere la capacidad canon.taxonomy.read.
- Alcances de OAuth: canon.
- Estados de error: 400, 401, 404, 429. Los errores son detalles de problema RFC 9457.
Parámetros de ruta y de consulta
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| kind | string | Sí | URN kind.Restricciones: 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.Restricciones: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$ |
Respuesta 200: CanonUrnNamespace
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| kind | string | Sí | URN kind.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
| table_name | string | Sí | xpms table holding the kind.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
| key_column | string | Sí | Natural key column of that table.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
| label_column | string | Sí | Column holding the display label.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
{
"kind": "category",
"table_name": "elements",
"key_column": "element_id",
"label_column": "item"
}Ejemplos de código
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