Get a canon escalation index

Módulo Canon

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.

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

canonEscalationIndices.get: Parámetros de ruta y de consulta
Campo	Tipo	Obligatorio	Descripción
index_id	string	Sí	Index identifier.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_])*$

canonEscalationIndices.get: CanonEscalationIndex
Campo	Tipo	Obligatorio	Descripción
index_id	string	Sí	Index identifier.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
name	string	Sí	Index name.Restricciones: length 1 to 200
applies_to	JurisdictionId	Sí	Jurisdiction identifier from `xpms.dim_jurisdiction`. An unpopulated jurisdiction returns no answer.Restricciones: pattern ^[A-Z]{2}(-[A-Z0-9]+)*$
note	string \| null	Sí	Note from the Bible.Restricciones: length 1 to 20000

{
  "index_id": "BLS-CPI-U",
  "name": "US CPI-U, all items",
  "applies_to": "US-FL",
  "note": "Default escalation basis."
}

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