Updating API version

Switch your API calls from v1 to v2 in Swagger to enforce role-based access control at the project level.

Update the API version using Swagger to make role-based access calls.

Steps

1. Add /swagger/index.html to your Test Manager instance URL (for example, https://testmanager.com/swagger/index.html).
2. Select Select a definition at the top of the page and select V2 from the dropdown list.

Result

The requests include the version number and use role-based access control in the project's scope.

The following example shows a request with the version number. For the version schedule and the lists of APIs, see API version.

curl -X 'GET' \
  'https://company/testmanager/companyTenant/testmanager_/api/v2/projects' \
  -H 'accept: application/json'

The following image shows an API call that retrieves projects in Swagger.