Saltar al contenido

List measurement metric tag rows

Módulo Projects

GET/measurement-metric-tagsmeasurementMetricTags.list

A Bible sustainability tag (Bible tab 09) a sustainability figure is reported against (Section 4.10). Returns a cursor page of measurement metric tag rows the caller may see. The default order is `metric_code`, then `tag_id` 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

measurementMetricTags.list: Parámetros de ruta y de consulta
CampoTipoObligatorioDescripción
limitLimitNoPage size. Default 50, maximum 200.Restricciones: range 1 to 200
cursorCursorNoOpaque cursor from `next_cursor` of the previous page.Restricciones: length 1 to any
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_]*)*$
sortSortNoSort 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_]*)*$
filterFilterNoFilter 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 MeasurementMetricTag

measurementMetricTags.list: MeasurementMetricTag
CampoTipoObligatorioDescripción
metric_codestringSíMetric (app.measurement_metrics).Restricciones: pattern ^[a-z][a-z0-9_]*$
tag_idstringSíCanon tag code.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
tagstringSíTag value as written in canon.Restricciones: length 1 to 200
{
  "data": [
    {
      "metric_code": "waste_generated",
      "tag_id": "TAG-005",
      "tag": "REUSABLE"
    }
  ],
  "next_cursor": null
}

Ejemplos de código

curl -X GET "$XOS_BASE_URL/measurement-metric-tags" \
  -H "Authorization: Bearer $XOS_API_KEY"
for await (const row of xos.measurementMetricTags.listAll()) {
  console.log(row);
}
for row in xos.measurement_metric_tags.list_all():
    print(row)
xos measurement-metric-tags list --all