Manufacturing · Quality Events
Corrective & Preventive Actions
The investigation, and — the part that is always skipped — the check that it worked. A CAPA closed without a verification date is closed on hope.
/api/mfg/capaPublished as /api/v1/capaDownload specification (OpenAPI 3.1) Screen: Corrective & Preventive Actions
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 › Corrective & Preventive Actions 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.capa · 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
15 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/mfg/capaList corrective & preventive actions
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",
"capa_no": "CAP-000001",
"title": "Example",
"description": "text",
"capa_type": "corrective",
"source": "nonconformance",
"priority": "low",
"risk_score": 10,
"item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"work_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"process_area": "text",
"investigation_method": "five_why"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/mfg/capa?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/mfg/capa/{id}Read one capa
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",
"capa_no": "CAP-000001",
"title": "Example",
"description": "text",
"capa_type": "corrective",
"source": "nonconformance",
"priority": "low",
"risk_score": 10,
"item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"work_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"process_area": "text",
"investigation_method": "five_why"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/mfg/capa/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/mfg/capaCreate a capa
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
title | text | Yes | Title |
description | text | No | Description |
capa_type | text | No | Type Allowed: corrective preventive both |
source | text | No | Source Allowed: nonconformance complaint audit deviation trend management_review regulatory supplier internal_improvement |
priority | text | No | Priority Allowed: low medium high critical |
risk_score | integer | No | Risk score |
item_id | uuid | No | Item |
supplier_id | uuid | No | Supplier |
work_center_id | uuid | No | Work center |
process_area | text | No | Process area |
investigation_method | text | No | Investigation method Allowed: five_why fishbone 8d fault_tree is_is_not fmea pareto other |
root_cause | text | No | Root cause |
root_cause_category | text | No | Cause category |
investigation_notes | text | No | Investigation notes |
containment | text | No | Containment |
corrective_action | text | No | Corrective action |
preventive_action | text | No | Preventive action |
change_order_id | uuid | No | Authorized by change order |
effectiveness_criteria | text | No | What "it worked" would look like — Written before judging whether it did. Without it the effectiveness check cannot be made. |
effectiveness_check_due | date | No | Effectiveness check due |
owner_id | uuid | No | Owner |
due_date | date | No | Due |
Sample body
{
"title": "Example",
"description": "text",
"capa_type": "corrective",
"source": "nonconformance",
"priority": "low"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"capa_no": "CAP-000001",
"title": "Example",
"description": "text",
"capa_type": "corrective",
"source": "nonconformance",
"priority": "low",
"risk_score": 10,
"item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"work_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"process_area": "text",
"investigation_method": "five_why"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/mfg/capa" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"title":"Example","description":"text","capa_type":"corrective","source":"nonconformance","priority":"low"}'PUT/api/mfg/capa/{id}Change a capa
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 |
|---|---|---|---|
title | text | Yes | Title |
description | text | No | Description |
capa_type | text | No | Type Allowed: corrective preventive both |
source | text | No | Source Allowed: nonconformance complaint audit deviation trend management_review regulatory supplier internal_improvement |
priority | text | No | Priority Allowed: low medium high critical |
risk_score | integer | No | Risk score |
item_id | uuid | No | Item |
supplier_id | uuid | No | Supplier |
work_center_id | uuid | No | Work center |
process_area | text | No | Process area |
investigation_method | text | No | Investigation method Allowed: five_why fishbone 8d fault_tree is_is_not fmea pareto other |
root_cause | text | No | Root cause |
root_cause_category | text | No | Cause category |
investigation_notes | text | No | Investigation notes |
containment | text | No | Containment |
corrective_action | text | No | Corrective action |
preventive_action | text | No | Preventive action |
change_order_id | uuid | No | Authorized by change order |
effectiveness_criteria | text | No | What "it worked" would look like — Written before judging whether it did. Without it the effectiveness check cannot be made. |
effectiveness_check_due | date | No | Effectiveness check due |
owner_id | uuid | No | Owner |
due_date | date | No | Due |
Sample body
{
"title": "Example",
"description": "text"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"capa_no": "CAP-000001",
"title": "Example",
"description": "text",
"capa_type": "corrective",
"source": "nonconformance",
"priority": "low",
"risk_score": 10,
"item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"work_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"process_area": "text",
"investigation_method": "five_why"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/mfg/capa/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"title":"Example","description":"text"}'DELETE/api/mfg/capa/{id}Delete a capa
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/capa/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"GET/api/mfg/capa/{parentId}/actionsActions
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/capa/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/actions" \
-H "Authorization: Bearer $TOKEN"POST/api/mfg/capa/{parentId}/actionsActions
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/capa/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/actions" \
-H "Authorization: Bearer $TOKEN"PUT/api/mfg/capa/{parentId}/actions/{lineId}Actions
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/capa/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/actions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"DELETE/api/mfg/capa/{parentId}/actions/{lineId}Actions
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/capa/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/actions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/mfg/capa/{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/capa/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/capa/{id}/verifyVerify
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):
verdict, notes; verdict one of effective|partially_effective|not_effective|too_earlyResponse
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/capa/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/verify" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"verdict":"value","notes;":"value"}'POST/api/mfg/capa/{id}/investigateInvestigate
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):
investigationMethodResponse
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/capa/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/investigate" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"investigationMethod":"value"}'POST/api/mfg/capa/{id}/planPlan
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):
rootCause, correctiveAction, preventiveActionResponse
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/capa/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/plan" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"rootCause":"value","correctiveAction":"value","preventiveAction":"value"}'POST/api/mfg/capa/{id}/implementImplement
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/capa/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/implement" \
-H "Authorization: Bearer $TOKEN"POST/api/mfg/capa/{id}/cancelCancel
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):
reasonResponse
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/capa/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/cancel" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"reason":"value"}'Data model
Every field of a capa, 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 |
capa_no | text | read only | Capa no |
title | text | read, write | Title |
description | text | read, write | Description |
capa_type | text | read, write | Type Allowed: corrective preventive both |
source | text | read, write | Source Allowed: nonconformance complaint audit deviation trend management_review regulatory supplier internal_improvement |
priority | text | read, write | Priority Allowed: low medium high critical |
risk_score | integer | read, write | Risk score |
item_id | uuid | read, write | Item |
supplier_id | uuid | read, write | Supplier |
work_center_id | uuid | read, write | Work center |
process_area | text | read, write | Process area |
investigation_method | text | read, write | Investigation method Allowed: five_why fishbone 8d fault_tree is_is_not fmea pareto other |
root_cause | text | read, write | Root cause |
root_cause_category | text | read, write | Cause category |
investigation_notes | text | read, write | Investigation notes |
containment | text | read, write | Containment |
corrective_action | text | read, write | Corrective action |
preventive_action | text | read, write | Preventive action |
change_order_id | uuid | read, write | Authorized by change order |
effectiveness_criteria | text | read, write | What "it worked" would look like — Written before judging whether it did. Without it the effectiveness check cannot be made. |
effectiveness_check_due | date | read, write | Effectiveness check due |
effectiveness_verified_at | timestamp with time zone | read only | Effectiveness verified at |
effectiveness_verdict | text | read only | Effectiveness verdict |
effectiveness_notes | text | read only | Effectiveness notes |
owner_id | uuid | read, write | Owner |
raised_by | uuid | read only | Raised by |
raised_at | timestamp with time zone | read only | Raised at |
due_date | date | read, write | Due |
closed_by | uuid | read only | Closed by |
closed_at | timestamp with time zone | read only | Closed at |
status | text | read only | Status |
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 › Corrective & Preventive Actions 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.