REST SERVICES IN WINDCHILL
1
ARCHITECTURE R11 RESTFUL WEB SERVICES
Windchill
List of Web Service Classes Codebase
(rest.properties)
2) Read Web Service Classes and JAX-RS
Annotations
Servlet Engine
1) Initialize REST
Application
GET /Windchill/rest/objects/
Application Configuration REST Easy Servlet
Class JSON Output
3) Load Web Service
4) Configure Classes
Container
Web
findObjects()
GET /rest/objects Object Web Service
GET /rest/structure/objects Structured Web Service Server
GET /rest/structure/drawings Drawing Web Service
GET
Viewable Service
/rest/visualization/objects
Windchill Services
Version Persistenc
Identity WIP Core REST
Control e
Database
2
OBJECT SERVICE
• Object Web Service
– Resource: /objects
– Allows querying Windchill objects and their specified attributes
– Applies to Windchill business objects
Method Name Description Relative URL HTTP Method
Get Object By Id Queries the Windchill object specified by its object identifier string /{oid} GET
Find Objects Returns a list of Windchill object ids that meet the specified query / GET
criteria
3
STRUCTURE SERVICE
• Structure Web Service
– Resource: /structure/objects
– Allows navigation of objects that are linked together to form tree structures
– Applies to Parts, Documents, CAD Documents
Method Name Description Relative URL HTTP Method
Get Object By Id Queries the Windchill object specified by its object identifier string /{oid} GET
Find Objects Returns a list of Windchill object ids that meet the specified query / GET
criteria
Get Descendants Gets child objects for a given Windchill object for multiple levels /{oid}/descendants GET
Get Ancestors Gets the parent objects for a given Windchill object for multiple /{oid}/ancestors GET
levels
Get Uses Summaries Gets child objects for a given Windchill object with link /{oid}/usesSummaries GET
information (supports multiple levels)
Get Used By Summaries Gets parent objects for a given Windchill object with link /{oid}/usedBySummaries GET
information (supports multiple levels)
4
VIEWABLE SERVICE
• Viewable Web Service
– Resource: /visualization/objects
– Allows access to Windchill visualization data
– Applies to Parts, CAD Documents
Method Name Description Relative URL HTTP Method
Get Viewable Gets links to representation and files for a given representable /{oid} GET
object
5
SAVED SEARCH SERVICE
• Saved Search Web Service
– Resource: /search/saved-searches
– Allows access to searches saved in Windchill
Method Name Description Relative URL HTTP Method
Find Saved Search Find a saved search based on given criteria / GET
Get Saved Search Get a saved search given its object identifier string /{oid} GET
Execute Saved Search Execute a saved search identified by its object identifier string /{oid}/results POST
6
DRAWING SERVICE
• Drawing Web Service
– Resource: /structure/drawings
– Allows access to drawings tied to CAD Documents and Parts
Method Name Description Relative URL HTTP Method
Find Drawing Finds a drawing for the given part or CAD Document number / GET
7
SWAGGER UI
• Accessing Swagger UI
– Enable site preference “Client Customization”
– Navigate to Customization > Documentation > REST APIs to launch Swagger UI
8
TESTING WITH SWAGGER UI
• Testing a Windchill RESTful Service
• Enter parameter values for the RESTful
service
• Swagger UI generates the HTTP request
to call the service and displays results
