List canon region rows

Módulo Canon

GET/canon/regionscanonRegions.list

A cost region. Only ratified multipliers answer; others refuse. Returns a cursor page of canon region rows the caller may see. The default order is `region_code` ascending. 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

canonRegions.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 CanonRegion

canonRegions.list: CanonRegion
Campo	Tipo	Obligatorio	Descripción
region_code	RegionCode	Sí	Cost region code from `xpms.dim_region`.Restricciones: pattern ^[A-Z]{2}(-[A-Z0-9]+)+$
name	string	Sí	Region name.Restricciones: length 1 to 200
jurisdiction_id	JurisdictionId	Sí	Jurisdiction identifier from `xpms.dim_jurisdiction`. An unpopulated jurisdiction returns no answer.Restricciones: pattern ^[A-Z]{2}(-[A-Z0-9]+)*$
currency_code	string	Sí	Currency of the region.Restricciones: pattern ^[A-Z]{3}$
note	string \| null	Sí	Note from the Bible.Restricciones: length 1 to 20000

{
  "data": [
    {
      "region_code": "NA-SE-MIA",
      "name": "Miami and South Florida",
      "jurisdiction_id": "US-FL",
      "currency_code": "USD",
      "note": "Basis region."
    }
  ],
  "next_cursor": null
}

Ejemplos de código

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

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

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

xos canon-regions list --all