Create a change
POST/plm/{connection_id}/change
Creates a PlmChange. Provide the unified PlmChange fields in the request body; they are mapped to the provider's API. Returns the created PlmChange.
Parameters
fieldsstring array
Fields to return
rawstring
Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar
connection_idstring required
ID of the connection
Payload
A change request, order or notice
idstring
created_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
numberstring
Change number, e.g. ECO-0042
namestring
descriptionstring
type enum
Valid values:
"REQUEST"
"ORDER"
"NOTICE"
"DEVIATION"
"OTHER"
category_idstring
The PlmCategory the change is filed under (reference to AccountingCategory)
prioritystring
Vendor priority value
effective_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
expires_atdate-time
When a temporary change (deviation) expires (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
user_idstring
Originator (reference to HrisEmployee)
approved_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
implemented_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
urlstring
Returns
| Response 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 |
Errors
Errors return the HTTP status code and a JSON body with statusCode, error (the short label) and message (a human-readable detail).
{
"statusCode": 429,
"error": "Too Many Requests",
"message": "Too many requests to unified.to API; max requests per minute: N"
}| Status | Error | Meaning |
|---|---|---|
400 | Bad Request | The request was malformed or failed validation. |
401 | Unauthorized | The connection is likely broken; re-authorize it. |
403 | Forbidden | The connection is missing permissions or scopes. |
404 | Not Found | The requested resource does not exist. |
429 | Too Many Requests | Rate limit exceeded (see the two sources below). |
500 | Internal Server Error | An unexpected error occurred. |
501 | Not Implemented | Not supported by this integration. |
Errors from the underlying integration pass through: the integration's status comes back as ours (429, 401, 403, 404 or 5xx), usually with its message. When the integration's error body is unclear, Unified extracts what it can and returns a clearer message.
429 Too Many Requests
A 429 has two possible sources:
- The integration's own rate limit, passed through.
- Unified's workspace limit: a rolling 60 seconds, set by plan, with the message
Too many requests to unified.to API; max requests per minute: N.
const options = {
method: 'POST',
url: 'https://api.unified.to/plm/5de520f96e439b002043d8dc/change',
headers: {
authorization: 'bearer .....'
},
data: undefined,
params: {
fields: '',
raw: '',
}
};
const results = await axios.request(options); Are we missing anything? Let us know
Was this page helpful?