Clone Operation - Clone Test Plan

参考

服务:: Test

API 版本:: 5.0-preview.2

克隆测试计划

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

URI 参数

名称	在	必需	类型	说明
organization	path	True	string	Azure DevOps 组织的名称。
planId	path	True	integer int32	要克隆的测试计划的 ID。
project	path	True	string	项目 ID 或项目名称
api-version	query	True	string	要使用的 API 版本。应将其设置为“5.0-preview.2”才能使用此版本的 API。

请求正文

名称	类型	说明
destinationTestPlan	TestPlan	测试计划资源。
options	CloneOptions
suiteIds	integer[]

响应

名称	类型	说明
200 OK	CloneOperationInformation	成功的操作

安全性

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	授予读取、创建和更新测试计划、事例、结果和其他测试管理相关项目的能力。

示例

示例请求

HTTP

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

{
  "destinationTestPlan": {
    "name": "DestinationSuite",
    "Project": {
      "Name": "fabrikam-fiber-tfvc2"
    }
  },
  "options": {
    "copyAncestorHierarchy": true,
    "copyAllSuites": true,
    "overrideParameters": {
      "System.AreaPath": "fabrikam-fiber-tfvc2",
      "System.IterationPath": "fabrikam-fiber-tfvc2"
    }
  },
  "suiteIds": [
    2
  ]
}

示例响应

状态代码:: 200

{
  "opId": 2,
  "creationDate": "0001-01-01T00:00:00",
  "completionDate": "0001-01-01T00:00:00",
  "state": "queued",
  "message": null,
  "cloneStatistics": null,
  "resultObjectType": "testPlan",
  "destinationObject": {
    "id": "18",
    "name": "DestinationPlan",
    "url": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc2/_apis/test/Plans/18"
  },
  "sourceObject": {
    "id": "1",
    "name": "TestPlan1",
    "url": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Plans/1"
  },
  "destinationPlan": {
    "id": "18",
    "name": "DestinationPlan",
    "url": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc2/_apis/test/Plans/18"
  },
  "sourcePlan": {
    "id": "1",
    "name": "TestPlan1",
    "url": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Plans/1"
  },
  "destinationProject": {
    "name": "fabrikam-fiber-tfvc2",
    "url": "https://dev.azure.com/fabrikam/_apis/projects/fabrikam-fiber-tfvc2"
  },
  "sourceProject": {
    "name": "fabrikam-fiber-tfvc",
    "url": "https://dev.azure.com/fabrikam/_apis/projects/fabrikam-fiber-tfvc"
  },
  "url": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/cloneOperation/2"
}

定义

名称	说明
CloneOperationInformation	有关克隆操作的详细信息。
CloneOperationState	操作的当前状态。当状态达到“成功”或“失败”时，操作已完成
CloneOptions
CloneStatistics
IdentityRef
ReferenceLinks	表示 REST 引用链接集合的类。
ReleaseEnvironmentDefinitionReference	对发布环境资源的引用。
ResultObjectType	克隆操作生成的对象的类型
ShallowReference	对某些其他资源的抽象引用。此类用于为生成数据协定提供一种统一的方式来引用其他资源，以便轻松遍历链接。
TestOutcomeSettings	测试结果设置
TestPlan	测试计划资源。
TestPlanCloneRequest

CloneOperationInformation

Object

有关克隆操作的详细信息。

名称	类型	说明
cloneStatistics	CloneStatistics	克隆统计信息
completionDate	string	如果操作已完成，则为完成日期/时间。如果操作未完成，则为 DateTime.MaxValue
creationDate	string	开始操作的日期/时间
destinationObject	ShallowReference	目标的浅表引用
destinationPlan	ShallowReference	目标的浅表引用
destinationProject	ShallowReference	目标的浅表引用
message	string	如果操作失败，则 Message 包含失败的原因。否则为 Null。
opId	integer	操作的 ID
resultObjectType	ResultObjectType	克隆操作生成的对象的类型
sourceObject	ShallowReference	源的浅表引用
sourcePlan	ShallowReference	源的浅表引用
sourceProject	ShallowReference	源的浅表引用
state	CloneOperationState	操作的当前状态。当状态达到“成功”或“失败”时，操作已完成
url	string	用于获取克隆信息的 URL

