Create a part

Updated:

POST/plm/{connection_id}/part

Creates a PlmPart. Provide the unified PlmPart fields in the request body; they are mapped to the provider's API. Returns the created PlmPart.

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

One revision of a part or item

idstring
Unique identifier of this part revision
created_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
master_identifierstring
Vendor ID shared by every revision of the same part (Windchill WTPartMaster, Aras config_id); not a unified object
numberstring
Part number
namestring
descriptionstring
revisionstring
Revision label, e.g. B
status enum
Valid values:
"IN_WORK"
"IN_REVIEW"
"RELEASED"
"OBSOLETE"
"OTHER"
Normalized lifecycle status
lifecycle_statestring
Vendor's own lifecycle state or phase name
type enum
Valid values:
"COMPONENT"
"ASSEMBLY"
"RAW_MATERIAL"
"SOFTWARE"
"DOCUMENT_ONLY"
Normalized part type
original_typestring
The vendor's own part type or category name
category_idstring
The PlmCategory the part is filed under (reference to AccountingCategory)
source enum
Valid values:
"MAKE"
"BUY"
"OTHER"
Whether a part is made in-house or bought
unit_of_measurestring
is_assemblyboolean
Whether the part has BOM children
user_idstring
Owner or creator (reference to HrisEmployee)
document_idsstring array
Related PlmDocument IDs
file_idsstring array
Attachment IDs retrievable from StorageFile
urlstring
Deep link to the vendor UI
metadata array

Returns

Response fieldTypeRequiredDescription
idstringNoUnique identifier of this part revision
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)
master_identifierstringNoVendor ID shared by every revision of the same part (Windchill WTPartMaster, Aras config_id); not a unified object
numberstringNoPart number
namestringNo
descriptionstringNo
revisionstringNoRevision label, e.g. B
statusenumNoNormalized lifecycle status Values: IN_WORK, IN_REVIEW, RELEASED, OBSOLETE, OTHER
lifecycle_statestringNoVendor's own lifecycle state or phase name
typeenumNoNormalized part type Values: COMPONENT, ASSEMBLY, RAW_MATERIAL, SOFTWARE, DOCUMENT_ONLY, OTHER
original_typestringNoThe vendor's own part type or category name
category_idstringNoThe PlmCategory the part is filed under (reference to AccountingCategory)
sourceenumNoWhether a part is made in-house or bought Values: MAKE, BUY, OTHER
unit_of_measurestringNo
is_assemblybooleanNoWhether the part has BOM children
user_idstringNoOwner or creator (reference to HrisEmployee)
document_idsstring[]NoRelated PlmDocument IDs
file_idsstring[]NoAttachment IDs retrievable from StorageFile
urlstringNoDeep link to the vendor UI
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: 'POST',
  url: 'https://api.unified.to/plm/5de520f96e439b002043d8dc/part',
  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?