Change data model
A change request, order or notice
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 | Change number, e.g. ECO-0042 |
name | string | No | |
description | string | No | |
type | enum | No | Values: REQUEST, ORDER, NOTICE, DEVIATION, OTHER |
category_id | string | No | The PlmCategory the change is filed under (reference to AccountingCategory) |
status | enum | No | Values: OPEN, IN_REVIEW, APPROVED, IMPLEMENTED, REJECTED, CANCELLED |
priority | string | No | Vendor priority value |
affected_items | PlmAffectedItem[] | No | |
affected_items[].part_id | string | No | |
affected_items[].document_id | string | No | |
affected_items[].from_revision | string | No | |
affected_items[].to_revision | string | No | |
affected_items[].new_lifecycle_state | string | No | |
affected_items[].disposition | string | No | What to do with existing stock or work in progress |
effective_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
expires_at | string (date-time) | No | When a temporary change (deviation) expires (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
user_id | string | No | Originator (reference to HrisEmployee) |
approved_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
implemented_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
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?