Update a change

Updated:

PUT/plm/{connection_id}/change/{id}

Updates the PlmChange identified by id. Provide the unified PlmChange fields to change in the request body.

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
idstring required
ID of the Change

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)
status enum
Valid values:
"OPEN"
"IN_REVIEW"
"APPROVED"
"IMPLEMENTED"
"REJECTED"
prioritystring
Vendor priority value
affected_items array
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
metadata array

Returns

Response fieldTypeRequiredDescription
idstringNo
created_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
numberstringNoChange number, e.g. ECO-0042
namestringNo
descriptionstringNo
typeenumNoValues: REQUEST, ORDER, NOTICE, DEVIATION, OTHER
category_idstringNoThe PlmCategory the change is filed under (reference to AccountingCategory)
statusenumNoValues: OPEN, IN_REVIEW, APPROVED, IMPLEMENTED, REJECTED, CANCELLED
prioritystringNoVendor priority value
affected_itemsPlmAffectedItem[]No
affected_items[].part_idstringNo
affected_items[].document_idstringNo
affected_items[].from_revisionstringNo
affected_items[].to_revisionstringNo
affected_items[].new_lifecycle_statestringNo
affected_items[].dispositionstringNoWhat to do with existing stock or work in progress
effective_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
expires_atstring (date-time)NoWhen a temporary change (deviation) expires (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
user_idstringNoOriginator (reference to HrisEmployee)
approved_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
implemented_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
urlstringNo
metadataPlmMetadata[]No
metadata[].idstringNoThe ID of the custom field definition (from the metadata/metadata endpoint).
metadata[].slugstringNoThe integration's API name (key) of an existing custom field.
metadata[].valueobjectNoThe field's value, typed by format.
metadata[].namespacestringNo
metadata[].formatenumNoThe 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_dataobjectNo

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"
}
StatusErrorMeaning
400Bad RequestThe request was malformed or failed validation.
401UnauthorizedThe connection is likely broken; re-authorize it.
403ForbiddenThe connection is missing permissions or scopes.
404Not FoundThe requested resource does not exist.
429Too Many RequestsRate limit exceeded (see the two sources below).
500Internal Server ErrorAn unexpected error occurred.
501Not ImplementedNot 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: 'PUT',
  url: 'https://api.unified.to/plm/5de520f96e439b002043d8dc/change/5de520f96e439b002043d8d8',
  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?