API-Version

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.

Versionszeitplan

V1 ist veraltet und wurde am 7. März 2023 entfernt.

Versionsbasierte APIs

API-Version	Berechtigungen	Beschreibung
V1	• Anhänge • AzureDevOpsConnector (veraltet) • Fähigkeiten • Konfiguration • Connectors (veraltet) • CustomFieldDefinitions (veraltet) • CustomFieldValues • Defekte • JiraCloudBasicAuthConnector (veraltet) • JiraCloudOAuthConnector (veraltet) • JiraConnectorWebHooks • JireServerConnector (veraltet) • KPIs • ObjectLabels • Orchestrator • ProjectReports • Projekte (veraltet) • RedmineConnector (veraltet) • Anforderungen (veraltet) • ServerInfo • ServiceNowConnector (veraltet) • Einstellungen • Telemetrie • TestCaseLogs • TestCases • TestExecutions • TestSets • TestSteps • ThirdPartyAuth (veraltet) • UserAuth • Benutzer • UserSession • Benutzereinstellungen • WebHookConfiguration (veraltet) • XrayCloudConnector (veraltet) • XrayConnectorWebhooks • XrayServerConnector (veraltet)	Verfügbar für Organisationsadministratoren und Nicht-Administratorbenutzer. Nicht durch die rollenbasierte Zugriffskontrolle geschützt.
V2	• AzureDevOpsConnector • Konnektoren • CustomFieldDefinitions • JiraCloudBasicAuthConnector • JiraCloudOAuthConnector • JiraServerConnector • ProjectPermissions • Projekte • QtestConnector • RedmineConnector • Anforderungen • ServiceNowConnector • WebHook-Konfiguration • XrayCloudConnector • XrayServerConnector	Verfügbar für Administratoren und Projektbesitzer.

API-Version aktualisieren

Aktualisieren Sie die API-Version mit Swagger, um rollenbasierte Zugriffsaufrufe zu erstellen.

Add /swagger/index.html to your Test Manager instance URL (e.g., https://testmanager.com/swagger/index.html).
Klicken Sie oben auf der Seite auf Definition auswählen und wählen Sie V2 aus der Dropdownliste aus.
Die Anfragen beinhalten nun die Versionsnummer, wie im folgenden Beispiel zu erkennen.
```
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'
```