CloneOperationState

Enumeration

操作的当前状态。当状态达到“成功”或“失败”时，操作已完成

值	说明
failed	失败状态的值
inProgress	Inprogress 状态的值
queued	排队状态的值
succeeded	成功状态的值

CloneOptions

Object

名称	类型	说明
cloneRequirements	boolean	如果设置为 true，则将克隆要求
copyAllSuites	boolean	从源计划复制所有套件
copyAncestorHierarchy	boolean	复制祖先 hieracrchy
destinationWorkItemType	string	克隆的工作项类型的名称
overrideParameters	object	键值对，其中键值由值替代。
relatedLinkComment	string	对链接的注释，该链接会将新的克隆测试用例链接到原始的 Set null（无注释）

CloneStatistics

Object

名称	类型	说明
clonedRequirementsCount	integer	到目前为止克隆的“要求”数。
clonedSharedStepsCount	integer	到目前为止克隆的共享步骤数。
clonedTestCasesCount	integer	到目前为止克隆的测试用例数
totalRequirementsCount	integer	要克隆的要求总数
totalTestCasesCount	integer	要克隆的测试用例总数

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	链接的只读视图。由于引用链接是只读的，因此我们只想将其公开为只读。

ReleaseEnvironmentDefinitionReference

Object

对发布环境资源的引用。

名称	类型	说明
definitionId	integer	包含发布环境定义的发布定义的 ID。
environmentDefinitionId	integer	发布环境定义的 ID。

ResultObjectType

Enumeration

克隆操作生成的对象的类型

值	说明
testPlan	计划克隆
testSuite	套件克隆

ShallowReference

Object

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

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

TestOutcomeSettings

Object

测试结果设置

名称	类型	说明
syncOutcomeAcrossSuites	boolean	用于配置如何跨套件显示相同测试的测试结果的值

TestPlan

Object

测试计划资源。

名称	类型	说明
area	ShallowReference	测试计划的区域。
build	ShallowReference	要测试的生成。
buildDefinition	ShallowReference	生成与此测试计划关联的生成定义。
description	string	测试计划的说明。
endDate	string	测试计划的结束日期。
id	integer	测试计划的 ID。
iteration	string	测试计划的迭代路径。
name	string	测试计划的名称。
owner	IdentityRef	测试计划的所有者。
previousBuild	ShallowReference	对某些其他资源的抽象引用。此类用于为生成数据协定提供一种统一的方式来引用其他资源，以便轻松遍历链接。
project	ShallowReference	包含测试计划的项目。
releaseEnvironmentDefinition	ReleaseEnvironmentDefinitionReference	用于从此测试计划部署生成和运行自动测试的发布环境。
revision	integer	测试计划的修订。
rootSuite	ShallowReference	测试计划的根测试套件。
startDate	string	测试计划的开始日期。
state	string	测试计划的状态。
testOutcomeSettings	TestOutcomeSettings	用于配置测试计划下跨测试套件的相同测试需要的行为方式的值
updatedBy	IdentityRef
updatedDate	string
url	string	测试计划资源的 URL。

TestPlanCloneRequest

Object

名称	类型	说明
destinationTestPlan	TestPlan	测试计划资源。
options	CloneOptions
suiteIds	integer[]

通过

Clone Operation - Clone Test Plan

URI 参数

请求正文

响应

安全性

oauth2

作用域

示例

示例请求

示例响应

定义

CloneOperationInformation

CloneOperationState

CloneOptions

CloneStatistics

IdentityRef

ReferenceLinks

ReleaseEnvironmentDefinitionReference

ResultObjectType

ShallowReference

TestOutcomeSettings

TestPlan

TestPlanCloneRequest