List measurement unit rows

Módulo Projects

GET/measurement-unitsmeasurementUnits.list

A unit a figure or objective is entered in, with its exact factor to the base unit of its dimension and whether reports show the dimension in it for metric or imperial readers. Returns a cursor page of measurement unit rows the caller may see. The default order is `ordinal` ascending. Supports sparse fieldsets and the filter grammar.

Requiere la capacidad projects.gate.read.
Alcances de OAuth: projects.
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

measurementUnits.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 MeasurementUnit

measurementUnits.list: MeasurementUnit
Campo	Tipo	Obligatorio	Descripción
unit_code	string	Sí	Unit code.Restricciones: pattern ^[a-z][a-z0-9_]*$
dimension	"Mass" \| "Volume" \| "Energy" \| "Emissions" \| "Count" \| "Percent"	Sí	Dimension of the unit.
factor_to_base	number	Sí	Base units in one of this unit.
unit_system	"Metric" \| "Imperial" \| "Either"	Sí	Measurement system of the unit.
is_display	boolean	Sí	True for the unit reports show the dimension in for readers of its system.
ordinal	integer	Sí	Display order.Restricciones: range 1 to any

{
  "data": [
    {
      "unit_code": "kg",
      "dimension": "Mass",
      "factor_to_base": 0.45359237,
      "unit_system": "Imperial",
      "is_display": true,
      "ordinal": 3
    }
  ],
  "next_cursor": null
}

Ejemplos de código

curl -X GET "$XOS_BASE_URL/measurement-units" \
  -H "Authorization: Bearer $XOS_API_KEY"

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

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

xos measurement-units list --all