Test Suite Recycle Bin Operations - Get Deleted Test Suites For Plan

Service:: Test Plan

API Version:: 7.2-preview.1

Get Deleted Test Suites for a Test Plan.

GET https://dev.azure.com/{organization}/{project}/_apis/testplan/recycleBin/TestPlan/{planId}/testsuite?api-version=7.2-preview.1

With optional parameters:

GET https://dev.azure.com/{organization}/{project}/_apis/testplan/recycleBin/TestPlan/{planId}/testsuite?expand={expand}&continuationToken={continuationToken}&asTreeView={asTreeView}&api-version=7.2-preview.1

URI Parameters

Name	In	Required	Type	Description
organization	path	True	string	The name of the Azure DevOps organization.
planId	path	True	integer (int32)	ID of the test plan for which suites are requested.
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 '7.2-preview.1' to use this version of the api.
asTreeView	query		boolean	If the suites returned should be in a tree structure.
continuationToken	query		string	If the list of suites returned is not complete, a continuation token to query next batch of suites is included in the response header as "x-ms-continuationtoken". Omit this parameter to get the first batch of test suites.
expand	query		SuiteExpand	Include the children suites and testers details.

Responses

Name	Type	Description
200 OK	TestSuite[]	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	Grants the ability to read test plans, cases, results and other test management related artifacts.

Examples

Get all Deleted Test Suites for a Test Plan.

Get Deleted Test Suites of a Test Plan in Tree View.

Get all Deleted Test Suites for a Test Plan.

Sample request

HTTP

GET https://dev.azure.com/fabrikam/p1/_apis/testplan/recycleBin/TestPlan/12/testsuite?expand=Children, DefaultTesters&api-version=7.2-preview.1

Sample response

Status code:: 200

transfer-Encoding: chunked
persistent-Auth: true
lfs-Authenticate: NTLM
wwW-Authenticate: Negotiate oRswGaADCgEAoxIEEAEAAAB/yMsAtyjkcQAAAAA=

