Document data model
One revision of an engineering document
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) |
master_identifier | string | No | Vendor ID shared by every revision of the same document; not a unified object |
number | string | No | |
name | string | No | |
description | string | No | |
revision | string | No | |
status | enum | No | Normalized lifecycle status of a part or document revision Values: IN_WORK, IN_REVIEW, RELEASED, OBSOLETE, OTHER |
lifecycle_state | string | No | |
type | enum | No | Normalized document type Values: DRAWING, CAD_MODEL, SPECIFICATION, PROCEDURE, REPORT, OTHER |
original_type | string | No | The vendor's own document type name |
category_id | string | No | The PlmCategory the document is filed under (reference to AccountingCategory) |
part_ids | string[] | No | Related PlmPart IDs |
file_ids | string[] | No | Attachment IDs retrievable from StorageFile |
user_id | string | No | (reference to HrisEmployee) |
url | string | No | |
metadata | PlmMetadata[] | 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?