TRANXACT.AI Help

Manufacturing · Measurement & Traceability

Gauges

A measurement taken with an out-of-calibration gauge is not a measurement — and every result since the last good calibration is in question.

Type REST7 operationsBase path /api/mfg/gaugesPublished as /api/v1/gauges

Download specification (OpenAPI 3.1) Screen: Gauges

Overview

PackageManufacturing
AuthenticationBearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key
AuthorizationThe caller's roles must hold Manufacturing › Gauges on the Roles screen: display for GET, add for POST, change for PUT, delete for DELETE; an action needs the grant of the button that runs it on the screen.
Tablemfg.gauges · kept per company (and organisational unit where it has one)
RecordCreated, changed and (where the screen allows) deleted; key id
RulesThe same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail.

API reference

7 operations. Open one for its parameters, bodies, responses and a sample request.

GET/api/mfg/gaugesList gauges

Query parameters

NameDescriptionExample
limitRows per page (50 by default, at most 200)limit=100
offsetRows to skipoffset=200
qFree-text search over the search columnsq=acme
sortcolumn:asc or column:desc, several separated by commassort=created_at:desc
filterA JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sortedfilter={"col":"status","op":"eq","value":"open"}
<field>=<value>Shorthand for "field is value" 

Response 200

{
  "rows": [
    {
      "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "gauge_no": "GAU-000001",
      "name": "Example",
      "gauge_type": "text",
      "manufacturer": "text",
      "model": "text",
      "serial_no": "SER-000001",
      "work_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "equipment_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "custodian_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "location_text": "text",
      "range_min": "1250.00",
      "range_max": "1250.00"
    }
  ],
  "count": 1
}

Sample request

curl "https://demo.tranxact.ai/api/mfg/gauges?limit=20" \
  -H "Authorization: Bearer $TOKEN"
GET/api/mfg/gauges/{id}Read one gauge

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "gauge_no": "GAU-000001",
  "name": "Example",
  "gauge_type": "text",
  "manufacturer": "text",
  "model": "text",
  "serial_no": "SER-000001",
  "work_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "equipment_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "custodian_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "location_text": "text",
  "range_min": "1250.00",
  "range_max": "1250.00"
}

404 when no record with that id is visible to the caller.

Sample request

curl "https://demo.tranxact.ai/api/mfg/gauges/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/mfg/gaugesCreate a gauge

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
nametextYesName
gauge_typetextNoType — Caliper, CMM, torque wrench, scale…
manufacturertextNoManufacturer
modeltextNoModel
serial_notextNoSerial number
work_center_iduuidNoWork center
equipment_iduuidNoMachine
custodian_iduuidNoCustodian
location_texttextNoWhere it is kept
range_minnumericNoRange minimum
range_maxnumericNoRange maximum
resolutionnumericNoResolution
uomtextNoUnit
accuracytextNoAccuracy
calibration_interval_daysintegerNoCalibration interval (days)
asset_iduuidNoFixed asset
statustextNoStatus — A gauge past its calibration due date is quarantined and cannot be made active here: a passing calibration (Calibrate) returns it to use.
Allowed: active in_calibration repair quarantine retired
notestextNoNotes

Sample body

