Test Suites - Create

リファレンス

Service:: Test

API Version:: 5.0

テストスイートを作成します。

POST https://dev.azure.com/{organization}/{project}/_apis/test/Plans/{planId}/suites/{suiteId}?api-version=5.0

URI パラメーター

名前	/	必須	型	説明
organization	path	True	string	Azure DevOps 組織の名前です。
planId	path	True	integer int32	スイートを含むテストプランの ID。
project	path	True	string	プロジェクト ID またはプロジェクト名
suiteId	path	True	integer int32	親スイートの ID。
api-version	query	True	string	使う API のバージョン。このバージョンの API を使用するには、これを '5.0' に設定する必要があります。

要求本文

名前	型	説明
name	string	テストスイートの名前。
queryString	string	クエリベースのスイートの場合は、スイートを定義するクエリ文字列。
requirementIds	integer[]	要件テストスイートの場合は、要件の ID。
suiteType	string	作成するテストスイートの種類。 DynamicTestSuite、StaticTestSuite、および RequirementTestSuite の値を指定できます。

応答

名前	型	説明
200 OK	TestSuite[]	正常な操作

セキュリティ

oauth2

Type: oauth2
Flow: accessCode
Authorization URL: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token URL: https://app.vssps.visualstudio.com/oauth2/token?client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer

Scopes

名前	説明
vso.test_write	テスト計画、ケース、結果、その他のテスト管理関連の成果物を読み取り、作成、更新する機能を付与します。

例

Based on a query

Based on requirements

Static suite

Based on a query

Sample Request

HTTP

POST https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Plans/1/suites/1?api-version=5.0

{
  "suiteType": "DynamicTestSuite",
  "name": "AllTestCases",
  "queryString": "SELECT [System.Id],[System.WorkItemType],[System.Title],[Microsoft.VSTS.Common.Priority],[System.AssignedTo],[System.AreaPath] FROM WorkItems WHERE [System.WorkItemType] IN GROUP 'Microsoft.TestCaseCategory'"
}

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": 9,
      "name": "AllTestCases",
      "url": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Plans/1/Suites/9",
      "project": {
        "id": "eb6e4656-77fc-42a1-9181-4c6d8e9da5d1",
        "name": "Fabrikam-Fiber-TFVC",
        "url": "https://dev.azure.com/fabrikam/_apis/projects/Fabrikam-Fiber-TFVC"
      },
      "plan": {
        "id": "1",
        "name": "sprint1",
        "url": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Plans/1"
      },
      "parent": {
        "id": "1",
        "name": "sprint1",
        "url": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Plans/1/Suites/1"
      },
      "queryString": "SELECT [System.Id],[System.WorkItemType],[System.Title],[Microsoft.VSTS.Common.Priority],[System.AssignedTo],[System.AreaPath] FROM WorkItems WHERE [System.WorkItemType] IN GROUP 'Microsoft.TestCaseCategory'",
      "revision": 1,
      "testCaseCount": 2,
      "suiteType": "DynamicTestSuite",
      "testCasesUrl": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Plans/1/Suites/9/testcases",
      "inheritDefaultConfigurations": true,
      "lastPopulatedDate": "2014-05-04T11:33:28.497Z",
      "state": "InProgress",
      "lastUpdatedBy": {
        "id": "e5a5f7f8-6507-4c34-b397-6c4818e002f4",
        "displayName": "Fabrikam Fiber",
        "uniqueName": "fabrikamfiber1@outlook.com",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/e5a5f7f8-6507-4c34-b397-6c4818e002f4",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=e5a5f7f8-6507-4c34-b397-6c4818e002f4"
      },
      "lastUpdatedDate": "2014-05-04T11:33:28.497Z"
    }
  ],
  "count": 1
}

Based on requirements

Sample Request

HTTP

POST https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Plans/1/suites/1?api-version=5.0

{
  "suiteType": "RequirementTestSuite",
  "requirementIds": [
    2
  ]
}

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": 13,
      "url": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Plans/1/Suites/13",
      "project": {
        "id": "eb6e4656-77fc-42a1-9181-4c6d8e9da5d1",
        "name": "Fabrikam-Fiber-TFVC",
        "url": "https://dev.azure.com/fabrikam/_apis/projects/Fabrikam-Fiber-TFVC"
      },
      "plan": {
        "id": "1",
        "name": "sprint1",
        "url": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Plans/1"
      },
      "parent": {
        "id": "1",
        "name": "sprint1",
        "url": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Plans/1/Suites/1"
      },
      "name": "2 : BestFeatureEver",
      "requirementId": 2,
      "revision": 1,
      "testCaseCount": 0,
      "suiteType": "RequirementTestSuite",
      "testCasesUrl": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Plans/1/Suites/13/testcases",
      "inheritDefaultConfigurations": true,
      "defaultConfigurations": [],
      "lastPopulatedDate": "2014-05-04T11:33:25.857Z",
      "state": "InProgress",
      "lastUpdatedBy": {
        "id": "e5a5f7f8-6507-4c34-b397-6c4818e002f4",
        "displayName": "Fabrikam Fiber",
        "uniqueName": "fabrikamfiber1@outlook.com",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/e5a5f7f8-6507-4c34-b397-6c4818e002f4",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=e5a5f7f8-6507-4c34-b397-6c4818e002f4"
      },
      "lastUpdatedDate": "2014-05-04T11:33:25.857Z",
      "areaUri": "vstfs:///Classification/Node/13a29f1c-46be-4883-9153-b36900f1b70c"
    }
  ],
  "count": 1
}

Static suite

Sample Request

HTTP

POST https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Plans/1/suites/1?api-version=5.0

