Create an inspection
POST/qms/{connection_id}/inspection
Creates a QmsInspection. Provide the unified QmsInspection fields in the request body; they are mapped to the provider's API. Returns the created QmsInspection.
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
An inspection of a part, lot or serial against its requirements
idstring
created_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
numberstring
namestring
original_typestring
The vendor's own inspection type 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
result enum
Valid values:
"PASS"
"FAIL"
"CONDITIONAL"
plan_namestring
The inspection plan or template followed
part_idstring
The PlmPart (revision) ID, when the same vendor also provides PLM
part_numberstring
revisionstring
lot_numberstring
serial_numberstring
quantity_inspectednumber
quantity_acceptednumber
quantity_rejectednumber
supplier_namestring
issue_idsstring array
QmsIssue IDs raised from this inspection
user_idstring
Inspector (reference to HrisEmployee)
inspected_atdate-time
(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 | |
name | string | No | |
type | enum | No | Values: RECEIVING, IN_PROCESS, FINAL, FIRST_ARTICLE, SOURCE, OTHER |
original_type | string | No | The vendor's own inspection type 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 |
result | enum | No | Values: PASS, FAIL, CONDITIONAL |
plan_name | string | No | The inspection plan or template followed |
part_id | string | No | The PlmPart (revision) ID, when the same vendor also provides PLM |
part_number | string | No | |
revision | string | No | |
lot_number | string | No | |
serial_number | string | No | |
quantity_inspected | number | No | |
quantity_accepted | number | No | |
quantity_rejected | number | No | |
supplier_name | string | No | |
characteristics | QmsCharacteristic[] | No | |
characteristics[].name | string | No | |
characteristics[].specification | string | No | Requirement or drawing reference |
characteristics[].nominal_value | number | No | |
characteristics[].lower_limit | number | No | |
characteristics[].upper_limit | number | No | |
characteristics[].measured_value | string | No | Measured or observed value; text so attribute checks fit |
characteristics[].unit_of_measure | string | No | |
characteristics[].result | enum | No | Values: PASS, FAIL, CONDITIONAL |
characteristics[].notes | string | No | |
issue_ids | string[] | No | QmsIssue IDs raised from this inspection |
user_id | string | No | Inspector (reference to HrisEmployee) |
inspected_at | string (date-time) | No | (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/inspection',
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?