Get a canon escalation index
Canon module
GET/canon/escalation-indices/{index_id}canonEscalationIndices.get
A price escalation index. Returns one canon escalation index with its `ETag`. A canon escalation index 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 |
|---|---|---|---|
| index_id | string | Yes | Index identifier.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: CanonEscalationIndex
| Field | Type | Required | Description |
|---|---|---|---|
| index_id | string | Yes | Index identifier.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
| name | string | Yes | Index name.Constraints: length 1 to 200 |
| applies_to | JurisdictionId | Yes | Jurisdiction identifier from `xpms.dim_jurisdiction`. An unpopulated jurisdiction returns no answer.Constraints: pattern ^[A-Z]{2}(-[A-Z0-9]+)*$ |
| note | string | null | Yes | Note from the Bible.Constraints: length 1 to 20000 |
{
"index_id": "BLS-CPI-U",
"name": "US CPI-U, all items",
"applies_to": "US-FL",
"note": "Default escalation basis."
}Code samples
curl -X GET "$XOS_BASE_URL/canon/escalation-indices/BLS-CPI-U" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.canonEscalationIndices.get("BLS-CPI-U");response = xos.canon_escalation_indices.get("BLS-CPI-U")xos canon-escalation-indices get BLS-CPI-U