{
  "value": [
    {
      "id": 14,
      "revision": 2,
      "project": {
        "id": "9aa0d72c-e93a-4456-9870-9c5169074a96",
        "name": "p1",
        "url": "https://dev.azure.com/fabrikam/_apis/projects/p1",
        "state": "unchanged",
        "visibility": "unchanged",
        "lastUpdateTime": "0001-01-01T00:00:00"
      },
      "lastUpdatedBy": {
        "displayName": "Fabrikam Fiber",
        "url": "https://vssps.dev.azure.com/fabrikam/Aea08ebc7-105f-4bb2-a36b-f92e0e9de65a/_apis/Identities/0fdbdad8-6afb-6149-9af9-c0a216137d1d",
        "_links": {
          "avatar": {
            "href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/msa.OWM2OTQ4NjYtYjFiOS03NTMxLTk4ZTgtN2EwNTk5MGM1MTU0"
          }
        },
        "id": "9c694866-b1b9-6531-98e8-7a05990c5154",
        "uniqueName": "fabrikamfiber1@microsoft.com",
        "imageUrl": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/msa.OWM2OTQ4NjYtYjFiOS03NTMxLTk4ZTgtN2EwNTk5MGM1MTU0",
        "descriptor": "msa.OWM2OTQ4NjYtYjFiOS03NTMxLTk4ZTgtN2EwNTk5MGM1MTU0"
      },
      "lastUpdatedDate": "2024-09-02T13:14:27.78Z",
      "plan": {
        "id": 12,
        "name": "tp2"
      },
      "_links": {
        "_self": {
          "href": "https://dev.azure.com/fabrikam/p1/_apis/testplan/Plans/12/Suites/14"
        },
        "testCases": {
          "href": "https://dev.azure.com/fabrikam/p1/_apis/testplan/Plans/12/Suites/14/TestCase"
        },
        "testPoints": {
          "href": "https://dev.azure.com/fabrikam/p1/_apis/testplan/Plans/12/Suites/14/TestPoint"
        }
      },
      "suiteType": "staticTestSuite",
      "name": "s2.1",
      "parentSuite": {
        "id": 13,
        "name": "tp2"
      },
      "inheritDefaultConfigurations": true
    },
    {
      "id": 15,
      "revision": 3,
      "project": {
        "id": "9aa0d72c-e93a-4456-9870-9c5169074a96",
        "name": "p1",
        "url": "https://dev.azure.com/fabrikam/_apis/projects/p1",
        "state": "unchanged",
        "visibility": "unchanged",
        "lastUpdateTime": "0001-01-01T00:00:00"
      },
      "lastUpdatedBy": {
        "displayName": "Fabrikam Fiber",
        "url": "https://vssps.dev.azure.com/fabrikam/Aea08ebc7-105f-4bb2-a36b-f92e0e9de65a/_apis/Identities/0fdbdad8-6afb-6149-9af9-c0a216137d1d",
        "_links": {
          "avatar": {
            "href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/msa.OWM2OTQ4NjYtYjFiOS03NTMxLTk4ZTgtN2EwNTk5MGM1MTU0"
          }
        },
        "id": "9c694866-b1b9-6531-98e8-7a05990c5154",
        "uniqueName": "fabrikamfiber1@microsoft.com",
        "imageUrl": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/msa.OWM2OTQ4NjYtYjFiOS03NTMxLTk4ZTgtN2EwNTk5MGM1MTU0",
        "descriptor": "msa.OWM2OTQ4NjYtYjFiOS03NTMxLTk4ZTgtN2EwNTk5MGM1MTU0"
      },
      "lastUpdatedDate": "2024-09-02T11:11:51.193Z",
      "plan": {
        "id": 12,
        "name": "tp2"
      },
      "children": [
        {
          "id": 16,
          "name": "s2.2.1"
        }
      ],
      "hasChildren": true,
      "_links": {
        "_self": {
          "href": "https://dev.azure.com/fabrikam/p1/_apis/testplan/Plans/12/Suites/15"
        },
        "testCases": {
          "href": "https://dev.azure.com/fabrikam/p1/_apis/testplan/Plans/12/Suites/15/TestCase"
        },
        "testPoints": {
          "href": "https://dev.azure.com/fabrikam/p1/_apis/testplan/Plans/12/Suites/15/TestPoint"
        }
      },
      "suiteType": "staticTestSuite",
      "name": "s2.2",
      "parentSuite": {
        "id": 13,
        "name": "tp2"
      },
      "inheritDefaultConfigurations": true
    },
    {
      "id": 16,
      "revision": 2,
      "project": {
        "id": "9aa0d72c-e93a-4456-9870-9c5169074a96",
        "name": "p1",
        "url": "https://dev.azure.com/fabrikam/_apis/projects/p1",
        "state": "unchanged",
        "visibility": "unchanged",
        "lastUpdateTime": "0001-01-01T00:00:00"
      },
      "lastUpdatedBy": {
        "displayName": "Fabrikam Fiber",
        "url": "https://vssps.dev.azure.com/fabrikam/Aea08ebc7-105f-4bb2-a36b-f92e0e9de65a/_apis/Identities/0fdbdad8-6afb-6149-9af9-c0a216137d1d",
        "_links": {
          "avatar": {
            "href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/msa.OWM2OTQ4NjYtYjFiOS03NTMxLTk4ZTgtN2EwNTk5MGM1MTU0"
          }
        },
        "id": "9c694866-b1b9-6531-98e8-7a05990c5154",
        "uniqueName": "fabrikamfiber1@microsoft.com",
        "imageUrl": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/msa.OWM2OTQ4NjYtYjFiOS03NTMxLTk4ZTgtN2EwNTk5MGM1MTU0",
        "descriptor": "msa.OWM2OTQ4NjYtYjFiOS03NTMxLTk4ZTgtN2EwNTk5MGM1MTU0"
      },
      "lastUpdatedDate": "2024-09-02T11:11:51.193Z",
      "plan": {
        "id": 12,
        "name": "tp2"
      },
      "_links": {
        "_self": {
          "href": "https://dev.azure.com/fabrikam/p1/_apis/testplan/Plans/12/Suites/16"
        },
        "testCases": {
          "href": "https://dev.azure.com/fabrikam/p1/_apis/testplan/Plans/12/Suites/16/TestCase"
        },
        "testPoints": {
          "href": "https://dev.azure.com/fabrikam/p1/_apis/testplan/Plans/12/Suites/16/TestPoint"
        }
      },
      "suiteType": "staticTestSuite",
      "name": "s2.2.1",
      "parentSuite": {
        "id": 15,
        "name": "s2.2"
      },
      "inheritDefaultConfigurations": true
    }
  ],
  "count": 3
}

