Test Plan Clone - Clone Test Plan

Reference

Service:: Test Plan

API Version:: 6.0-preview.2

Clone test plan

POST https://dev.azure.com/{organization}/{project}/_apis/testplan/Plans/CloneOperation?api-version=6.0-preview.2

With optional parameters:

POST https://dev.azure.com/{organization}/{project}/_apis/testplan/Plans/CloneOperation?deepClone={deepClone}&api-version=6.0-preview.2

URI Parameters

Name	In	Required	Type	Description
organization	path	True	string	The name of the Azure DevOps organization.
project	path	True	string	Project ID or project name
api-version	query	True	string	Version of the API to use. This should be set to '6.0-preview.2' to use this version of the api.
deepClone	query		boolean	Clones all the associated test cases as well

Request Body

Name	Type	Description
cloneOptions	CloneOptions	Test Plan Clone create parameters
destinationTestPlan	DestinationTestPlanCloneParams	Information about destination Test Plan
sourceTestPlan	SourceTestPlanInfo	Information about source Test Plan

Responses

Name	Type	Description
200 OK	CloneTestPlanOperationInformation	successful operation

Security

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

Name	Description
vso.test_write	Grants the ability to read, create, and update test plans, cases, results and other test management related artifacts.

Definitions

BuildDefinitionReference	The build definition reference resource
CloneOperationCommonResponse	Common Response for clone operation
CloneOperationState	Clone operation state
CloneOptions	Clone options for cloning the test suite.
CloneStatistics	Clone Statistics Details.
CloneTestPlanOperationInformation	Response for Test Plan clone operation
CloneTestPlanParams	Parameters for Test Plan clone operation
DestinationTestPlanCloneParams	Destination Test Plan create parameters
IdentityRef
ProjectState	Project state.
ProjectVisibility	Project visibility.
ReferenceLinks	The class to represent a collection of REST reference links.
ReleaseEnvironmentDefinitionReference	Reference to release environment resource.
SourceTestPlanInfo	Source Test Plan information for Test Plan clone operation
SourceTestplanResponse	Source Test Plan Response for Test Plan clone operation
TeamProjectReference	Represents a shallow reference to a TeamProject.
TestOutcomeSettings	Test outcome settings
TestPlan	The test plan resource.
TestSuiteReference	The test suite reference resource.

BuildDefinitionReference

The build definition reference resource

Name	Type	Description
id	integer	ID of the build definition
name	string	Name of the build definition

CloneOperationCommonResponse

Common Response for clone operation

Name	Type	Description
cloneStatistics	CloneStatistics	Various statistics related to the clone operation
completionDate	string	Completion data of the operation
creationDate	string	Creation data of the operation
links	ReferenceLinks	Reference links
message	string	Message related to the job
opId	integer	Clone operation Id
state	CloneOperationState	Clone operation state

CloneOperationState

Clone operation state

Name	Type	Description
failed	string	value for Failed State
inProgress	string	value for Inprogress state
queued	string	Value for Queued State
succeeded	string	value for Success state

CloneOptions

Clone options for cloning the test suite.

Name	Type	Description
cloneRequirements	boolean	If set to true requirements will be cloned
copyAllSuites	boolean	copy all suites from a source plan
copyAncestorHierarchy	boolean	copy ancestor hierarchy
destinationWorkItemType	string	Name of the workitem type of the clone
overrideParameters	object	Key value pairs where the key value is overridden by the value.
relatedLinkComment	string	Comment on the link that will link the new clone test case to the original Set null for no comment

CloneStatistics

Clone Statistics Details.

Name	Type	Description
clonedRequirementsCount	integer	Number of requirements cloned so far.
clonedSharedStepsCount	integer	Number of shared steps cloned so far.
clonedTestCasesCount	integer	Number of test cases cloned so far
totalRequirementsCount	integer	Total number of requirements to be cloned
totalTestCasesCount	integer	Total number of test cases to be cloned

CloneTestPlanOperationInformation

Response for Test Plan clone operation

Name	Type	Description
cloneOperationResponse	CloneOperationCommonResponse	Various information related to the clone
cloneOptions	CloneOptions	Test Plan Clone create parameters
destinationTestPlan	TestPlan	Information of destination Test Plan
sourceTestPlan	SourceTestplanResponse	Information of source Test Plan

CloneTestPlanParams

Parameters for Test Plan clone operation

Name	Type	Description
cloneOptions	CloneOptions	Test Plan Clone create parameters
destinationTestPlan	DestinationTestPlanCloneParams	Information about destination Test Plan
sourceTestPlan	SourceTestPlanInfo	Information about source Test Plan

DestinationTestPlanCloneParams

Destination Test Plan create parameters

