API-Version

API-Versionen, die im Test Manager verfügbar sind und die rollenbasierten Zugriffssteuerungs-Scope-Unterschiede zwischen v1 und v2 in Automation Suite abdecken.

Der Test Manager bietet zwei API-Versionen, über die Sie integrieren können. Die erste Version der APIs ist nicht durch eine rollenbasierte Zugriffskontrolle geschützt. Die zweite Version der APIs ist mit rollenbasierter Zugriffskontrolle im Scope eines bestimmten Projekts geschützt. Mehrere veraltete APIs sind nur für Organisationsadministratoren zugänglich. Auf die zweite Version dieser APIs können jetzt auch die Projektbesitzer zugreifen, auch wenn sie keine Organisationsadministratoren sind.

Versionszeitplan

V1 wurde im April 2023 (Release 2023.4) veraltet und entfernt, sowohl für die eigenständige als auch für die Automation Suite-Version des Test Managers.

Versionsbasierte APIs

API-Version	Berechtigungen	Beschreibung
V1	• Attachments • AzureDevOpsConnector (veraltet) • Capabilities • Configuration • Connectors (veraltet) • CustomFieldDefinitions (veraltet) • CustomFieldValues • Defects • JiraCloudBasicAuthConnector (veraltet) • JiraCloudOAuthConnector (veraltet) • JiraConnectorWebHooks • JireServerConnector (veraltet) • KPIs • ObjectLabels • Orchestrator • ProjectReports • Projects (veraltet) • RedmineConnector (veraltet) • Requirements (veraltet) • ServerInfo • ServiceNowConnector (veraltet) • Settings • Telemetry • TestCaseLogs • TestCases • TestExecutions • TestSets • TestSteps • ThirdPartyAuth (veraltet) • UserAuth • Users • UserSession • UserSettings • WebHookConfiguration (veraltet) • XrayCloudConnector (veraltet) • XrayConnectorWebhooks • XrayServerConnector (veraltet)	Verfügbar für Organisationsadministratoren und Nicht-Administratorbenutzer. Nicht durch die rollenbasierte Zugriffskontrolle geschützt.
V2	• AzureDevOpsConnector • Connectors • CustomFieldDefinitions • JiraCloudBasicAuthConnector • JiraCloudOAuthConnector • JiraServerConnector • ProjectPermissions • Projects • QtestConnector • RedmineConnector • Requirements • ServiceNowConnector • WebHookConfiguration • XrayCloudConnector • XrayServerConnector	Verfügbar für Administratoren und Projektbesitzer.

API-Version aktualisieren

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

1. Fügen Sie /swagger/index.html zu Ihrer Test Manager-Instanz-URL hinzu (z. B. https://testmanager.com/swagger/index.html).

2. Wählen Sie oben auf der Seite „Eine Definition auswählen“ aus und anschließend „V2“ in der Dropdownliste.

   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'
   

   

Ähnliche Artikel

• Überblick