Summary of Changes for Windchill REST Services 2.5
Changes in Windchill REST Services 2.5 are described in this section.
General Capabilities
• Enhancements in the CAD Document Management and Product Management domains to support searching or filtering on the newly added navigations and attributes.
• Enhancements in the Product Management domain to support searching or filtering on the AssociationType property for its newly added Calculated value.
• Enhancements in the UDI domain to support searching or filtering a non-revisable or revisable UDI super set.
• Ability to set the "required" parameter for a navigation property to indicate whether it is a mandatory navigation property or not.
• From WRS 2.5 onwards, you cannot expand multiple levels on a navigation property using
$levels when the source
type and target
type are different. This behavior is in compliance with
OData specification. If you are using URLs in which the source
type and target
type are different, you are advised to change those.
• Support for paging actions. Ability to mark an action as pageable with the isPageable configuration property. A new request header PTC.enablePagination of type boolean is introduced. If it is set to true, a response returned to the client will be paginated.
• GetWindchillMetaInfo() now also includes the PropertyType field that flags persistent attributes like model-based attributes (MBA) and instance-based attributes (IBA), as well as non-persisted attributes (NPA) and server-calculated attributes (SCA).
WRS Supported API Change Report
You can use the Changes to OData REST APIs report to compare and view the changes between WRS 2.4 and the latest WRS 2.5 release.
For more information, see the
WRS Supported API Change Report topic in the “Windchill REST Services 2.5 Help Center” available on the
Windchill Help Centers page.
Updated Olingo Library to Version 4.9.0
The Olingo library used for Windchill REST Services 2.5 is updated to version 4.9.0.
New Domain Added
The following new domain has been added to Windchill REST Services 2.5:
PTC View Management Domain (ViewMgmt)—Provides access to the “View” administration capabilities of Windchill. This domain enables clients to read the Views available in the Windchill system.
Updates to the Business Administrative Change Management Domain
The following are the updates to the Business Administrative Change Management domain:
• Added support for previewing, exporting, and importing the administrative changes for the following created or updated object types:
◦ Document Template
◦ Global Enumeration
◦ Measurement System
◦ Access Control Rule
◦ Quantity of Measure
◦ Report Template
◦ Reusable Attribute
◦ Shared Table View
◦ List-Based Version Scheme
• Added support for deleting the administrative changes that are exported or imported for the following object types:
◦ Document Template
◦ Global Enumeration
◦ Measurement System
◦ Access Control Rule
◦ Quantity of Measure
◦ Report Template
◦ Reusable Attribute
◦ Shared Table View
◦ List-Based Version Scheme
The object types supported in Windchill REST Services 2.5 are not functional with the Windchill 12.0.2.10 and 12.1.1.3 release versions.
Updates to the BOM Transformation Domain
The following are the updates to the BOM Transformation domain:
• Ability to retrieve existing downstream objects for a single or multiple upstream parts.
• Ability to create equivalent links between the downstream part or assembly and the upstream part or assembly, optionally in the context of change (change task or change notice).
• Ability to update the out-of-date equivalent links in the downstream structure without resolving discrepancies, optionally in the context of change (change task or change notice).
• Ability to remove equivalent links for the downstream part iterations, optionally in the context of change (change task or change notice).
• Ability to create a single or multiple equivalent usage links.
• Ability to subcontract upstream or downstream parts and subassemblies to other plants, optionally in the context of change (change task or change notice).
• Ability to copy the parts and subassemblies to be subcontracted from the upstream to a part in the downstream, optionally in the context of change (change task or change notice).
• Ability to detect discrepancies between upstream and downstream structures in the BOM transformer.
• Ability to resolve discrepancies detected between upstream and downstream structures in the BOM transformer of the Auto status only.
• Ability to detect all discrepancies and resolve only the “Auto” discrepancies in the BOM transformer optionally in the context of change (change task or change notice).
• Ability to create a new downstream branch for a single or multiple upstream parts, optionally in the context of change (change task or change notice).
• Ability to create a new downstream part for an upstream assembly, optionally in the context of change (change task or change notice).
• Ability to create new downstream alternates from existing downstream iterations, optionally in the context of change (change task or change notice).
• Ability to create one or more alternate assemblies in the downstream view from existing assemblies in the upstream or downstream view optionally in the context of change (change task or change notice).
• Ability to create one or more split assemblies in the downstream view from existing assemblies in the upstream or downstream view, optionally in the context of change (change task or change notice).
• Ability to resolve “Interactive” discrepancies detected between upstream and downstream structures in the BOM transformer.
• Ability to generate a downstream structure from an upstream structure using a customizable logic optionally in the context of change (change task or change notice).
• Ability to copy parts from the upstream structure and paste them “as is” in the downstream structure in the BOM transformer optionally in the context of change (change task or change notice).
• Ability to copy parts from the upstream structure and paste them as a new part each in the downstream structure in the BOM transformer, optionally in the context of change (change task or change notice).
• Ability to copy parts from the upstream structure and paste them as a new branch iteration each in the downstream structure in the BOM transformer optionally in the context of change (change task or change notice).
• Ability to copy parts from the upstream structure and paste them in the downstream structure, optionally in the context of change (change task or change notice) based on the configuration specified in the automatic BOM transformation template.
• Ability to add one or more scrap parts as secondary members to a single or multiple Co-produce objects, optionally in the context of change (change task or change notice) in the independent co-produce mode.
• Ability to add one or more co-produce usage links to a single or multiple Co-produce objects, optionally in the context of change (change task or change notice) in the independent co-produce mode.
• Enhanced the UpdateCoProduceUsageLinks API to update the Quantity, Unit, and Consumption attributes for a single or multiple Co-produce usage links in the independent co-produce mode.
• Enhanced the UpdateCoProduceUsageLinks API to update the Category attribute for a single or multiple Co-produce usage links.
• Enhanced the UpdateRawMaterialLinks API to update the Category attribute for a single or multiple manufacturing Raw Material links.
• Enhanced the CoProduceUsageLinks API to retrieve the Category attribute for one or more Co-produce usage links.
• Enhanced the MadeFromLink API to retrieve the Category attribute for one or more Made From links.
• Ability to remove one or more co-produce usage links for a single or multiple Co-produce objects optionally in the context of change (change task or change notice) in the independent co-produce mode.
Updates to the CAD Document Management Domain
The following are the updates to the CAD Document Management domain:
• Enhanced the GetStructure API to additionally return information whether the CAD document structure is incomplete when the user does not have access to one or more child components.
• Enhanced the GetStructure API to additionally return information whether a component in the CAD document structure has child components.
• Enhanced the PartDocAssociations API to additionally retrieve the calculated associations between a CAD drawing and parts.
• Ability to retrieve the CAD document structure along with siblings using a single or multiple path filters on CAD document uses.
• Ability to navigate from a CAD document to the related drawings.
• Ability to retrieve the CAD document structure and navigate to the related drawings.
Updates to the Document Management Domain
The following is the update to the Document Management domain:
Ability to retrieve a document structure.
Updates to the Enterprise Systems Integration Domain
The following are the updates to the Enterprise Systems Integration domain:
• Ability to update in a single call the status of one or more subtransactions in a transaction and the status of the transaction for the specified primary Windchill business object, accordingly.
• Ability to update the status of one or more subtransactions in a transaction.
• Ability to update the status of a transaction.
Using these APIs, you can update the actual status of the object imports, or data that is exchanged, in an ERP/MES system in Windchill.
The data delivered by the ESI/ERPConnector solution to the target system is automatically acknowledged because, by default the ESI > Settings > Transaction > Enable Post Result preference is set to Yes in Windchill.
When the preference is set to No, the ESI transaction status is displayed as Pending until the Release To Manufacturing workflow receives a confirmation of the publication status from the external system. Using these APIs, you can update the status based on how the data is imported or consumed in an ERP/MES system, and the ESI transaction is updated accordingly.
In the case of a failure, the Release To Manufacturing workflow enables you to resolve the errors or data anomalies, and to resume the export until the source and target systems are synchronized.
Updates to the Navigation Criteria Domain
The following is the update to the Navigation Criteria domain:
Ability to retrieve the navigation criteria that are hidden, visible, and accessible to the user using the PTC.includeHiddenFilter request header.
Updates to the Product Management Domain
The following are the updates to the Product Management domain:
• The GetBOM and GetBOMWithInlineNavCriteria actions are deprecated and will be removed in a future release of Windchill REST Services. PTC recommends that you use the GetPartStructure action instead.
• Enhanced the GetPartStructure API to additionally return information whether a part is resolved and whether the BOM is incomplete when the user does not have access to one or more child components.
• Enhanced the GetPartStructure API to additionally return information whether a component in the part structure has child components.
• Enhanced the PartDocAssociations API to additionally retrieve the calculated associations between a part and CAD drawings.
• Enhanced the UpdateRawMaterialLinks API to update the Category attribute for a single or multiple manufacturing Raw Material links.
• Enhanced the MadeFromLink API to retrieve the Category attribute for one or more Made From links.
• Enhanced the CreateAssociations API to skip the creation of the calculated association if specified in the request.
• Enhanced the DeleteAssociations API to skip the deletion of the calculated association if specified in the request.
• Ability to upload attachments to a part only when the Part Management > Attachments on parts preference is set to Yes in Windchill.
• Ability to update the attachments to a part or the attributes of attachments only when the Part Management > Attachments on parts preference is set to Yes in Windchill.
• Ability to retrieve the attachments for a part only when the Part Management > Attachments on parts preference is set to Yes in Windchill.
• Ability to delete attachments for a part.
• Ability to retrieve the thumbnails configured for a part.
• Ability to delete the thumbnails configured for a part.
• Ability to retrieve the part structure along with siblings using a single or multiple path filters on usages or occurrences.
Updates to the UDI Domain
The following are the updates to the UDI domain:
• Starting with WRS 2.5, the API versions 1, 2, and 3 and their endpoints are deprecated and will be removed in a future release of Windchill REST Services. The API version 4 is the new and default version of the UDI domain. PTC recommends that you use the default version, that is, v4 in the API requests.
• The SubmittedFor action is deprecated and will be removed in a future release of Windchill REST Services. PTC recommends that you use the Subject action instead.
• Ability to create a non-revisable UDI super set with an associated subject.
• Ability to create a revisable UDI super set.
• Ability to create a revisable UDI super set with one or more associated subjects.
• Ability to create a revisable UDI super set with one or more associated details.
• Ability to create a revisable UDI super set with one or more associated packaging configurations.
• Ability to retrieve an associated subject for a non-revisable UDI super set.
• Ability to retrieve the associated subjects for a revisable UDI super set.
• Ability to retrieve details for a revisable UDI super set.
• Ability to retrieve packaging configurations for a revisable UDI super set.
• Ability to retrieve the template assigned to a revisable UDI super set.