Get Deleted Test Suites of a Test Plan in Tree View.

Sample request

HTTP

GET https://dev.azure.com/fabrikam/p1/_apis/testplan/recycleBin/TestPlan/12/testsuite?asTreeView=True&api-version=7.2-preview.1

Sample response

Status code:: 200

transfer-Encoding: chunked
persistent-Auth: true
lfs-Authenticate: NTLM
wwW-Authenticate: Negotiate oRswGaADCgEAoxIEEAEAAAB/yMsAtyjkcQAAAAA=

{
  "value": [
    {
      "id": 15,
      "revision": 3,
      "project": {
        "id": "9aa0d72c-e93a-4456-9870-9c5169074a96",
        "name": "p1",
        "url": "https://dev.azure.com/fabrikam/_apis/projects/p1",
        "state": "unchanged",
        "visibility": "unchanged",
        "lastUpdateTime": "0001-01-01T00:00:00"
      },
      "lastUpdatedBy": {
        "displayName": "Fabrikam Fiber",
        "url": "https://vssps.dev.azure.com/fabrikam/Aea08ebc7-105f-4bb2-a36b-f92e0e9de65a/_apis/Identities/0fdbdad8-6afb-6149-9af9-c0a216137d1d",
        "_links": {
          "avatar": {
            "href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/msa.OWM2OTQ4NjYtYjFiOS03NTMxLTk4ZTgtN2EwNTk5MGM1MTU0"
          }
        },
        "id": "9c694866-b1b9-6531-98e8-7a05990c5154",
        "uniqueName": "fabrikamfiber1@microsoft.com",
        "imageUrl": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/msa.OWM2OTQ4NjYtYjFiOS03NTMxLTk4ZTgtN2EwNTk5MGM1MTU0",
        "descriptor": "msa.OWM2OTQ4NjYtYjFiOS03NTMxLTk4ZTgtN2EwNTk5MGM1MTU0"
      },
      "lastUpdatedDate": "2024-09-02T11:11:51.193Z",
      "plan": {
        "areaPath": "p1",
        "iteration": "p1",
        "startDate": "2024-09-02T11:10:42.917Z",
        "endDate": "2024-09-09T11:10:42.917Z",
        "rootSuiteId": 13,
        "id": 12,
        "name": "tp2"
      },
      "children": [
        {
          "id": 16,
          "revision": 2,
          "project": {
            "id": "9aa0d72c-e93a-4456-9870-9c5169074a96",
            "name": "p1",
            "url": "https://dev.azure.com/fabrikam/_apis/projects/p1",
            "state": "unchanged",
            "visibility": "unchanged",
            "lastUpdateTime": "0001-01-01T00:00:00"
          },
          "lastUpdatedBy": {
            "displayName": "Fabrikam Fiber",
            "url": "https://vssps.dev.azure.com/fabrikam/Aea08ebc7-105f-4bb2-a36b-f92e0e9de65a/_apis/Identities/0fdbdad8-6afb-6149-9af9-c0a216137d1d",
            "_links": {
              "avatar": {
                "href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/msa.OWM2OTQ4NjYtYjFiOS03NTMxLTk4ZTgtN2EwNTk5MGM1MTU0"
              }
            },
            "id": "9c694866-b1b9-6531-98e8-7a05990c5154",
            "uniqueName": "fabrikamfiber1@microsoft.com",
            "imageUrl": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/msa.OWM2OTQ4NjYtYjFiOS03NTMxLTk4ZTgtN2EwNTk5MGM1MTU0",
            "descriptor": "msa.OWM2OTQ4NjYtYjFiOS03NTMxLTk4ZTgtN2EwNTk5MGM1MTU0"
          },
          "lastUpdatedDate": "2024-09-02T11:11:51.193Z",
          "plan": {
            "id": 12,
            "name": "tp2"
          },
          "_links": {
            "_self": {
              "href": "https://dev.azure.com/fabrikam/p1/_apis/testplan/Plans/12/Suites/16"
            },
            "testCases": {
              "href": "https://dev.azure.com/fabrikam/p1/_apis/testplan/Plans/12/Suites/16/TestCase"
            },
            "testPoints": {
              "href": "https://dev.azure.com/fabrikam/p1/_apis/testplan/Plans/12/Suites/16/TestPoint"
            }
          },
          "suiteType": "staticTestSuite",
          "name": "s2.2.1",
          "parentSuite": {
            "id": 15,
            "name": "s2.2"
          },
          "inheritDefaultConfigurations": true
        }
      ],
      "hasChildren": true,
      "_links": {
        "_self": {
          "href": "https://dev.azure.com/fabrikam/p1/_apis/testplan/Plans/12/Suites/15"
        },
        "testCases": {
          "href": "https://dev.azure.com/fabrikam/p1/_apis/testplan/Plans/12/Suites/15/TestCase"
        },
        "testPoints": {
          "href": "https://dev.azure.com/fabrikam/p1/_apis/testplan/Plans/12/Suites/15/TestPoint"
        }
      },
      "suiteType": "staticTestSuite",
      "name": "s2.2",
      "parentSuite": {
        "id": 13,
        "name": "tp2"
      },
      "inheritDefaultConfigurations": true
    },
    {
      "id": 14,
      "revision": 2,
      "project": {
        "id": "9aa0d72c-e93a-4456-9870-9c5169074a96",
        "name": "p1",
        "url": "https://dev.azure.com/fabrikam/_apis/projects/p1",
        "state": "unchanged",
        "visibility": "unchanged",
        "lastUpdateTime": "0001-01-01T00:00:00"
      },
      "lastUpdatedBy": {
        "displayName": "Fabrikam Fiber",
        "url": "https://vssps.dev.azure.com/fabrikam/Aea08ebc7-105f-4bb2-a36b-f92e0e9de65a/_apis/Identities/0fdbdad8-6afb-6149-9af9-c0a216137d1d",
        "_links": {
          "avatar": {
            "href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/msa.OWM2OTQ4NjYtYjFiOS03NTMxLTk4ZTgtN2EwNTk5MGM1MTU0"
          }
        },
        "id": "9c694866-b1b9-6531-98e8-7a05990c5154",
        "uniqueName": "fabrikamfiber1@microsoft.com",
        "imageUrl": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/msa.OWM2OTQ4NjYtYjFiOS03NTMxLTk4ZTgtN2EwNTk5MGM1MTU0",
        "descriptor": "msa.OWM2OTQ4NjYtYjFiOS03NTMxLTk4ZTgtN2EwNTk5MGM1MTU0"
      },
      "lastUpdatedDate": "2024-09-02T13:14:27.78Z",
      "plan": {
        "areaPath": "p1",
        "iteration": "p1",
        "startDate": "2024-09-02T11:10:42.917Z",
        "endDate": "2024-09-09T11:10:42.917Z",
        "rootSuiteId": 13,
        "id": 12,
        "name": "tp2"
      },
      "_links": {
        "_self": {
          "href": "https://dev.azure.com/fabrikam/p1/_apis/testplan/Plans/12/Suites/14"
        },
        "testCases": {
          "href": "https://dev.azure.com/fabrikam/p1/_apis/testplan/Plans/12/Suites/14/TestCase"
        },
        "testPoints": {
          "href": "https://dev.azure.com/fabrikam/p1/_apis/testplan/Plans/12/Suites/14/TestPoint"
        }
      },
      "suiteType": "staticTestSuite",
      "name": "s2.1",
      "parentSuite": {
        "id": 13,
        "name": "tp2"
      },
      "inheritDefaultConfigurations": true
    }
  ],
  "count": 2
}

