QaCONNECT REST API Versioning
The Worksoft SaaS QaCONNECT REST API has multiple versions. Our versioning strategy allows our customers to continue using an older version of the QaCONNECT REST API and migrate their applications (REST Services client code) to the newer version of the API when they are ready.
When a new version of an API is made available to its customers, Worksoft SaaS usually specifies an 'last date of support' for a previous version of the API. Please refer to the Versions page for the QaCONNECT REST API for a list of currently supported versions along with the release date and the last date of support.
Please note that every change to REST services will NOT trigger the roll out of a new version of the QaCONNECT REST services. Only 'Breaking Changes' will usually trigger the roll out of a new version of services where as 'Non-Breaking Changes' don't.
Breaking changes include:
- a change in the format of the response data for one or more calls
- a change in the response type (i.e. changing an integer to a float)
- removing any part of the API
How to access a specific version of the QaCONNECT REST API?
Worksoft SaaS follows a versioning through URI Path strategy that uses URI routing to point to a specific version of our API.
To access a specific version, just add the letter v followed by the version number to the start of the request path. For example, here's a call to version 2.1, use the URI:
"https://www.web.worksoft.cloud/rest/v2.1/:domainname/executions"
How to view a list of changes that got rolled out for the QaCONNECT REST API?
Since all Breaking Changes are rolled out as part of new version of the QaCONNECT REST API, please refer to the Supported Versions page for the QaCONNECT REST API for a list of changes and enhancements rolled out by version. Please do note that the support for older versions of the REST API will end on a specific date. If you continue to use an older version of the REST API, if you don't migrate your QaCONNECT REST API client application code to the newer version of our API before the last date of support for the older version, you will experience a disruption in service. Please pay attention to the last date of support for the version you are using and plan and implement the migration to newer version as soon as possible.
The Non-breaking Changes are listed separately grouped by date of the change the Non-breaking Changelog that can be accessed here.
Seeing list of services available as part of a version on the QaCONNECT REST API DOCS page
The Worksoft SaaS QaCONNECT REST API DOCS page, by default, lists the services available as part of the latest version of the API. If you want to view the list of services available as part of an older but supported version of the REST API, simply choose the version number from the version drop-down at the top of the DOCS page.
Please note that the DOCS page will NOT give you the ability to view the services that are part of an older version of the API that is currently unsupported.