Versioning of the Domain API
Windchill REST Services supports versioning of the APIs provided by a domain. Based on the ODATA protocol, Windchill REST Services too provides a new version of a domain for breaking changes such as removal of properties, changing the types of existing properties, adding or removing key properties, or reordering action or function parameters.
The domain configurations are defined in version specific folders, such as, v1, v2, v3, and so on. The default version that is used for a domain is set by the defaultVersion property in the <Domain Name>.json file for each domain.
Generally, the default version of a domain is set to the latest version. To avoid breaking existing client applications because of versioning of a domain, client applications should request a specific version of a domain using any of the following methods:
• Use a specific version of a domain in the URL HTTP request.
For example, a client can request version 1 of the Product Management domain using the following URL:
https://windchill.ptc.com/Windchill/servlet/odata/v1/ProdMgmt/
• Specify the version in the Accept header of the HTTP request.
For example, to request version 1 of the Product Management domain use the following URL:
https://windchill.ptc.com/Windchill/servlet/odata/ProdMgmt/
and specify the version in the Accept header as follows:
application/json;version=1
• Change the value of defaultVersion in the <Domain Name>.json file to an older value if you don't want the latest default value.