Test Suite Clone - Clone Test Suite
Clone test suite
POST https://dev.azure.com/{organization}/{project}/_apis/testplan/Suites/CloneOperation?api-version=5.0-preview.1POST https://dev.azure.com/{organization}/{project}/_apis/testplan/Suites/CloneOperation?deepClone={deepClone}&api-version=5.0-preview.1URI 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 '5.0-preview.1' to use this version of the api. |
|
deep
|
query |
boolean |
Clones all the associated test cases as well. False by default. |
Request Body
| Name | Type | Description |
|---|---|---|
| cloneOptions |
Test suite Clone options |
|
| destinationTestSuite |
Destination Test Suite |
|
| sourceTestSuite |
Source Test Suite |
Responses
| Name | Type | Description |
|---|---|---|
| 200 OK |
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
| Name | Description |
|---|---|
|
Clone |
Clone Operation Response |
|
Clone |
Clone operation state |
|
Clone |
|
|
Clone |
|
|
Clone |
Test Suite clone information |
|
Clone |
Test Suite clone operation parameters |
|
Destination |
Destination Test Suite information for clone operation |
|
Project |
Project state. |
|
Project |
Project visibility. |
|
Reference |
The class to represent a collection of REST reference links. |
|
Source |
Source Test Suite information for clone operation |
|
Team |
Represents a shallow reference to a TeamProject. |
|
Test |
Test Suite Reference |
CloneOperationCommonResponse
Clone Operation Response
| Name | Type | Description |
|---|---|---|
| cloneStatistics |
Statistics related to the clone operation |
|
| completionDate |
string (date-time) |
Completion data of the operation |
| creationDate |
string (date-time) |
Creation data of the operation |
| links |
Reference links |
|
| message |
string |
Message related to the job |
| opId |
integer (int32) |
Clone operation Id |
| state |
Clone operation state |
CloneOperationState
Clone operation state
| Value | Description |
|---|---|
| failed |
value for Failed State |
| inProgress |
value for Inprogress state |
| queued |
Value for Queued State |
| succeeded |
value for Success state |
CloneOptions
| 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 hieracrchy |
| 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
| Name | Type | Description |
|---|---|---|
| clonedRequirementsCount |
integer (int32) |
Number of Requirments cloned so far. |
| clonedSharedStepsCount |
integer (int32) |
Number of shared steps cloned so far. |
| clonedTestCasesCount |
integer (int32) |
Number of test cases cloned so far |
| totalRequirementsCount |
integer (int32) |
Total number of requirements to be cloned |
| totalTestCasesCount |
integer (int32) |
Total number of test cases to be cloned |
CloneTestSuiteOperationInformation
Test Suite clone information
| Name | Type | Description |
|---|---|---|
| cloneOperationResponse |
Clone Operation Response |
|
| cloneOptions |
Test Suite Clone options |
|
| clonedTestSuite |
Newly cloned Test Suite |
|
| destinationTestSuite |
Destination Test Suite |
|
| sourceTestSuite |
Source Test Suite |
CloneTestSuiteParams
Test Suite clone operation parameters
| Name | Type | Description |
|---|---|---|
| cloneOptions |
Test suite Clone options |
|
| destinationTestSuite |
Destination Test Suite |
|
| sourceTestSuite |
Source Test Suite |
DestinationTestSuiteInfo
Destination Test Suite information for clone operation
| Name | Type | Description |
|---|---|---|
| id |
integer (int32) |
Destination Suite Id |
| project |
string |
Destination Project Name |
ProjectState
Project state.
| Value | Description |
|---|---|
| deleting |
Project is in the process of being deleted. |
| new |
Project is in the process of being created. |
| wellFormed |
Project is completely created and ready to use. |
| createPending |
Project has been queued for creation, but the process has not yet started. |
| all |
All projects regardless of state. |
| unchanged |
Project has not been changed. |
| deleted |
Project has been deleted. |
ProjectVisibility
Project visibility.
| Value | Description |
|---|---|
| private |
The project is only visible to users with explicit access. |
| public |
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. |
SourceTestSuiteInfo
Source Test Suite information for clone operation
| Name | Type | Description |
|---|---|---|
| id |
integer (int32) |
Id of the Source Test Suite |
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 (uuid) |
Project identifier. |
| name |
string |
Project name. |
| revision |
integer (int64) |
Project revision. |
| state |
Project state. |
|
| url |
string |
Url to the full version of the object. |
| visibility |
Project visibility. |
TestSuiteReferenceWithProject
Test Suite Reference
| Name | Type | Description |
|---|---|---|
| id |
integer (int32) |
ID of the test suite. |
| name |
string |
Name of the test suite. |
| project |
Destination Project |