{
  "name": "Example",
  "gauge_type": "text",
  "manufacturer": "text",
  "model": "text",
  "serial_no": "SER-000001"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "gauge_no": "GAU-000001",
  "name": "Example",
  "gauge_type": "text",
  "manufacturer": "text",
  "model": "text",
  "serial_no": "SER-000001",
  "work_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "equipment_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "custodian_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "location_text": "text",
  "range_min": "1250.00",
  "range_max": "1250.00"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/mfg/gauges" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"Example","gauge_type":"text","manufacturer":"text","model":"text","serial_no":"SER-000001"}'
PUT/api/mfg/gauges/{id}Change a gauge

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

Only the fields to change; fields left out keep their value.

FieldTypeRequiredDescription
nametextYesName
gauge_typetextNoType — Caliper, CMM, torque wrench, scale…
manufacturertextNoManufacturer
modeltextNoModel
serial_notextNoSerial number
work_center_iduuidNoWork center
equipment_iduuidNoMachine
custodian_iduuidNoCustodian
location_texttextNoWhere it is kept
range_minnumericNoRange minimum
range_maxnumericNoRange maximum
resolutionnumericNoResolution
uomtextNoUnit
accuracytextNoAccuracy
calibration_interval_daysintegerNoCalibration interval (days)
asset_iduuidNoFixed asset
statustextNoStatus — A gauge past its calibration due date is quarantined and cannot be made active here: a passing calibration (Calibrate) returns it to use.
Allowed: active in_calibration repair quarantine retired
notestextNoNotes

Sample body

{
  "name": "Example",
  "gauge_type": "text"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "gauge_no": "GAU-000001",
  "name": "Example",
  "gauge_type": "text",
  "manufacturer": "text",
  "model": "text",
  "serial_no": "SER-000001",
  "work_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "equipment_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "custodian_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "location_text": "text",
  "range_min": "1250.00",
  "range_max": "1250.00"
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/mfg/gauges/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"Example","gauge_type":"text"}'
DELETE/api/mfg/gauges/{id}Delete a gauge

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Response 200

{ "deleted": true }

Many documents are cancelled or reversed instead; the API refuses a delete the screen would refuse.

Sample request

curl -X DELETE "https://demo.tranxact.ai/api/mfg/gauges/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/mfg/gauges/{id}/copyCopy

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

The keys this action reads (* = required; "one of" lists the only values):

overrides, preview, withLines

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/mfg/gauges/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"overrides":"value","preview":"value","withLines":"value"}'
POST/api/mfg/gauges/{id}/calibrateCalibrate

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

The keys this action reads (* = required; "one of" lists the only values):

asFoundResult, intervalDays, result, asLeftResult, performedByExternal, supplierId, certificateNo, standardUsed, traceableTo, asFoundDeviation, asLeftDeviation, impactAssessment, cost, currency, notes; asFoundResult one of in_tolerance|out_of_tolerance|not_checked; result one of pass|pass_after_adjustment|fail|limited_use; asLeftResult one of in_tolerance|adjusted|failed|not_applicable

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/mfg/gauges/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/calibrate" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"asFoundResult":"value","intervalDays":"value","result":"value","asLeftResult":"value","performedByExternal":"value","supplierId":"value"}'

Data model

Every field of a gauge, as the API returns it. Field names are the JSON keys; any of them can be filtered and sorted on a list.

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
org_unit_iduuidread onlyOrg unit id
gauge_notextread onlyGauge no
nametextread, writeName
gauge_typetextread, writeType — Caliper, CMM, torque wrench, scale…
manufacturertextread, writeManufacturer
modeltextread, writeModel
serial_notextread, writeSerial number
work_center_iduuidread, writeWork center
equipment_iduuidread, writeMachine
custodian_iduuidread, writeCustodian
location_texttextread, writeWhere it is kept
range_minnumericread, writeRange minimum
range_maxnumericread, writeRange maximum
resolutionnumericread, writeResolution
uomtextread, writeUnit
accuracytextread, writeAccuracy
calibration_interval_daysintegerread, writeCalibration interval (days)
last_calibrated_atdateread onlyLast calibrated at
next_calibration_duedateread onlyNext calibration due
calibration_statustextread onlyCalibration status
asset_iduuidread, writeFixed asset
statustextread, writeStatus — A gauge past its calibration due date is quarantined and cannot be made active here: a passing calibration (Calibrate) returns it to use.
Allowed: active in_calibration repair quarantine retired
notestextread, writeNotes
created_attimestamp with time zoneread onlyCreated at
xf_text_1textread onlyXf text 1
xf_text_2textread onlyXf text 2
xf_text_3textread onlyXf text 3
xf_text_4textread onlyXf text 4
xf_text_5textread onlyXf text 5
xf_num_1numericread onlyXf num 1
xf_num_2numericread onlyXf num 2
xf_num_3numericread onlyXf num 3
xf_date_1dateread onlyXf date 1
xf_date_2dateread onlyXf date 2
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by

Errors

StatusMeaning
400The request could not be read: a filter that is not JSON, a bad parameter
401No credential, or it is wrong, revoked or expired
403The caller's roles do not hold Manufacturing › Gauges for this verb, or the address or origin is not allowed
404No record with that id is visible to the caller
409A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else
422Refused by the same validation as the screen; the error names the field and why

Every error is JSON: {"error": "a sentence saying what was wrong"}, with field where it applies.