FUfulcrumpro
Tool Calibration

Edit an unsigned tool calibration record. A full replacement: the submitted measurements replace the record's response set wholesale and the result is re-derived against the record's pinned template version. Signed records are immutable and reject every edit. The request must round-trip the version token from a read of the record; a stale token is rejected with 409.

Changed on
put/api/tool-calibrations/{id}

Request

  • Base URL
    https://api.fulcrumpro.com
  • URL
    https://api.fulcrumpro.com/api/tool-calibrations/{id}
  • Auth
    none declared

Path parameters

idstring required

Request body

toolIdstring required

The id of the tool the calibration was performed on

calibrationSource'user' | 'vendor' | 'customer' required

Who performed the calibration. Mirrors FulcrumProduct.Domain.ToolCalibrations.CalibrationSource by underlying value.

calibratedByUserIdstring nullable

The user who performed an in-house calibration; required for (and only valid with) the user source

calibratedByVendorIdstring nullable

The vendor that performed an external calibration; required for (and only valid with) the vendor source

result'fail' | 'pass' | 'notApplicable' required

The outcome of a calibration. Mirrors FulcrumProduct.Domain.ToolCalibrations.Data.CalibrationResult by underlying value.

calibrationDateUtcstring date-time required

When the calibration was performed (UTC)

masterGageNamesstring nullable

Free-text master gauge names supplied with an external attestation; a measured in-house calibration derives its masters from the template instead

certificateNumberstring nullable

The external certificate number supplied with the calibration

notesstring nullable

Free-text notes

asFoundNotesstring nullable

Free-text notes about the As-Found state

tempDegCnumber double nullable

Ambient temperature (deg C) captured during calibration

relHumiditynumber double nullable

Ambient relative humidity (%) captured during calibration

versionstring required

The record's opaque concurrency token from a read of this record, round-tripped unchanged. The edit is rejected with 409 Conflict when the record changed after that read

Response

The updated calibration record, with its derived results and refreshed concurrency token

idstring nullable

The id of the calibration record

calibrationSource'user' | 'vendor' | 'customer'

Who performed the calibration. Mirrors FulcrumProduct.Domain.ToolCalibrations.CalibrationSource by underlying value.

result'fail' | 'pass' | 'notApplicable'

The outcome of a calibration. Mirrors FulcrumProduct.Domain.ToolCalibrations.Data.CalibrationResult by underlying value.

asFoundResult'fail' | 'pass' | 'notApplicable'

The outcome of a calibration. Mirrors FulcrumProduct.Domain.ToolCalibrations.Data.CalibrationResult by underlying value.

calibrationDateUtcstring date-time nullable

When the calibration was performed (UTC)

masterGageNamesstring nullable

Display labels of the master gauges used: the masters the record's measurements were taken against for in-house records, or the free-text value supplied with an external record

certificateNumberstring nullable

The external certificate number supplied with the calibration

notesstring nullable

Free-text notes

asFoundNotesstring nullable

Free-text notes about the As-Found state

tempDegCnumber double nullable

Ambient temperature (deg C) captured during calibration

relHumiditynumber double nullable

Ambient relative humidity (%) captured during calibration

templateVersioninteger nullable

The template version the record was measured against, pinned at create time; null for template-less and external records

signedUtcstring date-time nullable

When the record was signed (UTC); null until signed

versionstring nullable

The record's opaque concurrency token, refreshed by every write. Round-trip it unchanged on an edit; the edit is rejected with 409 Conflict when the record changed after this read

Changes

  • c3bdc499d639Revision changes
    • breaking

      the request property's minLength was increased from 0 to 1 (media type: application/json-patch+json)

    • breaking

      the request property's minLength was increased from 0 to 1 (media type: application/json)

    • breaking

      the request property's minLength was increased from 0 to 1 (media type: text/json)

    • breaking

      the request property's minLength was increased from 0 to 1 (media type: application/*+json)

  • 6fc46fb4f45bRevision changes
    • info

      endpoint added