TRANXACT.AI Help

Manufacturing · Quality Planning

Characteristics

What is measured, against what, with what. A gauge whose resolution is a tenth of the tolerance cannot police it, and the gauge R&R figure is the honest statement of that.

Type REST6 operationsBase path /api/mfg/inspection-characteristicsPublished as /api/v1/inspection-characteristics

Download specification (OpenAPI 3.1) Screen: Characteristics

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 › Characteristics 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.inspection_characteristics · 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

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

GET/api/mfg/inspection-characteristicsList characteristics

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",
      "inspection_plan_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "line_no": 10,
      "characteristic": "text",
      "data_type": "variable",
      "uom": "text",
      "target_value": "1250.00",
      "spec_min": "1250.00",
      "spec_max": "1250.00",
      "classification": "critical",
      "is_key_characteristic": true,
      "method": "text",
      "gauge_type": "text",
      "gauge_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
    }
  ],
  "count": 1
}

Sample request

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

Path parameters

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

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "inspection_plan_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "line_no": 10,
  "characteristic": "text",
  "data_type": "variable",
  "uom": "text",
  "target_value": "1250.00",
  "spec_min": "1250.00",
  "spec_max": "1250.00",
  "classification": "critical",
  "is_key_characteristic": true,
  "method": "text",
  "gauge_type": "text",
  "gauge_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

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

Sample request

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

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
inspection_plan_iduuidYesPlan
line_nointegerNoLine
characteristictextYesCharacteristic
data_typetextNoData type — Variable data can be charted; attribute data can only be counted.
Allowed: variable attribute visual functional destructive
uomtextNoUnit
target_valuenumericNoTarget
spec_minnumericNoSpecification minimum
spec_maxnumericNoSpecification maximum
classificationtextNoClassification
Allowed: critical major minor cosmetic
is_key_characteristicbooleanNoKey characteristic
methodtextNoMethod
gauge_typetextNoGauge type
gauge_iduuidNoGauge — Gauges in use only. One that is quarantined or past its calibration date returns to this list when it is calibrated.
gauge_rr_pctnumericNoGauge R&R %
sample_sizenumericNoSample size
frequencytextNoFrequency
is_spcbooleanNoCharted on SPC — Enable for critical or key variable characteristics that need ongoing process monitoring. Inspection results are plotted on a control chart, and a point outside the control limits or a run trend raises an out-of-control signal for review.
subgroup_sizeintegerNoSubgroup size

Sample body

{
  "inspection_plan_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "characteristic": "text",
  "line_no": 10,
  "data_type": "variable",
  "uom": "text",
  "target_value": "1250.00"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "inspection_plan_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "line_no": 10,
  "characteristic": "text",
  "data_type": "variable",
  "uom": "text",
  "target_value": "1250.00",
  "spec_min": "1250.00",
  "spec_max": "1250.00",
  "classification": "critical",
  "is_key_characteristic": true,
  "method": "text",
  "gauge_type": "text",
  "gauge_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/mfg/inspection-characteristics" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"inspection_plan_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","characteristic":"text","line_no":10,"data_type":"variable","uom":"text","target_value":"1250.00"}'
PUT/api/mfg/inspection-characteristics/{id}Change a characteristic

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
inspection_plan_iduuidYesPlan
line_nointegerNoLine
characteristictextYesCharacteristic
data_typetextNoData type — Variable data can be charted; attribute data can only be counted.
Allowed: variable attribute visual functional destructive
uomtextNoUnit
target_valuenumericNoTarget
spec_minnumericNoSpecification minimum
spec_maxnumericNoSpecification maximum
classificationtextNoClassification
Allowed: critical major minor cosmetic
is_key_characteristicbooleanNoKey characteristic
methodtextNoMethod
gauge_typetextNoGauge type
gauge_iduuidNoGauge — Gauges in use only. One that is quarantined or past its calibration date returns to this list when it is calibrated.
gauge_rr_pctnumericNoGauge R&R %
sample_sizenumericNoSample size
frequencytextNoFrequency
is_spcbooleanNoCharted on SPC — Enable for critical or key variable characteristics that need ongoing process monitoring. Inspection results are plotted on a control chart, and a point outside the control limits or a run trend raises an out-of-control signal for review.
subgroup_sizeintegerNoSubgroup size

Sample body

{
  "inspection_plan_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "characteristic": "text"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "inspection_plan_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "line_no": 10,
  "characteristic": "text",
  "data_type": "variable",
  "uom": "text",
  "target_value": "1250.00",
  "spec_min": "1250.00",
  "spec_max": "1250.00",
  "classification": "critical",
  "is_key_characteristic": true,
  "method": "text",
  "gauge_type": "text",
  "gauge_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Sample request

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

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/inspection-characteristics/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/mfg/inspection-characteristics/{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/inspection-characteristics/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"overrides":"value","preview":"value","withLines":"value"}'

Data model

Every field of a characteristic, 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
inspection_plan_iduuidread, writePlan
line_nointegerread, writeLine
characteristictextread, writeCharacteristic
data_typetextread, writeData type — Variable data can be charted; attribute data can only be counted.
Allowed: variable attribute visual functional destructive
uomtextread, writeUnit
target_valuenumericread, writeTarget
spec_minnumericread, writeSpecification minimum
spec_maxnumericread, writeSpecification maximum
classificationtextread, writeClassification
Allowed: critical major minor cosmetic
is_key_characteristicbooleanread, writeKey characteristic
methodtextread, writeMethod
gauge_typetextread, writeGauge type
gauge_iduuidread, writeGauge — Gauges in use only. One that is quarantined or past its calibration date returns to this list when it is calibrated.
gauge_rr_pctnumericread, writeGauge R&R %
sample_sizenumericread, writeSample size
frequencytextread, writeFrequency
is_spcbooleanread, writeCharted on SPC — Enable for critical or key variable characteristics that need ongoing process monitoring. Inspection results are plotted on a control chart, and a point outside the control limits or a run trend raises an out-of-control signal for review.
subgroup_sizeintegerread, writeSubgroup size
created_attimestamp with time zoneread onlyCreated at
org_unit_iduuidread onlyOrg unit id
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 › Characteristics 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.