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 參數

名稱	位於	必要	類型	Description
organization	path	True	string	Azure DevOps 組織的名稱。
planId	path	True	integer int32	包含套件的測試計劃識別碼。
project	path	True	string	專案識別碼或專案名稱
suiteId	path	True	integer int32	父套件的識別碼。
api-version	query	True	string	要使用的 API 版本。這應該設定為 '5.0' 以使用此版本的 API。

要求本文

名稱	類型	Description
name	string	測試套件的名稱。
queryString	string	針對查詢型套件，定義套件的查詢字串。
requirementIds	integer[]	針對需求測試套件，需求識別碼。
suiteType	string	要建立的測試套件類型。它可以有 DynamicTestSuite、StaticTestSuite 和 RequirementTestSuite 的值。

回應

名稱	類型	Description
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

名稱	Description
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
}

定義

名稱	Description
IdentityRef
ReferenceLinks	表示 REST 參考連結集合的類別。
ShallowReference	一些其他資源的抽象參考。這個類別可用來提供建置資料合約，以統一方式參考其他資源，以提供輕鬆周遊連結的方式。
SuiteCreateModel	套件建立模型
TestSuite	測試套件

IdentityRef

名稱	類型	Description
_links	ReferenceLinks	此欄位包含有關圖表主旨的零個或多個有趣連結。您可以叫用這些連結來取得其他關聯性，或取得此圖表主體的詳細資訊。
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 參考連結集合的類別。

名稱	類型	Description
links	object	連結的唯讀檢視。因為參考連結是唯讀的，所以我們只想要將它們公開為唯讀。

ShallowReference

一些其他資源的抽象參考。這個類別可用來提供建置資料合約，以統一方式參考其他資源，以提供輕鬆周遊連結的方式。

名稱	類型	Description
id	string	資源的識別碼
name	string	連結資源的名稱 (定義名稱、控制器名稱等。)
url	string	資源的完整 HTTP 連結

SuiteCreateModel

套件建立模型

名稱	類型	Description
name	string	測試套件的名稱。
queryString	string	針對查詢型套件，定義套件的查詢字串。
requirementIds	integer[]	針對需求測試套件，需求識別碼。
suiteType	string	要建立的測試套件類型。它可以有 DynamicTestSuite、StaticTestSuite 和 RequirementTestSuite 的值。

TestSuite

測試套件

名稱	類型	Description
areaUri	string	測試套件的區域 URI。
children	TestSuite[]	目前測試套件的子測試套件。
defaultConfigurations	ShallowReference[]	測試套件預設組態。
defaultTesters	ShallowReference[]	測試套件預設測試人員。
id	integer	測試套件的識別碼。
inheritDefaultConfigurations	boolean	預設組態已繼承或未繼承。
lastError	string	測試套件的最後一個錯誤。
lastPopulatedDate	string	上次填入日期。
lastUpdatedBy	IdentityRef	最近更新測試套件之使用者的 IdentityRef。
lastUpdatedDate	string	上次更新日期。
name	string	測試套件的名稱。
parent	ShallowReference	測試套件父層參考。
plan	ShallowReference	測試套件所屬的測試計劃。
project	ShallowReference	測試套件專案淺層參考。
queryString	string	動態套件的測試套件查詢字串。
requirementId	integer	測試套件需求識別碼。
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

其他資源