Saltar al contenido

List project measurement correction rows

Módulo Projects

GET/project-measurement-correctionsprojectMeasurementCorrections.list

An entry of the append-only correction ledger: a figure corrected, withdrawn or restored, with the figure before and after and the reason. Who changed it and when are created_by and created_at. Returns a cursor page of project measurement correction rows the caller may see. The default order is `created_at` 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

projectMeasurementCorrections.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 ProjectMeasurementCorrection

projectMeasurementCorrections.list: ProjectMeasurementCorrection
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the project measurement correction.
org_idstring (uuid)SíIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)SíWhen the row was created.
created_bystring (uuid) | nullSíIdentifier of the person who created the row.
updated_atstring (date-time)SíWhen the row was last updated.
updated_bystring (uuid) | nullSíIdentifier of the person who last updated the row.
project_measurement_idstring (uuid)SíIdentifier of the figure that changed.
correction_kind"Corrected" | "Withdrawn" | "Restored"SíWhat changed the figure.
previous_valuenumber | nullSíValue before the change; null when Unmeasured.
previous_unit_codestring | nullSíUnit before the change.Restricciones: pattern ^[a-z][a-z0-9_]*$
previous_measured_onstring (date)SíDay before the change.
valuenumber | nullSíValue after the change; null when Unmeasured.
unit_codestring | nullSíUnit after the change.Restricciones: pattern ^[a-z][a-z0-9_]*$
measured_onstring (date)SíDay after the change.
reasonstring | nullSíWhy the figure changed.Restricciones: length 1 to 500
{
  "data": [
    {
      "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "created_at": "2026-10-08T14:30:00Z",
      "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "updated_at": "2026-10-08T14:30:00Z",
      "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "project_measurement_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "correction_kind": "Corrected",
      "previous_value": 1200,
      "previous_unit_code": "kg",
      "previous_measured_on": "2026-10-08",
      "value": 1.25,
      "unit_code": "kg",
      "measured_on": "2026-10-08",
      "reason": "Weighbridge ticket supersedes the estimate."
    }
  ],
  "next_cursor": null
}

Ejemplos de código

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