TRANXACT.AI Help

Manufacturing · Quality Planning

Control Charts

Limits computed FROM THE PROCESS, never from the specification — a process comfortably inside a wide tolerance can be wildly out of control and nobody would see it.

Type REST7 operationsBase path /api/mfg/control-chartsPublished as /api/v1/control-charts

Download specification (OpenAPI 3.1) Screen: Control Charts

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 › Control Charts 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.spc_charts · 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/control-chartsList control charts

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",
      "chart_no": "CHA-000001",
      "name": "Example",
      "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "characteristic_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "characteristic": "text",
      "work_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "equipment_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "chart_type": "xbar_r",
      "uom": "text",
      "subgroup_size": 10,
      "spec_min": "1250.00",
      "spec_max": "1250.00"
    }
  ],
  "count": 1
}

Sample request

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

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",
  "chart_no": "CHA-000001",
  "name": "Example",
  "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "characteristic_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "characteristic": "text",
  "work_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "equipment_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "chart_type": "xbar_r",
  "uom": "text",
  "subgroup_size": 10,
  "spec_min": "1250.00",
  "spec_max": "1250.00"
}

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

Sample request

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

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
nametextYesName
item_iduuidNoItem
characteristic_iduuidNoFrom an inspection plan
characteristictextYesCharacteristic
work_center_iduuidNoWork center
equipment_iduuidNoMachine
chart_typetextNoChart type
Allowed: xbar_r xbar_s individuals moving_range p np c u ewma cusum
uomtextNoUnit
subgroup_sizeintegerNoSubgroup size
spec_minnumericNoSpecification minimum
spec_maxnumericNoSpecification maximum
target_valuenumericNoTarget
baseline_fromdateNoBaseline from
baseline_todateNoBaseline to
statustextNoStatus
Allowed: active draft baseline out_of_control suspended retired

Sample body

{
  "name": "Example",
  "characteristic": "text",
  "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "characteristic_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "work_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "equipment_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "chart_no": "CHA-000001",
  "name": "Example",
  "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "characteristic_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "characteristic": "text",
  "work_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "equipment_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "chart_type": "xbar_r",
  "uom": "text",
  "subgroup_size": 10,
  "spec_min": "1250.00",
  "spec_max": "1250.00"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/mfg/control-charts" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"Example","characteristic":"text","item_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","characteristic_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","work_center_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","equipment_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'
PUT/api/mfg/control-charts/{id}Change a control chart

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
item_iduuidNoItem
characteristic_iduuidNoFrom an inspection plan
characteristictextYesCharacteristic
work_center_iduuidNoWork center
equipment_iduuidNoMachine
chart_typetextNoChart type
Allowed: xbar_r xbar_s individuals moving_range p np c u ewma cusum
uomtextNoUnit
subgroup_sizeintegerNoSubgroup size
spec_minnumericNoSpecification minimum
spec_maxnumericNoSpecification maximum
target_valuenumericNoTarget
baseline_fromdateNoBaseline from
baseline_todateNoBaseline to
statustextNoStatus
Allowed: active draft baseline out_of_control suspended retired

Sample body

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

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "chart_no": "CHA-000001",
  "name": "Example",
  "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "characteristic_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "characteristic": "text",
  "work_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "equipment_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "chart_type": "xbar_r",
  "uom": "text",
  "subgroup_size": 10,
  "spec_min": "1250.00",
  "spec_max": "1250.00"
}

Sample request

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

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/control-charts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/mfg/control-charts/{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/control-charts/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/control-charts/{id}/baselineBaseline

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):

from, to

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/control-charts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/baseline" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"from":"value","to":"value"}'

Data model

Every field of a control chart, 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
chart_notextread onlyChart no
nametextread, writeName
item_iduuidread, writeItem
characteristic_iduuidread, writeFrom an inspection plan
characteristictextread, writeCharacteristic
work_center_iduuidread, writeWork center
equipment_iduuidread, writeMachine
chart_typetextread, writeChart type
Allowed: xbar_r xbar_s individuals moving_range p np c u ewma cusum
uomtextread, writeUnit
subgroup_sizeintegerread, writeSubgroup size
spec_minnumericread, writeSpecification minimum
spec_maxnumericread, writeSpecification maximum
target_valuenumericread, writeTarget
center_linenumericread onlyCenter line
uclnumericread onlyUcl
lclnumericread onlyLcl
range_centernumericread onlyRange center
range_uclnumericread onlyRange ucl
baseline_fromdateread, writeBaseline from
baseline_todateread, writeBaseline to
baseline_subgroupsintegerread onlyBaseline subgroups
cpnumericread onlyCp
cpknumericread onlyCpk
ppnumericread onlyPp
ppknumericread onlyPpk
sigma_estimatenumericread onlySigma estimate
last_computed_attimestamp with time zoneread onlyLast computed at
statustextread, writeStatus
Allowed: active draft baseline out_of_control suspended retired
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 › Control Charts 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.