Saltar al contenido

Get a canon tier

Módulo Canon

GET/canon/tiers/{tier_code}canonTiers.get

A tier of experience. International is never a tier. Returns one canon tier with its `ETag`. A canon tier 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

canonTiers.get: Parámetros de ruta y de consulta
CampoTipoObligatorioDescripción
tier_codeTierCodeSíTier of experience code from `xpms.dim_tier`.Restricciones: pattern ^[0-9]{2}$
fieldsFieldsNoSparse 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_]*)*$

Respuesta 200: CanonTier

canonTiers.get: CanonTier
CampoTipoObligatorioDescripción
tier_codeTierCodeSíTier of experience code from `xpms.dim_tier`.Restricciones: pattern ^[0-9]{2}$
tierstringSíTier name.Restricciones: length 1 to 200
{
  "tier_code": "04",
  "tier": "Physical"
}

Ejemplos de código

curl -X GET "$XOS_BASE_URL/canon/tiers/04" \
  -H "Authorization: Bearer $XOS_API_KEY"
const { data, etag } = await xos.canonTiers.get("04");
response = xos.canon_tiers.get("04")
xos canon-tiers get 04