Accessing REST APIs in OData
You can access documentation for Windchill and PTC FlexPLM REST endpoints, including implementation notes, response classes, parameters, and response messages at the following URLs:
• Servlet root URL: <host>/Windchill/servlet/RFA-Odata/v1
This URL returns a list of entity sets, which match
PTC FlexPLM types. For more information, see the OData specification part 2, section 3 at
http://www.odata.org/documentation/.
• Metadata: <host>/Windchill/servlet/RFA-Odata/v1/$metadata
The Entity Data Model (EDM) is the internal system to define the type system service. Data is converted from the
Windchill and
PTC FlexPLM type system to the EDM and presented as an XML document. For more information, see the OData specification part 2, section 4.1 at
http://www.odata.org/documentation/.
• Entity sets: <host>/Windchill/servlet/RFA-Odata/v1/<entity set name>
For example, http://server.yourcompany.com/Windchill/servlet/RFA-Odata/v1/Colors
This URL is the main endpoint to perform create, read, update, delete (CRUD), or query operations.