Manufacturing · Quality Planning
Inspection Plans
An inspection with no plan is one person’s opinion of what mattered that day. A plan fixes the characteristics, the method, the gauge and the sampling before the goods arrive.
/api/mfg/inspection-plansPublished as /api/v1/inspection-plansDownload specification (OpenAPI 3.1) Screen: Inspection Plans
Overview
| 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 › Inspection Plans 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.inspection_plans · 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
12 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/mfg/inspection-plansList inspection plans
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",
"plan_no": "PLA-000001",
"name": "Example",
"version": "text",
"item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"item_category": "text",
"supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"routing_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"operation_no": 10,
"work_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"inspection_stage": "incoming",
"sampling_plan": "aql",
"aql_level": "text"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/mfg/inspection-plans?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/mfg/inspection-plans/{id}Read one inspection plan
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",
"plan_no": "PLA-000001",
"name": "Example",
"version": "text",
"item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"item_category": "text",
"supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"routing_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"operation_no": 10,
"work_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"inspection_stage": "incoming",
"sampling_plan": "aql",
"aql_level": "text"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/mfg/inspection-plans/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/mfg/inspection-plansCreate a inspection plan
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
name | text | Yes | Name |
version | text | No | Version |
item_id | uuid | No | Item |
item_category | text | No | Item category |
supplier_id | uuid | No | Supplier |
routing_id | uuid | No | Routing |
operation_no | integer | No | Operation |
work_center_id | uuid | No | Work center |
inspection_stage | text | No | Stage Allowed: incoming in_process final first_article pre_ship periodic audit returned |
sampling_plan | text | No | Sampling Allowed: aql none 100_percent fixed percentage skip_lot first_article periodic |
aql_level | text | No | AQL level — An AQL the ANSI/ASQ Z1.4 (ISO 2859-1) tables print, such as 0.65, 1.0, 2.5 or 4.0. With Sampling “aql”, each lot is sampled by Z1.4 single sampling: the sample size and the accept and reject numbers come from the lot size and the inspection level, and inspection switches between normal, tightened and reduced by the standard’s rules. |
inspection_level | text | No | Inspection level — I, II (the usual level), III, or S-1…S-4. Empty means II. |
sample_size | numeric | No | Sample size |
sample_pct | numeric | No | Sample % |
skip_frequency | integer | No | Skip frequency — Skip-lot: once earned, one lot in this many is inspected and the others are accepted without inspection, each with its usage decision recorded. 2 or more. |
consecutive_passes_to_skip | integer | No | Passes before skipping — Skip-lot starts after this many consecutive accepted lots. A rejected lot, or tightened inspection, ends it. |
requires_coa | boolean | No | Requires a certificate of analysis |
document_id | uuid | No | Inspection drawing |
change_order_id | uuid | No | Authorized by change order |
effective_from | date | No | Effective from |
effective_to | date | No | Effective to |
notes | text | No | Notes |
Sample body
{
"name": "Example",
"version": "text",
"item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"item_category": "text",
"supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"plan_no": "PLA-000001",
"name": "Example",
"version": "text",
"item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"item_category": "text",
"supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"routing_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"operation_no": 10,
"work_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"inspection_stage": "incoming",
"sampling_plan": "aql",
"aql_level": "text"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/mfg/inspection-plans" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"name":"Example","version":"text","item_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","item_category":"text","supplier_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'PUT/api/mfg/inspection-plans/{id}Change a inspection plan
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 |
version | text | No | Version |
item_id | uuid | No | Item |
item_category | text | No | Item category |
supplier_id | uuid | No | Supplier |
routing_id | uuid | No | Routing |
operation_no | integer | No | Operation |
work_center_id | uuid | No | Work center |
inspection_stage | text | No | Stage Allowed: incoming in_process final first_article pre_ship periodic audit returned |
sampling_plan | text | No | Sampling Allowed: aql none 100_percent fixed percentage skip_lot first_article periodic |
aql_level | text | No | AQL level — An AQL the ANSI/ASQ Z1.4 (ISO 2859-1) tables print, such as 0.65, 1.0, 2.5 or 4.0. With Sampling “aql”, each lot is sampled by Z1.4 single sampling: the sample size and the accept and reject numbers come from the lot size and the inspection level, and inspection switches between normal, tightened and reduced by the standard’s rules. |
inspection_level | text | No | Inspection level — I, II (the usual level), III, or S-1…S-4. Empty means II. |
sample_size | numeric | No | Sample size |
sample_pct | numeric | No | Sample % |
skip_frequency | integer | No | Skip frequency — Skip-lot: once earned, one lot in this many is inspected and the others are accepted without inspection, each with its usage decision recorded. 2 or more. |
consecutive_passes_to_skip | integer | No | Passes before skipping — Skip-lot starts after this many consecutive accepted lots. A rejected lot, or tightened inspection, ends it. |
requires_coa | boolean | No | Requires a certificate of analysis |
document_id | uuid | No | Inspection drawing |
change_order_id | uuid | No | Authorized by change order |
effective_from | date | No | Effective from |
effective_to | date | No | Effective to |
notes | text | No | Notes |
Sample body
{
"name": "Example",
"version": "text"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"plan_no": "PLA-000001",
"name": "Example",
"version": "text",
"item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"item_category": "text",
"supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"routing_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"operation_no": 10,
"work_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"inspection_stage": "incoming",
"sampling_plan": "aql",
"aql_level": "text"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/mfg/inspection-plans/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"name":"Example","version":"text"}'DELETE/api/mfg/inspection-plans/{id}Delete a inspection plan
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/inspection-plans/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"GET/api/mfg/inspection-plans/{parentId}/characteristicsCharacteristics
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/mfg/inspection-plans/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/characteristics" \
-H "Authorization: Bearer $TOKEN"POST/api/mfg/inspection-plans/{parentId}/characteristicsCharacteristics
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
No body is required.
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-plans/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/characteristics" \
-H "Authorization: Bearer $TOKEN"PUT/api/mfg/inspection-plans/{parentId}/characteristics/{lineId}Characteristics
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
lineId | string (uuid) | The record's lineId, as a list returns it. |
No body is required.
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 PUT "https://demo.tranxact.ai/api/mfg/inspection-plans/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/characteristics/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"DELETE/api/mfg/inspection-plans/{parentId}/characteristics/{lineId}Characteristics
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
lineId | string (uuid) | The record's lineId, as a list returns it. |
No body is required.
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 DELETE "https://demo.tranxact.ai/api/mfg/inspection-plans/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/characteristics/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/mfg/inspection-plans/{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/inspection-plans/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/inspection-plans/{id}/releaseRelease
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
No body is required.
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-plans/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/release" \
-H "Authorization: Bearer $TOKEN"POST/api/mfg/inspection-plans/{id}/reviseRevise
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
No body is required.
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-plans/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/revise" \
-H "Authorization: Bearer $TOKEN"Data model
Every field of a inspection plan, 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 |
plan_no | text | read only | Plan no |
name | text | read, write | Name |
version | text | read, write | Version |
item_id | uuid | read, write | Item |
item_category | text | read, write | Item category |
supplier_id | uuid | read, write | Supplier |
routing_id | uuid | read, write | Routing |
operation_no | integer | read, write | Operation |
work_center_id | uuid | read, write | Work center |
inspection_stage | text | read, write | Stage Allowed: incoming in_process final first_article pre_ship periodic audit returned |
sampling_plan | text | read, write | Sampling Allowed: aql none 100_percent fixed percentage skip_lot first_article periodic |
aql_level | text | read, write | AQL level — An AQL the ANSI/ASQ Z1.4 (ISO 2859-1) tables print, such as 0.65, 1.0, 2.5 or 4.0. With Sampling “aql”, each lot is sampled by Z1.4 single sampling: the sample size and the accept and reject numbers come from the lot size and the inspection level, and inspection switches between normal, tightened and reduced by the standard’s rules. |
inspection_level | text | read, write | Inspection level — I, II (the usual level), III, or S-1…S-4. Empty means II. |
sample_size | numeric | read, write | Sample size |
sample_pct | numeric | read, write | Sample % |
skip_frequency | integer | read, write | Skip frequency — Skip-lot: once earned, one lot in this many is inspected and the others are accepted without inspection, each with its usage decision recorded. 2 or more. |
consecutive_passes_to_skip | integer | read, write | Passes before skipping — Skip-lot starts after this many consecutive accepted lots. A rejected lot, or tightened inspection, ends it. |
requires_coa | boolean | read, write | Requires a certificate of analysis |
document_id | uuid | read, write | Inspection drawing |
change_order_id | uuid | read, write | Authorized by change order |
effective_from | date | read, write | Effective from |
effective_to | date | read, write | Effective to |
status | text | read only | Status |
approved_by | uuid | read only | Approved by |
approved_at | timestamp with time zone | read only | Approved at |
notes | text | read, write | Notes |
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 › Inspection Plans 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.