Update an action

Updated:

PUT/qms/{connection_id}/action/{id}

Updates the QmsAction identified by id. Provide the unified QmsAction fields to change in the request body.

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
idstring required
ID of the Action

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
affected_items array
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
metadata array

Returns

Response fieldTypeRequiredDescription
idstringNo
created_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
numberstringNoAction number, e.g. CAPA-0017
namestringNo
descriptionstringNo
typeenumNoValues: CORRECTIVE, PREVENTIVE, SUPPLIER_CORRECTIVE, OTHER
original_typestringNoThe vendor's own action type or template name
statusenumNoNormalized status of a quality record Values: OPEN, IN_PROGRESS, IN_REVIEW, CLOSED, CANCELLED
lifecycle_statestringNoVendor's own state or workflow step name
prioritystringNoVendor priority value
issue_idsstring[]NoThe QmsIssue IDs this action addresses
affected_itemsQmsAffectedItem[]No
affected_items[].part_idstringNoThe PlmPart (revision) ID, when the same vendor also provides PLM
affected_items[].document_idstringNoThe PlmDocument ID, when the same vendor also provides PLM
affected_items[].part_numberstringNo
affected_items[].revisionstringNo
affected_items[].lot_numberstringNo
affected_items[].serial_numberstringNo
affected_items[].quantitynumberNoQuantity affected
root_causestringNo
supplier_namestringNo
user_idstringNoOwner (reference to HrisEmployee)
due_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
closed_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
verified_atstring (date-time)NoWhen the effectiveness check was completed (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
file_idsstring[]NoAttachment IDs retrievable from StorageFile
urlstringNoDeep link to the vendor UI
metadataQmsMetadata[]No
metadata[].idstringNoThe ID of the custom field definition (from the metadata/metadata endpoint).
metadata[].slugstringNoThe integration's API name (key) of an existing custom field.
metadata[].valueobjectNoThe field's value, typed by format.
metadata[].namespacestringNo
metadata[].formatenumNoThe 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_dataobjectNo

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"
}
StatusErrorMeaning
400Bad RequestThe request was malformed or failed validation.
401UnauthorizedThe connection is likely broken; re-authorize it.
403ForbiddenThe connection is missing permissions or scopes.
404Not FoundThe requested resource does not exist.
429Too Many RequestsRate limit exceeded (see the two sources below).
500Internal Server ErrorAn unexpected error occurred.
501Not ImplementedNot 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: 'PUT',
  url: 'https://api.unified.to/qms/5de520f96e439b002043d8dc/action/5de520f96e439b002043d8d8',
  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?