List canon tag rows

Módulo Canon

GET/canon/tagscanonTags.list

A sustainability or compliance tag. Returns a cursor page of canon tag rows the caller may see. Coded list: the default order is numeric code order by `tag_id`. Supports sparse fieldsets and the filter grammar.

Requiere la capacidad canon.taxonomy.read.
Alcances de OAuth: canon.
Paginación por cursor: se aplican limit, cursor, fields, sort y filter.
Estados de error: 400, 401, 429. Los errores son detalles de problema RFC 9457.

Parámetros de ruta y de consulta

canonTags.list: Parámetros de ruta y de consulta
Campo	Tipo	Obligatorio	Descripción
limit	Limit	No	Page size. Default 50, maximum 200.Restricciones: range 1 to 200
cursor	Cursor	No	Opaque cursor from `next_cursor` of the previous page.Restricciones: length 1 to any
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_])*$
sort	Sort	No	Sort keys, comma-separated; a leading `-` sorts descending. Without `sort`, the documented default order applies (coded lists sort in numeric code order).Restricciones: pattern ^-?[a-z_][a-z0-9_](,-?[a-z_][a-z0-9_])*$
filter	Filter	No	Filter grammar `filter[field][op]=value`. Operators: eq, ne, lt, lte, gt, gte, in (comma-separated values), is_null (true or false) and contains. Conditions combine with AND.

Respuesta 200: una página de CanonTag

canonTags.list: 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}$

{
  "data": [
    {
      "tag_id": "TAG-001",
      "tag_type": "Sustainability",
      "tag": "ELECTRIC"
    },
    {
      "tag_id": "TAG-002",
      "tag_type": "Compliance",
      "tag": "OSHA"
    }
  ],
  "next_cursor": null
}

Ejemplos de código

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

for await (const row of xos.canonTags.listAll()) {
  console.log(row);
}

for row in xos.canon_tags.list_all():
    print(row)

xos canon-tags list --all