v2

latestOpenAPI 3.0.42026-08-084694591.6 MB
Tool Calibration

Record a tool calibration: an external (vendor or customer) attestation, or an in-house calibration with per-checkpoint measurements against the tool's current calibration template. The server derives the result from the measurements and rejects a submitted result that disagrees; reference gages never take calibration records. A save recording a failure automatically opens an NCR, echoed as createdNcr. Creates are not idempotent: a retried request records a second calibration (and opens a second NCR on a failure) — list the tool's records before re-sending after a timeout.

post/api/tool-calibrations

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

Response

The created calibration record, with its derived results and 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