Update a bomline

Updated:

PUT/plm/{connection_id}/bomline/{id}

Updates the PlmBomline identified by id. Provide the unified PlmBomline 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 Bomline

Payload

One parent to child usage in a bill of materials

idstring
created_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
parent_part_idstring
The assembly
child_part_idstring
The component's PlmPart ID (a revision ID)
child_revisionstring
Pinned child revision, when the line pins one
quantitynumber
unit_of_measurestring
line_numberstring
Find or item number on the BOM
reference_designatorsstring array
effective_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
expires_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
notesstring

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)
parent_part_idstringNoThe assembly
child_part_idstringNoThe component's PlmPart ID (a revision ID)
child_revisionstringNoPinned child revision, when the line pins one
quantitynumberNo
unit_of_measurestringNo
line_numberstringNoFind or item number on the BOM
reference_designatorsstring[]No
effective_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
expires_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
notesstringNo

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/bomline/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?