Test Suites - Create

参考

服务:: Test

API 版本:: 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 版本。应将其设置为“5.0”才能使用此版本的 API。

请求正文

名称	类型	说明
name	string	测试套件的名称。
queryString	string	对于基于查询的套件，用于定义套件的查询字符串。
requirementIds	integer[]	对于要求测试套件，为要求的 ID。
suiteType	string	要创建的测试套件的类型。它可以具有 DynamicTestSuite、StaticTestSuite 和 RequirementTestSuite 的值。

响应

名称	类型	说明
200 OK	TestSuite[]	成功的操作

安全性

oauth2

类型: oauth2
流向: accessCode
授权 URL: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
令牌 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

作用域

名称	说明
vso.test_write	授予读取、创建和更新测试计划、案例、结果和其他测试管理相关项目的能力。

示例

Based on a query

Based on requirements

Static suite

Based on a query

示例请求

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'"
}

示例响应

状态代码:: 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

示例请求

HTTP

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

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

示例响应

状态代码:: 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

示例请求

HTTP

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

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

示例响应

状态代码:: 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

Object

名称	类型	说明
_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

Object

表示 REST 引用链接集合的类。

名称	类型	说明
links	object	链接的只读视图。由于引用链接是只读的，因此我们只想将其公开为只读。

ShallowReference

Object

对某些其他资源的抽象引用。此类用于提供生成数据协定，使用统一的方式引用其他资源，以便轻松遍历链接。

名称	类型	说明
id	string	资源的 ID
name	string	链接资源的名称 (定义名称、控制器名称等)
url	string	指向资源的完整 http 链接

SuiteCreateModel

Object

套件创建模型

名称	类型	说明
name	string	测试套件的名称。
queryString	string	对于基于查询的套件，用于定义套件的查询字符串。
requirementIds	integer[]	对于要求测试套件，为要求的 ID。
suiteType	string	要创建的测试套件的类型。它可以具有 DynamicTestSuite、StaticTestSuite 和 RequirementTestSuite 的值。

TestSuite

Object

测试套件

名称	类型	说明
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

作用域

示例

Based on a query

示例请求

示例响应

Based on requirements

示例请求

示例响应

Static suite

示例请求

示例响应

定义

IdentityRef

ReferenceLinks

ShallowReference

SuiteCreateModel

TestSuite

其他资源