--- title: "Action data model" url: "https://docs.unified.to/qms/action/model" description: "The Action data model object in Unified's Action API: 22 fields, including created_at, updated_at and number, with types and enum values." date: "2026-11-13T20:19:18.258Z" updated: "2026-11-13T20:19:18.258Z" --- # Action data model Updated: November 13, 2026 A corrective or preventive action (CAPA) View field support, webhooks, and list parameters for each integration on the [Supported Integrations](https://docs.unified.to/qms/integrations.md) 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 | | ## TypeScript ```typescript export type QmsAction = { id?: string; created_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) updated_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) number?: string; // Action number, e.g. CAPA-0017 name?: string; description?: string; type?: 'CORRECTIVE' | 'PREVENTIVE' | 'SUPPLIER_CORRECTIVE' | 'OTHER'; original_type?: string; // The vendor's own action type or template name status?: 'OPEN' | 'IN_PROGRESS' | 'IN_REVIEW' | 'CLOSED' | 'CANCELLED'; // Normalized status of a quality record lifecycle_state?: string; // Vendor's own state or workflow step name priority?: string; // Vendor priority value issue_ids?: string[]; // The QmsIssue IDs this action addresses affected_items?: []; root_cause?: string; supplier_name?: string; user_id?: string; // Owner (reference to HrisEmployee) due_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) closed_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) verified_at?: string-time; // When the effectiveness check was completed (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) file_ids?: string[]; // Attachment IDs retrievable from StorageFile url?: string; // Deep link to the vendor UI metadata?: []; raw?: any; // Raw data from integration } ``` ## Zod ```typescript import { z } from 'zod'; export const ZodQmsAction = z.object({ id: z.string().optional(), created_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"), updated_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"), number: z.string().optional().describe("Action number, e.g. CAPA-0017"), name: z.string().optional(), description: z.string().optional(), type: z.enum("CORRECTIVE", "PREVENTIVE", "SUPPLIER_CORRECTIVE", "OTHER").optional(), original_type: z.string().optional().describe("The vendor's own action type or template name"), status: z.enum("OPEN", "IN_PROGRESS", "IN_REVIEW", "CLOSED", "CANCELLED").optional().describe("Normalized status of a quality record"), lifecycle_state: z.string().optional().describe("Vendor's own state or workflow step name"), priority: z.string().optional().describe("Vendor priority value"), issue_ids: z.array().optional().describe("The QmsIssue IDs this action addresses"), affected_items: z.array().optional(), root_cause: z.string().optional(), supplier_name: z.string().optional(), user_id: z.string().optional().describe("Owner (reference to HrisEmployee)"), due_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"), closed_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"), verified_at: z.string-time().optional().describe("When the effectiveness check was completed (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"), file_ids: z.array().optional().describe("Attachment IDs retrievable from StorageFile"), url: z.string().optional().describe("Deep link to the vendor UI"), metadata: z.array().optional(), }); ``` ## Python ```python import dataclasses @dataclasses.dataclass class QmsActionType(str, Enum): CORRECTIVE = 'CORRECTIVE' PREVENTIVE = 'PREVENTIVE' SUPPLIER_CORRECTIVE = 'SUPPLIER_CORRECTIVE' OTHER = 'OTHER' @dataclasses.dataclass class QmsActionStatus(str, Enum): OPEN = 'OPEN' IN_PROGRESS = 'IN_PROGRESS' IN_REVIEW = 'IN_REVIEW' CLOSED = 'CLOSED' CANCELLED = 'CANCELLED' @dataclasses.dataclass class QmsAction: id: Optional[str] """(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)""" created_at: Optional[str] """(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)""" updated_at: Optional[str] """Action number, e.g. CAPA-0017""" number: Optional[str] name: Optional[str] description: Optional[str] type: Optional[QmsActionType] """The vendor's own action type or template name""" original_type: Optional[str] """Normalized status of a quality record""" status: Optional[QmsActionStatus] """Vendor's own state or workflow step name""" lifecycle_state: Optional[str] """Vendor priority value""" priority: Optional[str] """The QmsIssue IDs this action addresses""" issue_ids: Optional[List[List[str]]] affected_items: Optional[PropertyQmsActionAffected_items] root_cause: Optional[str] supplier_name: Optional[str] """Owner (reference to HrisEmployee)""" user_id: Optional[str] """(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)""" due_at: Optional[str] """(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)""" closed_at: Optional[str] """When the effectiveness check was completed (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)""" verified_at: Optional[str] """Attachment IDs retrievable from StorageFile""" file_ids: Optional[List[List[str]]] """Deep link to the vendor UI""" url: Optional[str] metadata: Optional[PropertyQmsActionMetadata] ```