test-manager
latest
false
- Getting started
- Project management
- Documents
- Working with Change Impact Analysis
- Create test cases
- Assigning test cases to requirements
- Cloning test cases
- Exporting test cases
- Linking test cases in Studio to Test Manager
- Delete test cases
- Manual test cases
- Importing manual test cases
- Document test cases with Task Capture
- Parameters
- Enabling governance at project level
- Disabling governance at project level
- Enabling governance at test-case level
- Disabling governance at test-case level
- Managing approvers for governed test cases
- Managing governed test cases in the In Work state
- Managing governeed test cases in the In Review state
- Managing governed objects in the Signed state
- Managing comments for governed test cases
- Applying filters and views
- Importing Orchestrator test sets
- Creating test sets
- Adding test cases to a test set
- Assigning default users in test set execution
- Enabling activity coverage
- Enabling Healing Agent
- Configuring test sets for specific execution folders and robots
- Overriding parameters
- Cloning test sets
- Exporting test sets
- Applying filters and views
- Accessibility testing for Test Cloud
- Searching with Autopilot
- Project operations and utilities
- Test Manager settings
- ALM tool integration
- API integration
- Troubleshooting
Test Manager user guide
Last updated May 6, 2026
Test Manager provides two API versions through which you can integrate. The first version of the APIs is not protected with role-based access control. The second version of the APIs is protected with role-based access control in a given project's scope. Several legacy APIs are only accessible by Organization Administrators. The second version of these APIs can now be accessed by Project Owners too, even if they are not Organization Administrators.
Version schedule
V1 has been deprecated and removed on March 7 2023.
Version-based APIs
| API Version | Permissions | Description |
|---|---|---|
| V1 | • Attachments • AzureDevOpsConnector (deprecated) • Capabilities • Configuration • Connectors (deprecated) • CustomFieldDefinitions (deprecated) • CustomFieldValues • Defects • JiraCloudBasicAuthConnector (deprecated) • JiraCloudOAuthConnector (deprecated) • JiraConnectorWebHooks • JireServerConnector (deprecated) • KPIs • ObjectLabels • Orchestrator • ProjectReports • Projects (deprecated) • RedmineConnector (deprecated) • Requirements (deprecated) • ServerInfo • ServiceNowConnector (deprecated) • Settings • Telemetry • TestCaseLogs • TestCases • TestExecutions • TestSets • TestSteps • ThirdPartyAuth (deprecated) • UserAuth • Users • UserSession • UserSettings • WebHookConfiguration (deprecated) • XrayCloudConnector (deprecated) • XrayConnectorWebhooks • XrayServerConnector (deprecated) | Available for Organization Administrators and non-admin users. Not protected through role-based access control. |
| V2 | • AzureDevOpsConnector • Connectors • CustomFieldDefinitions • JiraCloudBasicAuthConnector • JiraCloudOAuthConnector • JiraServerConnector • ProjectPermissions • Projects • QtestConnector • RedmineConnector • Requirements • ServiceNowConnector • WebHookConfiguration • XrayCloudConnector • XrayServerConnector | Available for Admins and Project Owners. |
Update API Version
Update the API version using Swagger to make role-based access calls.
- Add
/swagger/index.htmlto your Test Manager instance URL (e.g.,https://testmanager.com/swagger/index.html). - Click Select a definition at the top of the page and select V2 from the dropdown list.
Now the requests include the version number as you can see in the following example.
curl -X 'GET' \
'https://company/testmanager/companyTenant/testmanager_/api/v2/projects' \
-H 'accept: application/json'
curl -X 'GET' \
'https://company/testmanager/companyTenant/testmanager_/api/v2/projects' \
-H 'accept: application/json'
Related articles