Name	Type	Description
areaPath	string	Area of the test plan.
buildDefinition	BuildDefinitionReference	The Build Definition that generates a build associated with this test plan.
buildId	integer	Build to be tested.
description	string	Description of the test plan.
endDate	string	End date for the test plan.
iteration	string	Iteration path of the test plan.
name	string	Name of the test plan.
owner	IdentityRef	Owner of the test plan.
project	string	Destination Project Name
releaseEnvironmentDefinition	ReleaseEnvironmentDefinitionReference	Release Environment to be used to deploy the build and run automated tests from this test plan.
startDate	string	Start date for the test plan.
state	string	State of the test plan.
testOutcomeSettings	TestOutcomeSettings	Value to configure how same tests across test suites under a test plan need to behave

IdentityRef

Name	Type	Description
_links	ReferenceLinks	This field contains zero or more interesting links about the graph subject. These links may be invoked to obtain additional relationships or more detailed information about this graph subject.
descriptor	string	The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.
directoryAlias	string	Deprecated - Can be retrieved by querying the Graph user referenced in the "self" entry of the IdentityRef "_links" dictionary
displayName	string	This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.
id	string
imageUrl	string	Deprecated - Available in the "avatar" entry of the IdentityRef "_links" dictionary
inactive	boolean	Deprecated - Can be retrieved by querying the Graph membership state referenced in the "membershipState" entry of the GraphUser "_links" dictionary
isAadIdentity	boolean	Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)
isContainer	boolean	Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)
isDeletedInOrigin	boolean
profileUrl	string	Deprecated - not in use in most preexisting implementations of ToIdentityRef
uniqueName	string	Deprecated - use Domain+PrincipalName instead
url	string	This url is the full route to the source resource of this graph subject.

ProjectState

Project state.

Name	Type	Description
all	string	All projects regardless of state.
createPending	string	Project has been queued for creation, but the process has not yet started.
deleted	string	Project has been deleted.
deleting	string	Project is in the process of being deleted.
new	string	Project is in the process of being created.
unchanged	string	Project has not been changed.
wellFormed	string	Project is completely created and ready to use.

ProjectVisibility

Project visibility.

Name	Type	Description
private	string	The project is only visible to users with explicit access.
public	string	The project is visible to all.

ReferenceLinks

The class to represent a collection of REST reference links.

Name	Type	Description
links	object	The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.

ReleaseEnvironmentDefinitionReference

Reference to release environment resource.

Name	Type	Description
definitionId	integer	ID of the release definition that contains the release environment definition.
environmentDefinitionId	integer	ID of the release environment definition.

SourceTestPlanInfo

Source Test Plan information for Test Plan clone operation

Name	Type	Description
id	integer	ID of the source Test Plan
suiteIds	integer[]	Id of suites to be cloned inside source Test Plan

SourceTestplanResponse

Source Test Plan Response for Test Plan clone operation

Name	Type	Description
id	integer	ID of the test plan.
name	string	Name of the test plan.
project	TeamProjectReference	project reference
suiteIds	integer[]	Id of suites to be cloned inside source Test Plan

TeamProjectReference

Represents a shallow reference to a TeamProject.

Name	Type	Description
abbreviation	string	Project abbreviation.
defaultTeamImageUrl	string	Url to default team identity image.
description	string	The project's description (if any).
id	string	Project identifier.
lastUpdateTime	string	Project last update time.
name	string	Project name.
revision	integer	Project revision.
state	ProjectState	Project state.
url	string	Url to the full version of the object.
visibility	ProjectVisibility	Project visibility.

TestOutcomeSettings

Test outcome settings

Name	Type	Description
syncOutcomeAcrossSuites	boolean	Value to configure how test outcomes for the same tests across suites are shown

TestPlan

The test plan resource.

Name	Type	Description
_links	ReferenceLinks	Relevant links
areaPath	string	Area of the test plan.
buildDefinition	BuildDefinitionReference	The Build Definition that generates a build associated with this test plan.
buildId	integer	Build to be tested.
description	string	Description of the test plan.
endDate	string	End date for the test plan.
id	integer	ID of the test plan.
iteration	string	Iteration path of the test plan.
name	string	Name of the test plan.
owner	IdentityRef	Owner of the test plan.
previousBuildId	integer	Previous build Id associated with the test plan
project	TeamProjectReference	Project which contains the test plan.
releaseEnvironmentDefinition	ReleaseEnvironmentDefinitionReference	Release Environment to be used to deploy the build and run automated tests from this test plan.
revision	integer	Revision of the test plan.
rootSuite	TestSuiteReference	Root test suite of the test plan.
startDate	string	Start date for the test plan.
state	string	State of the test plan.
testOutcomeSettings	TestOutcomeSettings	Value to configure how same tests across test suites under a test plan need to behave
updatedBy	IdentityRef	Identity Reference for the last update of the test plan
updatedDate	string	Updated date of the test plan

TestSuiteReference

The test suite reference resource.

Name	Type	Description
id	integer	ID of the test suite.
name	string	Name of the test suite.