Windchill Service Parts REST APIs
Windchill Service Parts provides REST APIs to access parts list, parts list item and illustration data. The APIs expose read-only information to web services such as ThingWorx. They can be used by any client that is capable of making an HTTP request.
|
|
A user interface for these APIs is not provided.
|
• /v1/partslists – Returns all parts lists that match specified criteria
◦ Input:
▪ select – determines the properties (attributes) of the parts lists that are returned by the query
An
OData select expression that is a comma-separated list of property names. A property name must be the internal name of the property as it appears in the
Windchill Type and Attribute Manager for the object type.
Specify an asterisk (*) to include all the attributes of the PartsList object type as defined in the Windchill Type and Attribute Manager.
Leave the list empty to return the default list of properties.
This parameter is optional.
▪ filter – defines a filter for the query
An
OData filter criteria in the form
<propertyName> <operator> '<value>' [and | or | not]..., where
operator is
eq or
ne or
le or other
OData comparison operators.
For example, number eq '0000222341'.
This parameter is optional.
▪ navigationCriteria – adds further control to the list of parts lists that is returned
The Windchill object identifier (OID) of the navigation criteria or the navigation criteria name or JSON that can be parsed into a navigation criteria.
If the searched object is not iterated, it is not necessary to specify the navigation criteria.
If the value is not specified, the latest version is chosen.
This parameter is optional.
◦ Output:
▪ Either a list of parts lists (PartsList objects) or an error code and error message
See Error Codes.
• /v1/partslists/{partsListId} – Returns a parts list with a specified ID
◦ Input:
▪ partsListId – specifies the parts list’s identifier in an organization context
The value must be in the format <organizationName><delimiter><number>, for example Demo Organization_0000222341.
This parameter is required.
▪ select – determines the properties (attributes) displayed for the parts list returned by the query
An
OData select expression that is a comma-separated list of property names. A property name must be the internal name of the property as it appears in the
Windchill Type and Attribute Manager for the object type.
Specify an asterisk (*) to include all the attributes of the PartsList object type as defined in the Windchill Type and Attribute Manager.
This parameter is optional.
◦ Output:
▪ Either a single parts list (PartsList object) or an error code and error message
See Error Codes.
• /v1/partslists/{partsListId}/items – Returns all parts list items in a specified parts list
◦ Input:
▪ partsListId – specifies the parts list’s identifier in an organization context
The value must be in the format <organizationName><delimiter><number>, for example Demo Organization_0000222341.
This parameter is required.
▪ select – determines the properties (attributes) of the parts lists items that are returned by the query
An
OData select expression that is a comma-separated list of property names. A property name must be the internal name of the property as it appears in the
Windchill Type and Attribute Manager for the object type.
Specify an asterisk (*) to include all the attributes of the PartsListItem object type as defined in the Windchill Type and Attribute Manager.
This parameter is optional.
▪ filter – defines a filter for the query
An
OData filter criteria in the form
<propertyName> <operator> '<value>' [and | or | not]..., where
operator is
eq or
ne or
le or other
OData comparison operators.
For example, number eq '0000222341'.
This parameter is optional.
◦ Output:
▪ Either a list of parts list items (PartsListItem objects) or an error code and error message
See Error Codes.
• /v1/partslists/{partsListId}/items/{partsListItemId} – Returns a parts list item with a specified ID in a specified parts list
◦ Input:
▪ partsListId – specifies the parts list’s identifier in an organization context
The value must be in the format <organizationName><delimiter><number>, for example Demo Organization_0000222341.
This parameter is required.
▪ partsListItemId – specifies the identifier of the parts list item
As the parts list item is a descendant of the parts list, the descendant identifier is sufficient.
This parameter is required.
▪ select – determines the properties (attributes) of the parts lists item returned by the query
An
OData select expression that is a comma-separated list of property names. A property name must be the internal name of the property as it appears in the
Windchill Type and Attribute Manager for the object type.
Specify an asterisk (*) to include all the attributes of the PartsListItem object type as defined in the Windchill Type and Attribute Manager.
This parameter is optional.
◦ Output:
▪ Either a single parts list item (PartsListItem object) or an error code and error message
See Error Codes.
• /v1/partslists/{partsListId}/items/{partsListItemId}/part – Returns the part associated with a specified parts list item in a specified parts list
◦ Input:
▪ partsListId – specifies the parts list’s identifier in an organization context
The value must be in the format <organizationName><delimiter><number>, for example Demo Organization_0000222341.
This parameter is required.
▪ partsListItemId – specifies the identifier of the parts list item
As the parts list item is a descendant of the parts list, the descendant identifier is sufficient.
This parameter is required.
▪ select – determines the properties (attributes) of the part returned by the query
An
OData select expression that is a comma-separated list of property names. A property name must be the internal name of the property as it appears in the
Windchill Type and Attribute Manager for the object type.
Specify an asterisk (*) to include all the attributes of the object type as defined in the Windchill Type and Attribute Manager.
This parameter is optional.
◦ Output:
▪ Either a single part object or an error code and error message
▪ See Error Codes.
• /v1/partslists/{partsListId}/itemrelations – Returns all item relations (substitute and supplementary parts) in a specified parts list
◦ Input:
▪ partsListId – specifies the parts list’s identifier in an organization context
The value must be in the format <organizationName><delimiter><number>, for example Demo Organization_0000222341.
This parameter is required.
▪ select – determines the properties (attributes) displayed for the substitute and supplementary parts that are returned by the query
An
OData select expression that is a comma-separated list of property names. A property name must be the internal name of the property as it appears in the
Windchill Type and Attribute Manager for the object type.
Specify an asterisk (*) to include all the attributes of the PartsListItemSubstituteLink and SupplementaryReplacementLink object types as defined in the Windchill Type and Attribute Manager.
This parameter is optional.
▪ navigationCriteria – adds further control to the list of supplementary and substitute parts that is returned
The Windchill object identifier (OID) of the navigation criteria or the navigation criteria name or JSON that can be parsed into a navigation criteria.
If the searched object is not iterated, it is not necessary to specify the navigation criteria.
If the value is not specified, the latest version is chosen.
This parameter is optional.
◦ Output:
▪ Either a list of substitute parts (PartsListItemSubstituteLink objects) and supplementary parts (SupplementaryReplacementLink objects) or an error code and error message
See Error Codes.
• /v1/partslists/{partsListId}/items/{partsListItemId}/itemrelations – Returns all item relations (substitute and supplementary parts) for a specified parts list item in a specified parts list
◦ Input:
▪ partsListId – specifies the parts list’s identifier in an organization context
The value must be in the format <organizationName><delimiter><number>, for example Demo Organization_0000222341.
This parameter is required.
▪ partsListItemId – specifies the identifier of the parts list item
As the parts list item is a descendant of the parts list, the descendant identifier is sufficient.
This parameter is required.
▪ select – determines the properties (attributes) displayed for the substitute and supplementary parts that are returned by the query
An
OData select expression that is a comma-separated list of property names. A property name must be the internal name of the property as it appears in the
Windchill Type and Attribute Manager for the object type.
Specify an asterisk (*) to include all the attributes of the PartsListItemSubstituteLink and SupplementaryReplacementLink object types as defined in the Windchill Type and Attribute Manager.
This parameter is optional.
▪ navigationCriteria – adds further control to the list of supplementary and substitute parts that is returned
The Windchill object identifier (OID) of the navigation criteria or the navigation criteria name or JSON that can be parsed into a navigation criteria.
If the searched object is not iterated, it is not necessary to specify the navigation criteria.
If the value is not specified, the latest version is chosen.
This parameter is optional.
◦ Output:
▪ Either a list of substitute parts (PartsListItemSubstituteLink objects) and supplementary parts (SupplementaryReplacementLink objects) or an error code and error message
See Error Codes.
• /v1/partslists/{partsListId}/itemrelations/substitute – Returns all substitute parts in a specified parts list
◦ Input:
▪ partsListId – specifies the parts list’s identifier in an organization context
The value must be in the format <organizationName><delimiter><number>, for example Demo Organization_0000222341.
This parameter is required.
▪ select – determines the properties (attributes) displayed for the substitute parts that are returned by the query
An
OData select expression that is a comma-separated list of property names. A property name must be the internal name of the property as it appears in the
Windchill Type and Attribute Manager for the object type.
Specify an asterisk (*) to include all the attributes of the PartsListItemSubstituteLink object type as defined in the Windchill Type and Attribute Manager.
This parameter is optional.
▪ filter – defines a filter for the query
An
OData filter criteria in the form
<propertyName> <operator> '<value>' [and | or | not]..., where
operator is
eq or
ne or
le or other
OData comparison operators.
For example, number eq '0000222341'.
This parameter is optional.
◦ Output:
▪ Either a list of substitute parts (PartsListItemSubstituteLink objects) or an error code and error message
See Error Codes.
• /v1/partslists/{partsListId}/items/{partsListItemId}/itemrelations/substitute – Returns all substitute parts for a specified parts list item in a specified parts list
◦ Input:
▪ partsListId – specifies the parts list’s identifier in an organization context
The value must be in the format <organizationName><delimiter><number>, for example Demo Organization_0000222341.
This parameter is required.
▪ partsListItemId – specifies the identifier of the parts list item
As the parts list item is a descendant of the parts list, the descendant identifier is sufficient.
This parameter is required.
▪ select – determines the properties (attributes) displayed for the substitute parts that are returned by the query
An
OData select expression that is a comma-separated list of property names. A property name must be the internal name of the property as it appears in the
Windchill Type and Attribute Manager for the object type.
Specify an asterisk (*) to include all the attributes of the PartsListItemSubstituteLink object type as defined in the Windchill Type and Attribute Manager.
This parameter is optional.
◦ Output:
▪ Either a list of substitute parts (PartsListItemSubstituteLink objects) or an error code and error message
See Error Codes.
• /v1/partslists/{partsListId}/itemrelations/supplementary – Returns all supplementary parts in a specified parts list
◦ Input:
▪ partsListId – specifies the parts list’s identifier in an organization context
The value must be in the format <organizationName><delimiter><number>, for example Demo Organization_0000222341.
This parameter is required.
▪ select – determines the properties (attributes) displayed for the supplementary parts that are returned by the query
An
OData select expression that is a comma-separated list of property names. A property name must be the internal name of the property as it appears in the
Windchill Type and Attribute Manager for the object type.
Specify an asterisk (*) to include all the attributes of the SupplementaryReplacementLink object type as defined in the Windchill Type and Attribute Manager.
This parameter is optional.
▪ filter – defines a filter for the query
An
OData filter criteria in the form
<propertyName> <operator> '<value>' [and | or | not]..., where
operator is
eq or
ne or
le or other
OData comparison operators.
For example, number eq '0000222341'.
This parameter is optional.
◦ Output:
▪ Either a list of supplementary parts (SupplementaryReplacementLink objects) or an error code and error message
See Error Codes.
• /v1/partslists/{partsListId}/items/{partsListItemId}/itemrelations/supplementary – Returns all supplementary parts for a specified parts list item in a specified parts list
◦ Input:
▪ partsListId – specifies the parts list’s identifier in an organization context
The value must be in the format <organizationName><delimiter><number>, for example Demo Organization_0000222341.
This parameter is required.
▪ partsListItemId – specifies the identifier of the parts list item
As the parts list item is a descendant of the parts list, the descendant identifier is sufficient.
This parameter is required.
▪ select – determines the properties (attributes) displayed for the supplementary parts that are returned by the query
An
OData select expression that is a comma-separated list of property names. A property name must be the internal name of the property as it appears in the
Windchill Type and Attribute Manager for the object type.
Specify an asterisk (*) to include all the attributes of the SupplementaryReplacementLink object type as defined in the Windchill Type and Attribute Manager.
This parameter is optional.
▪ navigationCriteria – adds further control to the list of supplementary parts that is returned
The Windchill object identifier (OID) of the navigation criteria or the navigation criteria name or JSON that can be parsed into a navigation criteria.
If the searched object is not iterated, it is not necessary to specify the navigation criteria.
If the value is not specified, the latest version is chosen.
This parameter is optional.
◦ Output:
▪ Either a list of supplementary parts (SupplementaryReplacementLink objects) or an error code and error message
See Error Codes.
• /v1/partslists/{partsListId}/illustrations – Returns all illustrations in a specified parts list
◦ Input:
▪ partsListId – specifies the parts list’s identifier in an organization context
The value must be in the format <organizationName><delimiter><number>, for example Demo Organization_0000222341.
This parameter is required.
▪ select – determines the properties (attributes) displayed for the illustrations that are returned by the query
An
OData select expression that is a comma-separated list of property names. A property name must be the internal name of the property as it appears in the
Windchill Type and Attribute Manager for the object type.
Specify an asterisk (*) to include all the attributes of the DynamicDocument object type as defined in the Windchill Type and Attribute Manager.
This parameter is optional.
▪ filter – defines a filter for the query
An
OData filter criteria in the form
<propertyName> <operator> '<value>' [and | or | not]..., where
operator is
eq or
ne or
le or other
OData comparison operators.
For example, number eq '0000222341'.
This parameter is optional.
◦ Output:
▪ Either a list of illustrations (DynamicDocument objects) or an error code and error message
See Error Codes.
• /v1/partslists/{partsListId}/illustrations/{illustrationId} – Returns an illustration with a specified ID in a specified parts list
◦ Input:
▪ partsListId – specifies the parts list’s identifier in an organization context
The value must be in the format <organizationName><delimiter><number>, for example Demo Organization_0000222341.
This parameter is required.
▪ illustrationId – specifies the identifier of the illustration
As the illustration is a descendant of the parts list, the descendant identifier is sufficient.
This parameter is required.
▪ select – determines the properties (attributes) displayed for the illustration returned by the query
An
OData select expression that is a comma-separated list of property names. A property name must be the internal name of the property as it appears in the
Windchill Type and Attribute Manager for the object type.
Specify an asterisk (*) to include all the attributes of the DynamicDocument object type as defined in the Windchill Type and Attribute Manager.
This parameter is optional.
◦ Output:
▪ Either a single illustration (DynamicDocument object) or an error code and error message
See Error Codes.
• /v1/partslists/{partsListId}/illustrations/{illustrationId}/image – Returns the image associated with a specified illustration in a specified parts list
◦ Input:
▪ partsListId – specifies the parts list’s identifier in an organization context
The value must be in the format <organizationName><delimiter><number>, for example Demo Organization_0000222341.
This parameter is required.
▪ illustrationId – specifies the identifier of the illustration
As the illustration is a descendant of the parts list, the descendant identifier is sufficient.
This parameter is required.
▪ select – determines the properties (attributes) displayed for the image returned by the query
An
OData select expression that is a comma-separated list of property names. A property name must be the internal name of the property as it appears in the
Windchill Type and Attribute Manager for the object type.
Specify an asterisk (*) to include all the attributes of the object type as defined in the Windchill Type and Attribute Manager.
This parameter is optional.
◦ Output:
▪ Either a single image object or an error code and error message
See Error Codes.
Error Codes
This table describes the error codes and message that you could encounter when running these services.
|
Code
|
Description
|
|
200
|
Successful response
|
|
400
|
URL or query parameters are incorrectly formatted
|
|
404
|
Specified object doesn’t exist
|
|
500
|
Unexpected error
|
