TRANXACT.AI Help

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.

Type REST15 operationsBase path /api/mfg/capaPublished as /api/v1/capa

Download specification (OpenAPI 3.1) Screen: Corrective & Preventive Actions

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

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

GET/api/mfg/capaList corrective & preventive actions

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

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

FieldTypeRequiredDescription
titletextYesTitle
descriptiontextNoDescription
capa_typetextNoType
Allowed: corrective preventive both
sourcetextNoSource
Allowed: nonconformance complaint audit deviation trend management_review regulatory supplier internal_improvement
prioritytextNoPriority
Allowed: low medium high critical
risk_scoreintegerNoRisk score
item_iduuidNoItem
supplier_iduuidNoSupplier
work_center_iduuidNoWork center
process_areatextNoProcess area
investigation_methodtextNoInvestigation method
Allowed: five_why fishbone 8d fault_tree is_is_not fmea pareto other
root_causetextNoRoot cause
root_cause_categorytextNoCause category
investigation_notestextNoInvestigation notes
containmenttextNoContainment
corrective_actiontextNoCorrective action
preventive_actiontextNoPreventive action
change_order_iduuidNoAuthorized by change order
effectiveness_criteriatextNoWhat "it worked" would look like — Written before judging whether it did. Without it the effectiveness check cannot be made.
effectiveness_check_duedateNoEffectiveness check due
owner_iduuidNoOwner
due_datedateNoDue

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

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
titletextYesTitle
descriptiontextNoDescription
capa_typetextNoType
Allowed: corrective preventive both
sourcetextNoSource
Allowed: nonconformance complaint audit deviation trend management_review regulatory supplier internal_improvement
prioritytextNoPriority
Allowed: low medium high critical
risk_scoreintegerNoRisk score
item_iduuidNoItem
supplier_iduuidNoSupplier
work_center_iduuidNoWork center
process_areatextNoProcess area
investigation_methodtextNoInvestigation method
Allowed: five_why fishbone 8d fault_tree is_is_not fmea pareto other
root_causetextNoRoot cause
root_cause_categorytextNoCause category
investigation_notestextNoInvestigation notes
containmenttextNoContainment
corrective_actiontextNoCorrective action
preventive_actiontextNoPreventive action
change_order_iduuidNoAuthorized by change order
effectiveness_criteriatextNoWhat "it worked" would look like — Written before judging whether it did. Without it the effectiveness check cannot be made.
effectiveness_check_duedateNoEffectiveness check due
owner_iduuidNoOwner
due_datedateNoDue

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

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

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

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/capa/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/actions" \
  -H "Authorization: Bearer $TOKEN"
PUT/api/mfg/capa/{parentId}/actions/{lineId}Actions

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

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

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

verdict, notes; verdict one of effective|partially_effective|not_effective|too_early

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/verify" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"verdict":"value","notes;":"value"}'
POST/api/mfg/capa/{id}/investigateInvestigate

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

investigationMethod

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/investigate" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"investigationMethod":"value"}'
POST/api/mfg/capa/{id}/planPlan

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

rootCause, correctiveAction, preventiveAction

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

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

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

reason

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

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
org_unit_iduuidread onlyOrg unit id
capa_notextread onlyCapa no
titletextread, writeTitle
descriptiontextread, writeDescription
capa_typetextread, writeType
Allowed: corrective preventive both
sourcetextread, writeSource
Allowed: nonconformance complaint audit deviation trend management_review regulatory supplier internal_improvement
prioritytextread, writePriority
Allowed: low medium high critical
risk_scoreintegerread, writeRisk score
item_iduuidread, writeItem
supplier_iduuidread, writeSupplier
work_center_iduuidread, writeWork center
process_areatextread, writeProcess area
investigation_methodtextread, writeInvestigation method
Allowed: five_why fishbone 8d fault_tree is_is_not fmea pareto other
root_causetextread, writeRoot cause
root_cause_categorytextread, writeCause category
investigation_notestextread, writeInvestigation notes
containmenttextread, writeContainment
corrective_actiontextread, writeCorrective action
preventive_actiontextread, writePreventive action
change_order_iduuidread, writeAuthorized by change order
effectiveness_criteriatextread, writeWhat "it worked" would look like — Written before judging whether it did. Without it the effectiveness check cannot be made.
effectiveness_check_duedateread, writeEffectiveness check due
effectiveness_verified_attimestamp with time zoneread onlyEffectiveness verified at
effectiveness_verdicttextread onlyEffectiveness verdict
effectiveness_notestextread onlyEffectiveness notes
owner_iduuidread, writeOwner
raised_byuuidread onlyRaised by
raised_attimestamp with time zoneread onlyRaised at
due_datedateread, writeDue
closed_byuuidread onlyClosed by
closed_attimestamp with time zoneread onlyClosed at
statustextread onlyStatus
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 › Corrective & Preventive Actions 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.