Create an action
POST/qms/{connection_id}/action
Creates a QmsAction. Provide the unified QmsAction fields in the request body; they are mapped to the provider's API. Returns the created QmsAction.
Parameters
fieldsstring array
Fields to return
rawstring
Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar
connection_idstring required
ID of the connection
Payload
A corrective or preventive action (CAPA)
idstring
created_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
numberstring
Action number, e.g. CAPA-0017
namestring
descriptionstring
type enum
Valid values:
"CORRECTIVE"
"PREVENTIVE"
"SUPPLIER_CORRECTIVE"
"OTHER"
original_typestring
The vendor's own action type or template name
status enum
Valid values:
"OPEN"
"IN_PROGRESS"
"IN_REVIEW"
"CLOSED"
"CANCELLED"
Normalized status of a quality record
lifecycle_statestring
Vendor's own state or workflow step name
prioritystring
Vendor priority value
issue_idsstring array
The QmsIssue IDs this action addresses
root_causestring
supplier_namestring
user_idstring
Owner (reference to HrisEmployee)
due_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
closed_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
verified_atdate-time
When the effectiveness check was completed (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
file_idsstring array
Attachment IDs retrievable from StorageFile
urlstring
Deep link to the vendor UI
Returns
| Response 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 |
Errors
Errors return the HTTP status code and a JSON body with statusCode, error (the short label) and message (a human-readable detail).
{
"statusCode": 429,
"error": "Too Many Requests",
"message": "Too many requests to unified.to API; max requests per minute: N"
}| Status | Error | Meaning |
|---|---|---|
400 | Bad Request | The request was malformed or failed validation. |
401 | Unauthorized | The connection is likely broken; re-authorize it. |
403 | Forbidden | The connection is missing permissions or scopes. |
404 | Not Found | The requested resource does not exist. |
429 | Too Many Requests | Rate limit exceeded (see the two sources below). |
500 | Internal Server Error | An unexpected error occurred. |
501 | Not Implemented | Not supported by this integration. |
Errors from the underlying integration pass through: the integration's status comes back as ours (429, 401, 403, 404 or 5xx), usually with its message. When the integration's error body is unclear, Unified extracts what it can and returns a clearer message.
429 Too Many Requests
A 429 has two possible sources:
- The integration's own rate limit, passed through.
- Unified's workspace limit: a rolling 60 seconds, set by plan, with the message
Too many requests to unified.to API; max requests per minute: N.
const options = {
method: 'POST',
url: 'https://api.unified.to/qms/5de520f96e439b002043d8dc/action',
headers: {
authorization: 'bearer .....'
},
data: undefined,
params: {
fields: '',
raw: '',
}
};
const results = await axios.request(options); Are we missing anything? Let us know
Was this page helpful?