Definitions

Name	Description
IdentityRef
ProjectState	Project state.
ProjectVisibility	Project visibility.
ReferenceLinks	The class to represent a collection of REST reference links.
SuiteExpand	Include the children suites and testers details.
TeamProjectReference	Represents a shallow reference to a TeamProject.
TestConfigurationReference	Test Configuration Reference
TestPlanReference	The test plan reference resource.
TestSuite	Test suite
TestSuiteReference	The test suite reference resource.
TestSuiteType	Test suite type.

IdentityRef

Object

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

Enumeration

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 except Deleted.
unchanged	Project has not been changed.
deleted	Project has been deleted.

ProjectVisibility

Enumeration

Project visibility.

Value	Description
private	The project is only visible to users with explicit access.
public	The project is visible to all.

ReferenceLinks

Object

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.

SuiteExpand

Enumeration

Include the children suites and testers details.

Value	Description
none	Dont include any of the expansions in output.
children	Include children in response.
defaultTesters	Include default testers in response.

TeamProjectReference

Object

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.
lastUpdateTime	string (date-time)	Project last update time.
name	string	Project name.
revision	integer (int64)	Project revision.
state	ProjectState	Project state.
url	string	Url to the full version of the object.
visibility	ProjectVisibility	Project visibility.

TestConfigurationReference

