Windchill REST API: Recommended Version for Testing, Cloud Availability, Authentication & Swagger

[SL_14436555]

Hello Team,

We are currently evaluating the feasibility of integrating with Windchill using REST APIs (Windchill REST Services – WRS) and would appreciate guidance from the community on the following points:

1. Recommended Windchill Version / WRS API Set
   Since REST APIs vary across Windchill versions, which Windchill version and corresponding WRS API set is generally recommended for initial API testing and validation?

2. Windchill Cloud Availability
   Is Windchill Cloud / Windchill+ available for customers?
   If yes, are there any known differences in REST API behavior or availability compared to On-Premise deployments?

3. REST API Authentication
   What is the recommended authentication mechanism for Windchill REST APIs?

   • OAuth 2.0

   • Bearer token

   • Any other supported method
     Also, does the authentication approach differ between Cloud and On-Premise environments?

4. Swagger / Open API Documentation
   Is there any official Swagger or Open API specification available that lists all Windchill REST APIs?

   • If available, where can it be accessed?

   • If not, what is the best way to discover and validate REST endpoints for a specific Windchill version?

Note: Since there is no public trial or sandbox environment, we are looking for guidance to align our API testing with supported and best-practice configurations.

Thanks in advance for your help.

[vnamboodheri]

Hi @SL_14436555, 

Thank you for your question. 

Your post appears well documented but has not yet received any response. I am replying to raise awareness. Hopefully, another community member will be able to help.

Also, feel free to add any additional information you think might be relevant. It sometimes helps to have screenshots to better understand what you are trying to do.

Best Regards,

Vivek N
Community Moderation Team

[tarik_p]

@SL_14436555  emm a lot of questions!

ESI

- Actually, REST APIs is the recommended approach for Enterprise System Integration and the only ESI approach for Windchill plus! Please use it for all new integrations.

Two Frameworks 

- Windchill REST API has two frameworks; the old one is based on RESTEasy, and the new one is based on OData, while the old framework is still available...it's mandatory to use the new one (OData).

WRS releases vs Windchill releases

- Regarding your question that WRS releases are different from Windchill, it's no longer the case; starting from Windchill PLM 13.0.2.0, Windchill REST Services no longer has its own releases but follow the same release of Windchill PLM.

Historically, when PTC introduced its new REST framework based on OData, they chose to make a separate distinction between Windchill PLM releases and REST releases. Their strategy was explained as follows: because Windchill PLM releases are slow in comparison with CPS cadence (every 3 months in general) - CPS are only for bug and security issues fixes - but bring new features of OData REST. Now, they have changed this approach to return to what they were following for the old REST framework. Now, no WRS release, but its version is the same as the Windchill PLM release, but they continue to bring new features in REST in CPS streams, see: https://support.ptc.com/help/windchill/r13.0.2.0/en/Windchill_Help_Center/NewandChanged/NewandChanged_13_0_20_WRSWindchillIntegration.html# 

I believe the new approach (matching releases) is more suitable for many reasons...

Doc

- Yes, WRS is documented using Swagger Technology:

Authentication

WRS supports almost all kinds of AuthN. The industry standard is to use SSO, so you may need to implement authentication through OAuth 2.0.

Reference

As a general documentation, you can start with this hub; it contains some outdated information but is still useful: 

Article - CS254366 - [Knowledge Hub] Windchill REST Services (WRS)

BR,

Tarik Wifak.