Issue data model
A nonconformance, complaint, audit finding or problem report
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 | Issue number, e.g. NCR-0042 |
name | string | No | |
description | string | No | |
type | enum | No | Values: NONCONFORMANCE, COMPLAINT, AUDIT_FINDING, PROBLEM_REPORT, OTHER |
original_type | string | No | The vendor's own issue 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 |
severity | enum | No | Values: LOW, MEDIUM, HIGH, CRITICAL |
source | enum | No | Where a quality issue was found Values: INTERNAL, SUPPLIER, CUSTOMER, AUDIT, OTHER |
disposition | enum | No | What to do with the nonconforming material Values: USE_AS_IS, REWORK, REPAIR, SCRAP, RETURN_TO_VENDOR, OTHER |
original_disposition | string | No | The vendor's own disposition name |
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 |
supplier_name | string | No | |
user_id | string | No | Owner or assignee (reference to HrisEmployee) |
reporter_user_id | string | No | Who raised the issue (reference to HrisEmployee) |
action_ids | string[] | No | Linked QmsAction IDs |
change_ids | string[] | No | Linked PlmChange IDs, when the same vendor also provides PLM |
opened_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
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) |
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?