通知を受け取る

UiPath Test Suite

UiPath Test Suite

API バージョン

概要


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

バージョン スケジュール


V1 は、Cloud バージョンの Test Manager では 2023 年 1 月末まで、スタンドアロンと Automation Suite バージョンの Test Manager では 2023 年 4 月 (2023.4 のリリース) まで利用できます。

バージョンベースの API


API VersionPermissionsDescription
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.

API バージョンを更新する


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

  1. お使いの Test Manager インスタンスの URL に /swagger/index.html を追加します (例: https://testmanager.com/swagger/index.html)。
  2. ページ上部の [Select a definition] をクリックして、ドロップダウン リストから [V2] を選択します。
    次の例に示すように、要求にバージョン番号が含まれるようになります。
curl -X 'GET' \
  'https://company/testmanager/companyTenant/testmanager_/api/v2/projects' \
  -H 'accept: application/json'
828

関連記事


4 か月前に更新


API バージョン


改善の提案は、API リファレンスのページでは制限されています

改善を提案できるのは Markdown の本文コンテンツのみであり、API 仕様に行うことはできません。