TRANXACT.AI Help

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.

Type REST12 operationsBase path /api/mfg/inspection-plansPublished as /api/v1/inspection-plans

Download specification (OpenAPI 3.1) Screen: Inspection Plans

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 › 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.
Tablemfg.inspection_plans · 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

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

GET/api/mfg/inspection-plansList inspection plans

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",
      "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

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",
  "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.

FieldTypeRequiredDescription
nametextYesName
versiontextNoVersion
item_iduuidNoItem
item_categorytextNoItem category
supplier_iduuidNoSupplier
routing_iduuidNoRouting
operation_nointegerNoOperation
work_center_iduuidNoWork center
inspection_stagetextNoStage
Allowed: incoming in_process final first_article pre_ship periodic audit returned
sampling_plantextNoSampling
Allowed: aql none 100_percent fixed percentage skip_lot first_article periodic
aql_leveltextNoAQL 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_leveltextNoInspection level — I, II (the usual level), III, or S-1…S-4. Empty means II.
sample_sizenumericNoSample size
sample_pctnumericNoSample %
skip_frequencyintegerNoSkip 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_skipintegerNoPasses before skipping — Skip-lot starts after this many consecutive accepted lots. A rejected lot, or tightened inspection, ends it.
requires_coabooleanNoRequires a certificate of analysis
document_iduuidNoInspection drawing
change_order_iduuidNoAuthorized by change order
effective_fromdateNoEffective from
effective_todateNoEffective to
notestextNoNotes

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

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
versiontextNoVersion
item_iduuidNoItem
item_categorytextNoItem category
supplier_iduuidNoSupplier
routing_iduuidNoRouting
operation_nointegerNoOperation
work_center_iduuidNoWork center
inspection_stagetextNoStage
Allowed: incoming in_process final first_article pre_ship periodic audit returned
sampling_plantextNoSampling
Allowed: aql none 100_percent fixed percentage skip_lot first_article periodic
aql_leveltextNoAQL 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_leveltextNoInspection level — I, II (the usual level), III, or S-1…S-4. Empty means II.
sample_sizenumericNoSample size
sample_pctnumericNoSample %
skip_frequencyintegerNoSkip 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_skipintegerNoPasses before skipping — Skip-lot starts after this many consecutive accepted lots. A rejected lot, or tightened inspection, ends it.
requires_coabooleanNoRequires a certificate of analysis
document_iduuidNoInspection drawing
change_order_iduuidNoAuthorized by change order
effective_fromdateNoEffective from
effective_todateNoEffective to
notestextNoNotes

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

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-plans/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
GET/api/mfg/inspection-plans/{parentId}/characteristicsCharacteristics

Path parameters

NameTypeDescription
parentIdstring (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

NameTypeDescription
parentIdstring (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

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.
lineIdstring (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

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.
lineIdstring (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

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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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.

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
org_unit_iduuidread onlyOrg unit id
plan_notextread onlyPlan no
nametextread, writeName
versiontextread, writeVersion
item_iduuidread, writeItem
item_categorytextread, writeItem category
supplier_iduuidread, writeSupplier
routing_iduuidread, writeRouting
operation_nointegerread, writeOperation
work_center_iduuidread, writeWork center
inspection_stagetextread, writeStage
Allowed: incoming in_process final first_article pre_ship periodic audit returned
sampling_plantextread, writeSampling
Allowed: aql none 100_percent fixed percentage skip_lot first_article periodic
aql_leveltextread, writeAQL 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_leveltextread, writeInspection level — I, II (the usual level), III, or S-1…S-4. Empty means II.
sample_sizenumericread, writeSample size
sample_pctnumericread, writeSample %
skip_frequencyintegerread, writeSkip 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_skipintegerread, writePasses before skipping — Skip-lot starts after this many consecutive accepted lots. A rejected lot, or tightened inspection, ends it.
requires_coabooleanread, writeRequires a certificate of analysis
document_iduuidread, writeInspection drawing
change_order_iduuidread, writeAuthorized by change order
effective_fromdateread, writeEffective from
effective_todateread, writeEffective to
statustextread onlyStatus
approved_byuuidread onlyApproved by
approved_attimestamp with time zoneread onlyApproved at
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 › Inspection Plans 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.