Versão da API

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.

Agendamento de versões

A V1 foi preterida e removida em 7 de março de 2023.

APIs baseadas em versão

Versão da API	Permissões	Description
V1	• Anexos • AzureDevOpsConnector (obsoleto) • Recursos • Configuração • Conectores (descontinuados) • CustomFieldDefinitions (obsoleto) • CustomFieldValues • Defeitos • JiraCloudBasicAuthConnector (obsoleto) • JiraCloudOAuthConnector (descontinuado) • JiraConnectorWebHooks • JireServerConnector (obsoleto) • KPIs • ObjectLabels • Orchestrator • ProjectReports • Projetos (obsoleto) • RedmineConnector (obsoleto) • Requisitos (obsoleto) • ServerInfo • ServiceNowConnector (obsoleto) • Configurações • Telemetria • TestCaseLogs • TestCases • TestExecutions • TestSets • TestSteps • ThirdPartyAuth (obsoleto) • UserAuth • Usuários • UserSession • Configurações do Usuário • WebHookConfiguration (obsoleto) • XrayCloudConnector (obsoleto) • XrayConnectorWebhooks • XrayServerConnector (descontinuado)	Disponível para Administradores da Organização e usuários não administradores. Não protegido pelo controle de acesso baseado em função.
V2	• AzureDevOpsConnector • Conectores • Definições de campo personalizado • JiraCloudBasicAuthConnector • JiraCloudOAuthConnector • JiraServerConnector • Permissões do projeto • Projetos • QtestConnector • Redmine Connector • Requisitos • ServiceNow Connector • Configuração do WebHook • XrayCloudConnector • XrayServerConnector	Disponível para Administradores e Proprietários do Projeto.

Atualizar versão da API

Atualize a versão da API usando o Swagger para fazer chamadas de acesso baseadas em função.

Add /swagger/index.html to your Test Manager instance URL (e.g., https://testmanager.com/swagger/index.html).
Clique em Selecionar uma definição no topo da página e selecione V2 na lista suspensa.
Agora as solicitações incluem o número da versão como pode ser visto no exemplo a seguir.
```
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'
```