Summary of Changes for Windchill REST Services 2.7
Changes in Windchill REST Services 2.7 are described in this section.
Windchill REST Services 2.7 is included with the following Windchill releases:
• 13.0.1.0
• 13.0.0.4
• 12.1.2.7
• 12.0.2.16
General Capabilities
The following are the updates:
• Introduced the LatestRevision property in the Change Management domain v6 and v7 to support filtering change objects with latest revision.
• The Document entity in the Document Management domain now inherits the classifiable Windchill capability.
• Introduced the DownloadContentInfo complex type and the DownloadContentAsZip unbound action in version 4 of the PTC domain.
• The GetWindchillMetaInfo() function now returns the following information defined in the Type Manager:
◦ The “Date and Time” attributes for the format property.
◦ The “Real Numbers”, “Real Number with units”, and “Integer” attributes for the Currency property.
• Ability to update attributes on the object's master:
◦ Master soft attributes can now be updated using the UpdateCommonProperties bound action.
◦ Updating master IBAs through the action does not create a new iteration.
◦ To update a master soft attribute, it must have an equivalent alias attribute defined on the versioned object type. For example, with an IBA myPartMasterAttr on WTPartMaster, you must also have an alias on WTPart myAliasToPartMasterAttr with the mapping masterReference^wt.part.WTPartMaster~myPartMasterAttr.
◦ In the EDM, these alias attributes to master IBAs now have the annotation PTC.UpdateableViaAction to indicate that they can be updated using the UpdateCommonProperties bound action.
• Starting with Windchill REST Services 2.7, the configuration option IncludeImportedEntitySets in domain configurations (import.json) is deprecated and will be removed in a future release of Windchill REST Services. It is recommended to set to it false until its removal.
• The new unbound function
GetWindchillVersion(), in the
PTC domain returns a list of installed modules and the currently installed version of Windchill.
• A new bound function GetLifeCycleTemplate() is now available on entities which inherit the lifecycleManaged capability. This function returns the life cycle template associated with the lifecycle managed, along with all its states.
WRS Supported API Change Report
You can use the Changes to OData REST APIs report to compare and view the changes between WRS 2.6 and the latest WRS 2.7 release.
For more information, see the
WRS Supported API Change Report topic in the “Windchill REST Services 2.7 Help Center” available on the
Windchill Help Centers page.
Updates to the BOM Transformation Domain
The following are the updates to the BOM Transformation domain:
• Enhanced the existing GetManufacturingBOM action to return the manufacturing raw material links or co-produce usage links based on the option filters applied to the upstream and downstream part structures, respectively.
• Enhanced the following existing actions to return the manufacturing raw material links based on the option filters applied to the upstream and downstream part structures, respectively:
◦ GetRawMaterialsForParts
◦ GetRawMaterialsForPartsWithInlineNavCriteria
◦ GetMadeFromSetData
◦ GetMadeFromSetDataWithInlineNavCriteria
◦ GetMadeFromSetForParts using $expand on RawMaterialLink
◦ GetMadeFromSetForPartsWithInlineNavCriteria using $expand on RawMaterialLink
• Enhanced the following existing actions to return the co-produce usage links based on the option filters applied to the upstream and downstream part structures, respectively:
◦ GetCoproduceData
◦ GetCoproduceDataWithInlineNavCriteria
◦ GetCoproduceForParts using $expand on CoProduceUsageLinks
◦ GetCoproduceForPartsWithInlineNavCriteria using $expand on CoProduceUsageLinks
• Enhanced the existing GenerateDownstreamStructure API to provide the ability to specify the downstream root part, TargetRoot, and the downstream parent part, TargetPart, optionally.
• Added the ability to generate a downstream structure from one or more downstream templates optionally in the context of change (change task or change notice).
Updates to the CAD Document Management Domain
The following is the update to the CAD Document Management domain:
Ability to retrieve the dynamic structure representation from a CAD document with QuickView capability.
Updates to the Change Management Domain
The following is the update to the Change Management domain:
Enhanced the following existing APIs in the domain v6 and v7 to return the LatestRevision attribute for the change objects:
• GET /ChangeRequests
• GET /ProblemReports
• GET /ChangeNotices
• GET /ChangeTasks
• GET /Variances
Updates to the PTC Common Domain
The following is the update to the PTC Common domain:
Added the DownloadContentAsZip unbound action to download the application-data content items for a single or multiple content holder entities as a zip-stream.
Updates to the Document Management Domain
The following are the updates to the Document Management domain:
• Enhanced the existing GET /Documents API to retrieve the classification attributes of classified documents.
• Enhanced the existing POST /Documents API to create a classified document.
• Enhanced the existing POST /CreateDocuments API to create multiple classified documents.
• Enhanced the existing PATCH /Documents('{DocumentID}') API to update a specific classified document.
• Enhanced the existing POST /UpdateDocuments API to update multiple classified documents.
Updates to the Manufacturing Process Management Domain
The following are the updates to the Manufacturing Process Management domain:
• Enhanced the existing POST /ProcessPlans API to support the optional attributes, LongDescription and a change object (change notice) ID, which can be provided in the request body when creating a process plan or a standard procedure.
• Enhanced the existing POST /CreateProcessPlans API to support the optional attributes, LongDescription and a change object (change notice) ID, which can be provided in the request body when creating a single or multiple process plans and standard procedures.
• Enhanced the existing GET /ProcessPlans API to retrieve the LongDescription attribute.
• Enhanced the existing GET /ProcessPlans('{ProcessPlanID}') API to retrieve the LongDescription attribute.
• Enhanced the existing PATCH /ProcessPlans('{ProcessPlanID}') API to update the LongDescription attribute value.
• Enhanced the existing POST /UpdateProcessPlans API to update the LongDescription attribute value.
Updates to the Product Management Domain
The following is the update to the Product Management domain:
Ability to retrieve the dynamic structure representation from a part with QuickView capability.
Updates to the Product Platform Management Domain
The following is the update to the Product Platform Management domain:
Enhanced the POST /GetAssignedExpressions API to retrieve the RawMaterialLink and CoProduceUsageLink entities.
Updates to the Reporting Domain
The following are the updates to the Reporting domain:
• Starting with Windchill REST Services 2.7, the API version 3 is the new default version of the domain. PTC recommends that you use the default version v3 in the API requests.
• Enhanced the existing API for report template execution to return the output of Java methods in the report results.