API バージョン

Test Manager には、連携に使用できる API バージョンが 2 つあります。1 つ目の API バージョンは、ロールベースのアクセス制御で保護されていません。2 つ目の API バージョンは、特定のプロジェクトスコープ内でロールベースのアクセス制御で保護されます。一部のレガシ API には組織管理者しかアクセスできませんが、2 つ目の API バージョンには、組織管理者ではないプロジェクト所有者もアクセスできるようになりました。

バージョンスケジュール

V1 は非推奨となり、2023 年 4 月に削除されました (2023.4 リリース) をスタンドアロンと Automation Suite の両方のバージョンの Test Manager で使用します。

バージョンベースの API

API バージョン	権限	説明
V1	• Attachments • AzureDevOpsConnector (非推奨) • Capabilities • Configuration • Connectors (非推奨) • CustomFieldDefinitions (非推奨) • CustomFieldValues • Defects • JiraCloudBasicAuthConnector (非推奨) • JiraCloudOAuthConnector (非推奨) • JiraConnectorWebHooks • JireServerConnector (非推奨) • KPIs • ObjectLabels • Orchestrator • ProjectReports • Projects (非推奨) • RedmineConnector (非推奨) • Requirements (非推奨) • ServerInfo • ServiceNowConnector (非推奨) • Settings • Telemetry • TestCaseLogs • TestCases • TestExecutions • TestSets • TestSteps • ThirdPartyAuth (非推奨) • UserAuth • Users • UserSession • UserSettings • WebHookConfiguration (非推奨) • XrayCloudConnector (非推奨) • XrayConnectorWebhooks • XrayServerConnector (非推奨)	組織管理者および非管理者ユーザーが使用できます。ロールベースのアクセス制御によって保護されていません。
v2	• AzureDevOpsConnector • Connectors • CustomFieldDefinitions • JiraCloudBasicAuthConnector • JiraCloudOAuthConnector • JiraServerConnector • ProjectPermissions • Projects • QtestConnector • RedmineConnector • Requirements • ServiceNowConnector • WebHookConfiguration • XrayCloudConnector • XrayServerConnector	管理者およびプロジェクト所有者が使用できます。

API バージョンを更新する

ロールベースのアクセス制御による呼び出しを行うには、Swagger を使用して API バージョンを更新します。

お使いの Test Manager インスタンスの URL に /swagger/index.html を追加します (例: https://testmanager.com/swagger/index.html)。
ページ上部の [Select a definition] をクリックして、ドロップダウンリストから [V2] を選択します。
次の例に示すように、要求にバージョン番号が含まれるようになります。
```
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'
```