Get a canon assertion rank
Canon module
GET/canon/assertion-ranks/{rank}canonAssertionRanks.get
An assertion rank, 4 down to 0, across economics, compliance and capability. Returns one canon assertion rank with its `ETag`. A canon assertion rank 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 |
|---|---|---|---|
| rank | integer | Yes | Assertion rank.Constraints: range 0 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_]*)*$ |
Response 200: CanonAssertionRank
| Field | Type | Required | Description |
|---|---|---|---|
| rank | integer | Yes | Assertion rank.Constraints: range 0 to any |
| meaning | string | Yes | Meaning of the rank.Constraints: length 1 to 20000 |
| note | string | null | Yes | Note from the Bible.Constraints: length 1 to 20000 |
{
"rank": 4,
"meaning": "Attested by a named accountable party.",
"note": "A vendor quote."
}Code samples
curl -X GET "$XOS_BASE_URL/canon/assertion-ranks/4" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.canonAssertionRanks.get("4");response = xos.canon_assertion_ranks.get("4")xos canon-assertion-ranks get 4