Resolve a URN
Canon module
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`.
- Requires the capability canon.taxonomy.read.
- OAuth scopes: canon.
- Error statuses: 400, 401, 422, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| urn | string | Yes | URN to resolve.Constraints: pattern ^urn:xpms:[a-z_]+:.+$ |
Response 200: UrnResolution
| Field | Type | Required | Description |
|---|---|---|---|
| urn | Urn | Yes | URN in the `urn:xpms` namespace.Constraints: pattern ^urn:xpms:[a-z_]+:.+$ |
| kind | string | Yes | URN kind.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
| key | string | Yes | Natural key of the row.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
| label | string | Yes | Display label of the row.Constraints: length 1 to 200 |
| resolved_key | string | Yes | Key of the live row after following supersessions.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
| is_superseded | boolean | Yes | 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
}Code samples
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