{
  "suiteType": "StaticTestSuite",
  "name": "NewTestSuite"
}

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": 8,
      "name": "NewTestSuite",
      "url": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Plans/1/Suites/8",
      "project": {
        "id": "eb6e4656-77fc-42a1-9181-4c6d8e9da5d1",
        "name": "Fabrikam-Fiber-TFVC",
        "url": "https://dev.azure.com/fabrikam/_apis/projects/Fabrikam-Fiber-TFVC"
      },
      "plan": {
        "id": "1",
        "name": "sprint1",
        "url": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Plans/1"
      },
      "parent": {
        "id": "1",
        "name": "sprint1",
        "url": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Plans/1/Suites/1"
      },
      "revision": 1,
      "testCaseCount": 0,
      "suiteType": "StaticTestSuite",
      "testCasesUrl": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Plans/1/Suites/8/testcases",
      "inheritDefaultConfigurations": true,
      "state": "InProgress",
      "lastUpdatedBy": {
        "id": "e5a5f7f8-6507-4c34-b397-6c4818e002f4",
        "displayName": "Fabrikam Fiber",
        "uniqueName": "fabrikamfiber1@outlook.com",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/e5a5f7f8-6507-4c34-b397-6c4818e002f4",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=e5a5f7f8-6507-4c34-b397-6c4818e002f4"
      },
      "lastUpdatedDate": "2014-05-04T11:33:25.857Z"
    }
  ],
  "count": 1
}

定義

名前	説明
IdentityRef
ReferenceLinks	REST 参照リンクのコレクションを表すクラス。
ShallowReference	他のリソースへの抽象化された参照。このクラスは、リンクを介して簡単に走査できる方法で他のリソースを参照する統一された方法でビルドデータコントラクトを提供するために使用されます。
SuiteCreateModel	スイートのモデルの作成
TestSuite	テストスイート

IdentityRef

名前	型	説明
_links	ReferenceLinks	このフィールドには、グラフの件名に関する 0 個以上の興味深いリンクが含まれています。これらのリンクを呼び出して、このグラフの主題に関する追加のリレーションシップや詳細情報を取得できます。
descriptor	string	記述子は、システムの実行中にグラフの件名を参照する主な方法です。このフィールドは、アカウントと組織の両方で同じグラフの件名を一意に識別します。
directoryAlias	string
displayName	string	これは、グラフの件名の一意でない表示名です。このフィールドを変更するには、ソースプロバイダーでその値を変更する必要があります。
id	string
imageUrl	string
inactive	boolean
isAadIdentity	boolean
isContainer	boolean
isDeletedInOrigin	boolean
profileUrl	string
uniqueName	string
url	string	この URL は、このグラフの件名のソースリソースへの完全なルートです。

ReferenceLinks

REST 参照リンクのコレクションを表すクラス。

名前	型	説明
links	object	リンクの読み取り時ビュー。参照リンクは読み取り専用であるため、参照リンクは読み取り専用として公開する必要があります。

ShallowReference

他のリソースへの抽象化された参照。このクラスは、リンクを介して簡単に走査できる方法で他のリソースを参照する統一された方法でビルドデータコントラクトを提供するために使用されます。

名前	型	説明
id	string	リソースの ID
name	string	リンクされたリソースの名前 (定義名、コントローラー名など)
url	string	リソースへの完全な http リンク

SuiteCreateModel

スイートのモデルの作成

名前	型	説明
name	string	テストスイートの名前。
queryString	string	クエリベースのスイートの場合は、スイートを定義するクエリ文字列。
requirementIds	integer[]	要件テストスイートの場合は、要件の ID。
suiteType	string	作成するテストスイートの種類。 DynamicTestSuite、StaticTestSuite、および RequirementTestSuite の値を指定できます。

TestSuite

テストスイート

名前	型	説明
areaUri	string	テストスイートのエリア URI。
children	TestSuite[]	現在のテストスイートの子テストスイート。
defaultConfigurations	ShallowReference[]	テストスイートの既定の構成。
defaultTesters	ShallowReference[]	テストスイートの既定のテスト担当者。
id	integer	テストスイートの ID。
inheritDefaultConfigurations	boolean	既定の構成が継承されたかどうか。
lastError	string	テストスイートの最後のエラー。
lastPopulatedDate	string	最後に設定された日付。
lastUpdatedBy	IdentityRef	最近テストスイートを更新したユーザーの IdentityRef。
lastUpdatedDate	string	最終更新日。
name	string	テストスイートの名前。
parent	ShallowReference	テストスイートの親シャロー参照。
plan	ShallowReference	テストスイートが属するテスト計画。
project	ShallowReference	テストスイートプロジェクトのシャローリファレンス。
queryString	string	動的スイートのテストスイートクエリ文字列。
requirementId	integer	テストスイートの要件 ID。
revision	integer	テストスイートのリビジョン。
state	string	テストスイートの状態。
suiteType	string	テストスイートの種類。
suites	ShallowReference[]	スイートの簡易参照の一覧。
testCaseCount	integer	テストケース数。
testCasesUrl	string	テストケースの URL。
text	string	ツリービューで使用されます。テストスイートがルートスイートの場合は、プランの名前です。それ以外の場合はスイートのタイトルです。
url	string	テストスイートの URL。

次の方法で共有

Test Suites - Create

URI パラメーター

要求本文

応答

セキュリティ

oauth2

Scopes

例

Based on a query

Sample Request

Sample Response

Based on requirements

Sample Request

Sample Response

Static suite

Sample Request

Sample Response

定義

IdentityRef

ReferenceLinks

ShallowReference

SuiteCreateModel

TestSuite

その他のリソース