Part data model
One revision of a part or item
View field support, webhooks, and list parameters for each integration on the Supported Integrations page.
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | Unique identifier of this part revision |
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 part (Windchill WTPartMaster, Aras config_id); not a unified object |
number | string | No | Part number |
name | string | No | |
description | string | No | |
revision | string | No | Revision label, e.g. B |
status | enum | No | Normalized lifecycle status Values: IN_WORK, IN_REVIEW, RELEASED, OBSOLETE, OTHER |
lifecycle_state | string | No | Vendor's own lifecycle state or phase name |
type | enum | No | Normalized part type Values: COMPONENT, ASSEMBLY, RAW_MATERIAL, SOFTWARE, DOCUMENT_ONLY, OTHER |
original_type | string | No | The vendor's own part type or category name |
category_id | string | No | The PlmCategory the part is filed under (reference to AccountingCategory) |
source | enum | No | Whether a part is made in-house or bought Values: MAKE, BUY, OTHER |
unit_of_measure | string | No | |
is_assembly | boolean | No | Whether the part has BOM children |
user_id | string | No | Owner or creator (reference to HrisEmployee) |
document_ids | string[] | No | Related PlmDocument IDs |
file_ids | string[] | No | Attachment IDs retrievable from StorageFile |
url | string | No | Deep link to the vendor UI |
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?