Audit data model
An internal, supplier, customer or certification audit
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 | |
name | string | No | |
description | string | No | |
type | enum | No | Values: INTERNAL, SUPPLIER, CUSTOMER, CERTIFICATION, OTHER |
original_type | string | No | The vendor's own audit 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 |
standard | string | No | Standard audited against, e.g. AS9100D |
scope | string | No | |
supplier_name | string | No | |
user_id | string | No | Lead auditor (reference to HrisEmployee) |
scheduled_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
start_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
end_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) |
issue_ids | string[] | No | Findings, as QmsIssue IDs |
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?