Get a canon tag

Módulo Canon

GET/canon/tags/{tag_id}canonTags.get

A sustainability or compliance tag. Returns one canon tag with its `ETag`. A canon tag 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

canonTags.get: Parámetros de ruta y de consulta
Campo	Tipo	Obligatorio	Descripción
tag_id	TagId	Sí	Sustainability or compliance tag from `xpms.dim_tag`.Restricciones: pattern ^TAG-[0-9]{3}$
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_])*$

canonTags.get: CanonTag
Campo	Tipo	Obligatorio	Descripción
tag_id	TagId	Sí	Sustainability or compliance tag from `xpms.dim_tag`.Restricciones: pattern ^TAG-[0-9]{3}$
tag_type	string	Sí	Tag type.Restricciones: length 1 to 200
tag	string	Sí	Tag value.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$

{
  "tag_id": "TAG-002",
  "tag_type": "Compliance",
  "tag": "OSHA"
}

curl -X GET "$XOS_BASE_URL/canon/tags/TAG-002" \
  -H "Authorization: Bearer $XOS_API_KEY"

const { data, etag } = await xos.canonTags.get("TAG-002");

response = xos.canon_tags.get("TAG-002")

xos canon-tags get TAG-002