topic Re: REST API End Hook Documentation is Missing in Windchill Customization

REST API End Hook Documentation is Missing

JK_12731035 — Sun, 12 Jan 2025 17:40:12 GMT

Version: Windchill 13.0

Use Case: REST API end hooks

Description:

I am investigating a possible project using the Windchill REST API. The documentation page is here:
https://support.ptc.com/help/windchill_rest_services/r1.6/en/index.html#page/windchill_rest_services/WCCG_RESTAPIs_Javadoc_JSdoc.html#

Both the links on that page lead to a missing page.

Where is the REST API end hook documentation?

Re: REST API End Hook Documentation is Missing

VladimirN — Sun, 12 Jan 2025 19:27:22 GMT

Please also report this by email: documentation@ptc.com

Re: REST API End Hook Documentation is Missing

LB_9980481 — Mon, 13 Jan 2025 00:48:19 GMT

Starting with Windchill REST Services 13.0.2.0, the WRS Javadoc location has been combined with Windchill Javadoc, that lead to a change of the WRS Javadoc location.

This change is due to the integration of WRS with Windchill.

The Windchill REST Services 13.0.2.0 release includes the following developer documents:

- Javadoc, which is available at:

https://<Windchill_Server>/Windchill/wt/clients/library/api/index.html

- JSDoc for the built-in code hooks, which is available at:

https://<Windchill_Server>/Windchill/netmarkets/html/wrs/jsdoc/index.html

Re: REST API End Hook Documentation is Missing

JK_12731035 — Mon, 13 Jan 2025 11:03:14 GMT

I do not know the customer's server domain name, and it would take a long time and be difficult for them to obtain that information from elsewhere within their organization. I am trying to help one team within a large company, but I cannot assist them in writing a proposal if I don't even know the capabilities of the Windchill SDK API because the documentation is hidden.

Where can I find documentation for the Windchill SDK REST end hooks?

Re: REST API End Hook Documentation is Missing

JK_12731035 — Mon, 13 Jan 2025 16:36:00 GMT

I need to know the capabilities of the Windchill SDK before I make any promises about what I can do with it. I cannot do that if the documentation is being hidden. This is a time-sensitive matter.

Re: REST API End Hook Documentation is Missing

LB_9980481 — Mon, 13 Jan 2025 16:50:55 GMT

Starting from Windchill 11.1, JavaDoc is no longer available online (PTC hosted) and needs to be downloaded locally from Reference Documents.

https://www.ptc.com/support/-/media/support/refdocs/Windchill_PDMLink/13,-d-,0/WindchillJavadoc_13_0_2_0.zip

Re: REST API End Hook Documentation is Missing

HelesicPetr — Wed, 15 Jan 2025 10:51:35 GMT

Hi @JK_12731035

JavaDoc has prvided @LB_9980481 but RestAPI documentation is not public and you can get it only from the existing Windchill server.

As a developer you have to have the Windchill installation for development purpose and there is no another option if you want to access to the documentation that is not Public

CS335170 - API Catalog for OData REST Services (Swagger)

PetrH