Object

Test Configuration Reference

Name	Type	Description
id	integer (int32)	Id of the configuration
name	string	Name of the configuration

TestPlanReference

Object

The test plan reference resource.

Name	Type	Description
id	integer (int32)	ID of the test plan.
name	string	Name of the test plan.

TestSuite

Object

Test suite

Name	Type	Description
_links	ReferenceLinks	Links: self, testPoints, testCases, parent
children	TestSuite[]	Child test suites of current test suite.
defaultConfigurations	TestConfigurationReference[]	Test suite default configurations.
defaultTesters	IdentityRef[]	Test suite default testers.
hasChildren	boolean	Boolean value dictating if Child test suites are present
id	integer (int32)	Id of test suite.
inheritDefaultConfigurations	boolean	Default configuration was inherited or not.
lastError	string	Last error for test suite.
lastPopulatedDate	string (date-time)	Last populated date.
lastUpdatedBy	IdentityRef	IdentityRef of user who has updated test suite recently.
lastUpdatedDate	string (date-time)	Last update date.
name	string	Name of test suite.
parentSuite	TestSuiteReference	Test suite parent shallow reference.
plan	TestPlanReference	Test plan to which the test suite belongs.
project	TeamProjectReference	Test suite project shallow reference.
queryString	string	Test suite query string, for dynamic suites.
requirementId	integer (int32)	Test suite requirement id.
revision	integer (int32)	Test suite revision.
suiteType	TestSuiteType	Test suite type.

TestSuiteReference

Object

The test suite reference resource.

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

TestSuiteType

Enumeration

Test suite type.

Value	Description
none	Default suite type
dynamicTestSuite	Query Based test Suite
staticTestSuite	Static Test Suite
requirementTestSuite	Requirement based Test Suite

Share via

Test Suite Recycle Bin Operations - Get Deleted Test Suites For Plan

URI Parameters

Responses

Security

oauth2

Scopes

Examples

Get all Deleted Test Suites for a Test Plan.

Sample request

Sample response

Get Deleted Test Suites of a Test Plan in Tree View.

Sample request

Sample response

Definitions

IdentityRef

ProjectState

ProjectVisibility

ReferenceLinks

SuiteExpand

TeamProjectReference

TestConfigurationReference

TestPlanReference

TestSuite

TestSuiteReference

TestSuiteType