Resolve a URN

Módulo Canon

GET/canon/urns/resolvecanonUrns.resolve

Resolves a `urn:xpms` URN to its canon row through `xpms.urn_resolve`. An unknown URN returns a 422 `NO_ANSWER` refusal. A rule that refuses the request returns 422 with `refusal` and `reason`.

Requiere la capacidad canon.taxonomy.read.
Alcances de OAuth: canon.
Estados de error: 400, 401, 422, 429. Los errores son detalles de problema RFC 9457.

Parámetros de ruta y de consulta

canonUrns.resolve: Parámetros de ruta y de consulta
Campo	Tipo	Obligatorio	Descripción
urn	string	Sí	URN to resolve.Restricciones: pattern ^urn:xpms:[a-z_]+:.+$

Respuesta 200: UrnResolution

canonUrns.resolve: UrnResolution
Campo	Tipo	Obligatorio	Descripción
urn	Urn	Sí	URN in the `urn:xpms` namespace.Restricciones: pattern ^urn:xpms:[a-z_]+:.+$
kind	string	Sí	URN kind.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
key	string	Sí	Natural key of the row.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
label	string	Sí	Display label of the row.Restricciones: length 1 to 200
resolved_key	string	Sí	Key of the live row after following supersessions.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
is_superseded	boolean	Sí	Whether the asked key was superseded.

{
  "urn": "urn:xpms:category:4000.01.01",
  "kind": "category",
  "key": "4000.01.01",
  "label": "Production Leadership",
  "resolved_key": "SCP",
  "is_superseded": false
}

Ejemplos de código

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

const { data } = await xos.canonUrns.resolve();

response = xos.canon_urns.resolve()

xos canon-urns resolve