Create a part
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
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
Returns
| Response field | Type | Required | Description |
|---|---|---|---|
id | string | No | Unique identifier of this part revision |
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) |
master_identifier | string | No | Vendor ID shared by every revision of the same part (Windchill WTPartMaster, Aras config_id); not a unified object |
number | string | No | Part number |
name | string | No | |
description | string | No | |
revision | string | No | Revision label, e.g. B |
status | enum | No | Normalized lifecycle status Values: IN_WORK, IN_REVIEW, RELEASED, OBSOLETE, OTHER |
lifecycle_state | string | No | Vendor's own lifecycle state or phase name |
type | enum | No | Normalized part type Values: COMPONENT, ASSEMBLY, RAW_MATERIAL, SOFTWARE, DOCUMENT_ONLY, OTHER |
original_type | string | No | The vendor's own part type or category name |
category_id | string | No | The PlmCategory the part is filed under (reference to AccountingCategory) |
source | enum | No | Whether a part is made in-house or bought Values: MAKE, BUY, OTHER |
unit_of_measure | string | No | |
is_assembly | boolean | No | Whether the part has BOM children |
user_id | string | No | Owner or creator (reference to HrisEmployee) |
document_ids | string[] | No | Related PlmDocument IDs |
file_ids | string[] | No | Attachment IDs retrievable from StorageFile |
url | string | No | Deep link to the vendor UI |
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/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?