Action data model
A corrective or preventive action (CAPA)
View field support, webhooks, and list parameters for each integration on the Supported Integrations page.
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | |
created_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
updated_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
number | string | No | Action number, e.g. CAPA-0017 |
name | string | No | |
description | string | No | |
type | enum | No | Values: CORRECTIVE, PREVENTIVE, SUPPLIER_CORRECTIVE, OTHER |
original_type | string | No | The vendor's own action type or template name |
status | enum | No | Normalized status of a quality record Values: OPEN, IN_PROGRESS, IN_REVIEW, CLOSED, CANCELLED |
lifecycle_state | string | No | Vendor's own state or workflow step name |
priority | string | No | Vendor priority value |
issue_ids | string[] | No | The QmsIssue IDs this action addresses |
affected_items | QmsAffectedItem[] | No | |
affected_items[].part_id | string | No | The PlmPart (revision) ID, when the same vendor also provides PLM |
affected_items[].document_id | string | No | The PlmDocument ID, when the same vendor also provides PLM |
affected_items[].part_number | string | No | |
affected_items[].revision | string | No | |
affected_items[].lot_number | string | No | |
affected_items[].serial_number | string | No | |
affected_items[].quantity | number | No | Quantity affected |
root_cause | string | No | |
supplier_name | string | No | |
user_id | string | No | Owner (reference to HrisEmployee) |
due_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
closed_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
verified_at | string (date-time) | No | When the effectiveness check was completed (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
file_ids | string[] | No | Attachment IDs retrievable from StorageFile |
url | string | No | Deep link to the vendor UI |
metadata | QmsMetadata[] | No | |
metadata[].id | string | No | The ID of the custom field definition (from the metadata/metadata endpoint). |
metadata[].slug | string | No | The integration's API name (key) of an existing custom field. |
metadata[].value | object | No | The field's value, typed by format. |
metadata[].namespace | string | No | |
metadata[].format | enum | No | The data type of the custom field, which determines how value is formatted. Values: TEXT, NUMBER, DATE, BOOLEAN, FILE, TEXTAREA, SINGLE_SELECT, MULTIPLE_SELECT, MEASUREMENT, PRICE, YES_NO, CURRENCY, URL |
metadata[].extra_data | object | No |
Are we missing anything? Let us know
Was this page helpful?