Skip to content

Get a project measurement correction

Projects module

GET/project-measurement-corrections/{id}projectMeasurementCorrections.get

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 one project measurement correction with its `ETag`. A project measurement correction the caller may not see returns 404.

  • Requires the capability projects.gate.read.
  • OAuth scopes: projects.
  • Error statuses: 400, 401, 404, 429. Errors are RFC 9457 problem details.

Path and query parameters

projectMeasurementCorrections.get: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the project measurement correction.
fieldsFieldsNoSparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Constraints: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$

Response 200: ProjectMeasurementCorrection

projectMeasurementCorrections.get: ProjectMeasurementCorrection
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the project measurement correction.
org_idstring (uuid)YesIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)YesWhen the row was created.
created_bystring (uuid) | nullYesIdentifier of the person who created the row.
updated_atstring (date-time)YesWhen the row was last updated.
updated_bystring (uuid) | nullYesIdentifier of the person who last updated the row.
project_measurement_idstring (uuid)YesIdentifier of the figure that changed.
correction_kind"Corrected" | "Withdrawn" | "Restored"YesWhat changed the figure.
previous_valuenumber | nullYesValue before the change; null when Unmeasured.
previous_unit_codestring | nullYesUnit before the change.Constraints: pattern ^[a-z][a-z0-9_]*$
previous_measured_onstring (date)YesDay before the change.
valuenumber | nullYesValue after the change; null when Unmeasured.
unit_codestring | nullYesUnit after the change.Constraints: pattern ^[a-z][a-z0-9_]*$
measured_onstring (date)YesDay after the change.
reasonstring | nullYesWhy the figure changed.Constraints: length 1 to 500
{
  "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."
}

Code samples

curl -X GET "$XOS_BASE_URL/project-measurement-corrections/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY"
const { data, etag } = await xos.projectMeasurementCorrections.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");
response = xos.project_measurement_corrections.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")
xos project-measurement-corrections get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f