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.
/api/mfg/control-chartsPublished as /api/v1/control-chartsOverview
| Package | Manufacturing |
|---|---|
| Authentication | Bearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key |
| Authorization | The 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. |
| Table | mfg.spc_charts · kept per company (and organisational unit where it has one) |
| Record | Created, changed and (where the screen allows) deleted; key id |
| Rules | The 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
| Name | Description | Example |
|---|---|---|
limit | Rows per page (50 by default, at most 200) | limit=100 |
offset | Rows to skip | offset=200 |
q | Free-text search over the search columns | q=acme |
sort | column:asc or column:desc, several separated by commas | sort=created_at:desc |
filter | A JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sorted | filter={"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
| Name | Type | Description |
|---|---|---|
id | string (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.
| Field | Type | Required | Description |
|---|---|---|---|
name | text | Yes | Name |
item_id | uuid | No | Item |
characteristic_id | uuid | No | From an inspection plan |
characteristic | text | Yes | Characteristic |
work_center_id | uuid | No | Work center |
equipment_id | uuid | No | Machine |
chart_type | text | No | Chart type Allowed: xbar_r xbar_s individuals moving_range p np c u ewma cusum |
uom | text | No | Unit |
subgroup_size | integer | No | Subgroup size |
spec_min | numeric | No | Specification minimum |
spec_max | numeric | No | Specification maximum |
target_value | numeric | No | Target |
baseline_from | date | No | Baseline from |
baseline_to | date | No | Baseline to |
status | text | No | Status 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
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
Only the fields to change; fields left out keep their value.
| Field | Type | Required | Description |
|---|---|---|---|
name | text | Yes | Name |
item_id | uuid | No | Item |
characteristic_id | uuid | No | From an inspection plan |
characteristic | text | Yes | Characteristic |
work_center_id | uuid | No | Work center |
equipment_id | uuid | No | Machine |
chart_type | text | No | Chart type Allowed: xbar_r xbar_s individuals moving_range p np c u ewma cusum |
uom | text | No | Unit |
subgroup_size | integer | No | Subgroup size |
spec_min | numeric | No | Specification minimum |
spec_max | numeric | No | Specification maximum |
target_value | numeric | No | Target |
baseline_from | date | No | Baseline from |
baseline_to | date | No | Baseline to |
status | text | No | Status 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
| Name | Type | Description |
|---|---|---|
id | string (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
| Name | Type | Description |
|---|---|---|
id | string (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, withLinesResponse
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
| Name | Type | Description |
|---|---|---|
id | string (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, toResponse
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.
| Field | Type | Access | Description |
|---|---|---|---|
id | uuid | read only | Id |
org_id | uuid | read only | Org id |
org_unit_id | uuid | read only | Org unit id |
chart_no | text | read only | Chart no |
name | text | read, write | Name |
item_id | uuid | read, write | Item |
characteristic_id | uuid | read, write | From an inspection plan |
characteristic | text | read, write | Characteristic |
work_center_id | uuid | read, write | Work center |
equipment_id | uuid | read, write | Machine |
chart_type | text | read, write | Chart type Allowed: xbar_r xbar_s individuals moving_range p np c u ewma cusum |
uom | text | read, write | Unit |
subgroup_size | integer | read, write | Subgroup size |
spec_min | numeric | read, write | Specification minimum |
spec_max | numeric | read, write | Specification maximum |
target_value | numeric | read, write | Target |
center_line | numeric | read only | Center line |
ucl | numeric | read only | Ucl |
lcl | numeric | read only | Lcl |
range_center | numeric | read only | Range center |
range_ucl | numeric | read only | Range ucl |
baseline_from | date | read, write | Baseline from |
baseline_to | date | read, write | Baseline to |
baseline_subgroups | integer | read only | Baseline subgroups |
cp | numeric | read only | Cp |
cpk | numeric | read only | Cpk |
pp | numeric | read only | Pp |
ppk | numeric | read only | Ppk |
sigma_estimate | numeric | read only | Sigma estimate |
last_computed_at | timestamp with time zone | read only | Last computed at |
status | text | read, write | Status Allowed: active draft baseline out_of_control suspended retired |
created_at | timestamp with time zone | read only | Created at |
xf_text_1 | text | read only | Xf text 1 |
xf_text_2 | text | read only | Xf text 2 |
xf_text_3 | text | read only | Xf text 3 |
xf_text_4 | text | read only | Xf text 4 |
xf_text_5 | text | read only | Xf text 5 |
xf_num_1 | numeric | read only | Xf num 1 |
xf_num_2 | numeric | read only | Xf num 2 |
xf_num_3 | numeric | read only | Xf num 3 |
xf_date_1 | date | read only | Xf date 1 |
xf_date_2 | date | read only | Xf date 2 |
created_by | uuid | read only | Created by |
updated_at | timestamp with time zone | read only | Updated at |
updated_by | uuid | read only | Updated by |
Errors
| Status | Meaning |
|---|---|
| 400 | The request could not be read: a filter that is not JSON, a bad parameter |
| 401 | No credential, or it is wrong, revoked or expired |
| 403 | The caller's roles do not hold Manufacturing › Control Charts for this verb, or the address or origin is not allowed |
| 404 | No record with that id is visible to the caller |
| 409 | A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else |
| 422 | Refused 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.