Test Suites - Get Test Suites For Plan
Get test suites for plan.
GET https://dev.azure.com/{organization}/{project}/_apis/testplan/Plans/{planId}/suites?api-version=7.1-preview.1GET https://dev.azure.com/{organization}/{project}/_apis/testplan/Plans/{planId}/suites?expand={expand}&continuationToken={continuationToken}&asTreeView={asTreeView}&api-version=7.1-preview.1URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
|
organization
|
path | True |
string |
The name of the Azure DevOps organization. |
|
plan
|
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.1-preview.1' to use this version of the api. |
|
as
|
query |
boolean |
If the suites returned should be in a tree structure. |
|
|
continuation
|
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 |
Include the children suites and testers details. |
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 | Grants the ability to read test plans, cases, results and other test management related artifacts. |
Examples
| Get a test suites for plan as tree view. |
| Get a test suites for plan. |
Get a test suites for plan as tree view.
Sample Request
GET https://dev.azure.com/fabrikam/{project}/_apis/testplan/Plans/{planId}/suites?asTreeView=True&api-version=7.1-preview.1
Sample Response
transfer-Encoding: chunked
persistent-Auth: true
lfs-Authenticate: NTLM
wwW-Authenticate: Negotiate oRswGaADCgEAoxIEEAEAAADl/2OYCIdnSwAAAAA={
"value": [
{
"id": 80,
"revision": 5,
"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/aad.MGZkYmRhZDgtNmFmYi03MTQ5LTlhZjktYzBhMjE2MTM3ZDFk"
}
},
"id": "9b6bee0e-28b2-42b6-ab5b-5122b63d473c",
"uniqueName": "fabrikamfiber1@microsoft.com",
"imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=0fdbdad8-6afb-6149-9af9-c0a216137d1d",
"descriptor": "win.Uy0xLTUtMjEtMjE0Njc3MzA4NS05MDMzNjMyODUtNzE5MzQ0NzA3LTIwMjE0OTM"
},
"lastUpdatedDate": "2018-08-31T10:16:35.683Z",
"plan": {
"id": 79,
"name": "79"
},
"children": [
{
"id": 84,
"revision": 1,
"lastPopulatedDate": "2018-08-31T10:16:54.82Z",
"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/aad.MGZkYmRhZDgtNmFmYi03MTQ5LTlhZjktYzBhMjE2MTM3ZDFk"
}
},
"id": "9b6bee0e-28b2-42b6-ab5b-5122b63d473c",
"uniqueName": "fabrikamfiber1@microsoft.com",
"imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=0fdbdad8-6afb-6149-9af9-c0a216137d1d",
"descriptor": "win.Uy0xLTUtMjEtMjE0Njc3MzA4NS05MDMzNjMyODUtNzE5MzQ0NzA3LTIwMjE0OTM"
},
"lastUpdatedDate": "2018-08-31T10:11:53.12Z",
"plan": {
"id": 79,
"name": "79"
},
"_links": {
"_self": {
"href": "https://dev.azure.com/fabrikam/MyProject/_apis/testplan/Plans/79/Suites/84"
},
"testCases": {
"href": "https://dev.azure.com/fabrikam/MyProject/_apis/test/Plans/79/Suites/84/TestCases"
},
"testPoints": {
"href": "https://dev.azure.com/fabrikam/MyProject/_apis/test/Plans/79/Suites/84/Points"
}
},
"suiteType": "dynamicTestSuite",
"name": "New query-based suite",
"parentSuite": {
"id": 80,
"name": "Sample Test Plan"
},
"queryString": "select [System.Id], [System.WorkItemType], [System.Title], [Microsoft.VSTS.Common.Priority], [System.AssignedTo], [System.AreaPath] from WorkItems where [System.TeamProject] = @project and [System.WorkItemType] in group 'Microsoft.TestCaseCategory' and [System.AreaPath] under 'Project1'",
"inheritDefaultConfigurations": true
},
{
"id": 83,
"revision": 2,
"lastPopulatedDate": "2018-08-31T10:19:57.067Z",
"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/aad.MGZkYmRhZDgtNmFmYi03MTQ5LTlhZjktYzBhMjE2MTM3ZDFk"
}
},
"id": "9b6bee0e-28b2-42b6-ab5b-5122b63d473c",
"uniqueName": "fabrikamfiber1@microsoft.com",
"imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=0fdbdad8-6afb-6149-9af9-c0a216137d1d",
"descriptor": "win.Uy0xLTUtMjEtMjE0Njc3MzA4NS05MDMzNjMyODUtNzE5MzQ0NzA3LTIwMjE0OTM"
},
"lastUpdatedDate": "2018-08-31T10:19:55.8Z",
"plan": {
"id": 79,
"name": "79"
},
"_links": {
"_self": {
"href": "https://dev.azure.com/fabrikam/MyProject/_apis/testplan/Plans/79/Suites/83"
},
"testCases": {
"href": "https://dev.azure.com/fabrikam/MyProject/_apis/test/Plans/79/Suites/83/TestCases"
},
"testPoints": {
"href": "https://dev.azure.com/fabrikam/MyProject/_apis/test/Plans/79/Suites/83/Points"
}
},
"suiteType": "requirementTestSuite",
"requirementId": 4,
"name": "4 : us1",
"parentSuite": {
"id": 80,
"name": "Sample Test Plan"
},
"inheritDefaultConfigurations": true
},
{
"id": 81,
"revision": 6,
"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/aad.MGZkYmRhZDgtNmFmYi03MTQ5LTlhZjktYzBhMjE2MTM3ZDFk"
}
},
"id": "9b6bee0e-28b2-42b6-ab5b-5122b63d473c",
"uniqueName": "fabrikamfiber1@microsoft.com",
"imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=0fdbdad8-6afb-6149-9af9-c0a216137d1d",
"descriptor": "win.Uy0xLTUtMjEtMjE0Njc3MzA4NS05MDMzNjMyODUtNzE5MzQ0NzA3LTIwMjE0OTM"
},
"lastUpdatedDate": "2018-08-31T10:12:20.33Z",
"plan": {
"id": 79,
"name": "79"
},
"children": [
{
"id": 86,
"revision": 2,
"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/aad.MGZkYmRhZDgtNmFmYi03MTQ5LTlhZjktYzBhMjE2MTM3ZDFk"
}
},
"id": "9b6bee0e-28b2-42b6-ab5b-5122b63d473c",
"uniqueName": "fabrikamfiber1@microsoft.com",
"imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=0fdbdad8-6afb-6149-9af9-c0a216137d1d",
"descriptor": "win.Uy0xLTUtMjEtMjE0Njc3MzA4NS05MDMzNjMyODUtNzE5MzQ0NzA3LTIwMjE0OTM"
},
"lastUpdatedDate": "2018-08-31T10:12:28.417Z",
"plan": {
"id": 79,
"name": "79"
},
"_links": {
"_self": {
"href": "https://dev.azure.com/fabrikam/MyProject/_apis/testplan/Plans/79/Suites/86"
},
"testCases": {
"href": "https://dev.azure.com/fabrikam/MyProject/_apis/test/Plans/79/Suites/86/TestCases"
},
"testPoints": {
"href": "https://dev.azure.com/fabrikam/MyProject/_apis/test/Plans/79/Suites/86/Points"
}
},
"suiteType": "staticTestSuite",
"name": "SubSuite 1.2",
"parentSuite": {
"id": 81,
"name": "Sample Static Suite 1"
},
"inheritDefaultConfigurations": true
},
{
"id": 85,
"revision": 2,
"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/aad.MGZkYmRhZDgtNmFmYi03MTQ5LTlhZjktYzBhMjE2MTM3ZDFk"
}
},
"id": "9b6bee0e-28b2-42b6-ab5b-5122b63d473c",
"uniqueName": "fabrikamfiber1@microsoft.com",
"imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=0fdbdad8-6afb-6149-9af9-c0a216137d1d",
"descriptor": "win.Uy0xLTUtMjEtMjE0Njc3MzA4NS05MDMzNjMyODUtNzE5MzQ0NzA3LTIwMjE0OTM"
},
"lastUpdatedDate": "2018-08-31T10:12:14.75Z",
"plan": {
"id": 79,
"name": "79"
},
"_links": {
"_self": {
"href": "https://dev.azure.com/fabrikam/MyProject/_apis/testplan/Plans/79/Suites/85"
},
"testCases": {
"href": "https://dev.azure.com/fabrikam/MyProject/_apis/test/Plans/79/Suites/85/TestCases"
},
"testPoints": {
"href": "https://dev.azure.com/fabrikam/MyProject/_apis/test/Plans/79/Suites/85/Points"
}
},
"suiteType": "staticTestSuite",
"name": "SubSuite 1.1",
"parentSuite": {
"id": 81,
"name": "Sample Static Suite 1"
},
"inheritDefaultConfigurations": true
}
],
"_links": {
"_self": {
"href": "https://dev.azure.com/fabrikam/MyProject/_apis/testplan/Plans/79/Suites/81"
},
"testCases": {
"href": "https://dev.azure.com/fabrikam/MyProject/_apis/test/Plans/79/Suites/81/TestCases"
},
"testPoints": {
"href": "https://dev.azure.com/fabrikam/MyProject/_apis/test/Plans/79/Suites/81/Points"
}
},
"suiteType": "staticTestSuite",
"name": "Sample Static Suite 1",
"parentSuite": {
"id": 80,
"name": "Sample Test Plan"
},
"inheritDefaultConfigurations": true
}
],
"_links": {
"_self": {
"href": "https://dev.azure.com/fabrikam/MyProject/_apis/testplan/Plans/79/Suites/80"
},
"testCases": {
"href": "https://dev.azure.com/fabrikam/MyProject/_apis/test/Plans/79/Suites/80/TestCases"
},
"testPoints": {
"href": "https://dev.azure.com/fabrikam/MyProject/_apis/test/Plans/79/Suites/80/Points"
}
},
"suiteType": "staticTestSuite",
"name": "Sample Test Plan",
"inheritDefaultConfigurations": false,
"defaultConfigurations": [
{
"id": 1,
"name": "Windows 10"
},
{
"id": 2,
"name": "Windows 8"
}
]
}
],
"count": 1
}Get a test suites for plan.
Sample Request
GET https://dev.azure.com/fabrikam/{project}/_apis/testplan/Plans/{planId}/suites?expand=Children, DefaultTesters&api-version=7.1-preview.1
Sample Response
transfer-Encoding: chunked
persistent-Auth: true
lfs-Authenticate: NTLM
wwW-Authenticate: Negotiate oRswGaADCgEAoxIEEAEAAAB/yMsAtyjkcQAAAAA={
"value": [
{
"id": 80,
"revision": 5,
"project": {
"id": "499b955d-7143-4382-932e-9cd17df45f83",
"name": "Project1",
"url": "https://dev.azure.com/fabrikam/_apis/projects/MyProject",
"state": "unchanged",
"visibility": "unchanged"
},
"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/aad.MGZkYmRhZDgtNmFmYi03MTQ5LTlhZjktYzBhMjE2MTM3ZDFk"
}
},
"id": "9b6bee0e-28b2-42b6-ab5b-5122b63d473c",
"uniqueName": "fabrikamfiber1@microsoft.com",
"imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=0fdbdad8-6afb-6149-9af9-c0a216137d1d",
"descriptor": "win.Uy0xLTUtMjEtMjE0Njc3MzA4NS05MDMzNjMyODUtNzE5MzQ0NzA3LTIwMjE0OTM"
},
"lastUpdatedDate": "2018-08-31T10:16:35.683Z",
"plan": {
"id": 79,
"name": "Sample Test Plan"
},
"_links": {
"_self": {
"href": "https://dev.azure.com/fabrikam/MyProject/_apis/testplan/Plans/79/Suites/80"
},
"testCases": {
"href": "https://dev.azure.com/fabrikam/MyProject/_apis/test/Plans/79/Suites/80/TestCases"
},
"testPoints": {
"href": "https://dev.azure.com/fabrikam/MyProject/_apis/test/Plans/79/Suites/80/Points"
}
},
"suiteType": "staticTestSuite",
"name": "Sample Test Plan",
"inheritDefaultConfigurations": false,
"defaultConfigurations": [
{
"id": 1,
"name": "Windows 10"
},
{
"id": 2,
"name": "Windows 8"
}
],
"defaultTesters": [
{
"displayName": "VSEQA1",
"url": "http://https://dev.azure.com/fabrikam/_apis/Identities/f5b77bcb-8353-44bd-9d9f-74a7523ddd82",
"_links": {
"avatar": {
"href": "http://https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/win.Uy0xLTUtMjEtMjEyNzUyMTE4NC0xNjA0MDEyOTIwLTE4ODc5Mjc1MjctMTgwMzU2MQ"
}
},
"id": "f5b77bcb-8353-44bd-9d9f-74a7523ddd82",
"uniqueName": "REDMOND\\vseqa1",
"imageUrl": "http://https://dev.azure.com/fabrikam/_api/_common/identityImage?id=f5b77bcb-8353-44bd-9d9f-74a7523ddd82",
"descriptor": "win.Uy0xLTUtMjEtMjEyNzUyMTE4NC0xNjA0MDEyOTIwLTE4ODc5Mjc1MjctMTgwMzU2MQ"
}
]
},
{
"id": 81,
"revision": 6,
"project": {
"id": "499b955d-7143-4382-932e-9cd17df45f83",
"name": "Project1",
"url": "https://dev.azure.com/fabrikam/_apis/projects/MyProject",
"state": "unchanged",
"visibility": "unchanged"
},
"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/aad.MGZkYmRhZDgtNmFmYi03MTQ5LTlhZjktYzBhMjE2MTM3ZDFk"
}
},
"id": "9b6bee0e-28b2-42b6-ab5b-5122b63d473c",
"uniqueName": "fabrikamfiber1@microsoft.com",
"imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=0fdbdad8-6afb-6149-9af9-c0a216137d1d",
"descriptor": "win.Uy0xLTUtMjEtMjE0Njc3MzA4NS05MDMzNjMyODUtNzE5MzQ0NzA3LTIwMjE0OTM"
},
"lastUpdatedDate": "2018-08-31T10:12:20.33Z",
"plan": {
"id": 79,
"name": "Sample Test Plan"
},
"_links": {
"_self": {
"href": "https://dev.azure.com/fabrikam/MyProject/_apis/testplan/Plans/79/Suites/81"
},
"testCases": {
"href": "https://dev.azure.com/fabrikam/MyProject/_apis/test/Plans/79/Suites/81/TestCases"
},
"testPoints": {
"href": "https://dev.azure.com/fabrikam/MyProject/_apis/test/Plans/79/Suites/81/Points"
}
},
"suiteType": "staticTestSuite",
"name": "Sample Static Suite 1",
"parentSuite": {
"id": 80,
"name": "Sample Test Plan"
},
"inheritDefaultConfigurations": true
},
{
"id": 83,
"revision": 2,
"project": {
"id": "499b955d-7143-4382-932e-9cd17df45f83",
"name": "Project1",
"url": "https://dev.azure.com/fabrikam/_apis/projects/MyProject",
"state": "unchanged",
"visibility": "unchanged"
},
"lastPopulatedDate": "2018-08-31T10:19:57.067Z",
"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/aad.MGZkYmRhZDgtNmFmYi03MTQ5LTlhZjktYzBhMjE2MTM3ZDFk"
}
},
"id": "9b6bee0e-28b2-42b6-ab5b-5122b63d473c",
"uniqueName": "fabrikamfiber1@microsoft.com",
"imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=0fdbdad8-6afb-6149-9af9-c0a216137d1d",
"descriptor": "win.Uy0xLTUtMjEtMjE0Njc3MzA4NS05MDMzNjMyODUtNzE5MzQ0NzA3LTIwMjE0OTM"
},
"lastUpdatedDate": "2018-08-31T10:19:55.8Z",
"plan": {
"id": 79,
"name": "Sample Test Plan"
},
"_links": {
"_self": {
"href": "https://dev.azure.com/fabrikam/MyProject/_apis/testplan/Plans/79/Suites/83"
},
"testCases": {
"href": "https://dev.azure.com/fabrikam/MyProject/_apis/test/Plans/79/Suites/83/TestCases"
},
"testPoints": {
"href": "https://dev.azure.com/fabrikam/MyProject/_apis/test/Plans/79/Suites/83/Points"
}
},
"suiteType": "requirementTestSuite",
"requirementId": 4,
"name": "4 : us1",
"parentSuite": {
"id": 80,
"name": "Sample Test Plan"
},
"inheritDefaultConfigurations": true,
"defaultTesters": [
{
"displayName": "VSEQA1",
"url": "http://https://dev.azure.com/fabrikam/_apis/Identities/f5b77bcb-8353-44bd-9d9f-74a7523ddd82",
"_links": {
"avatar": {
"href": "http://https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/win.Uy0xLTUtMjEtMjEyNzUyMTE4NC0xNjA0MDEyOTIwLTE4ODc5Mjc1MjctMTgwMzU2MQ"
}
},
"id": "f5b77bcb-8353-44bd-9d9f-74a7523ddd82",
"uniqueName": "REDMOND\\vseqa1",
"imageUrl": "http://https://dev.azure.com/fabrikam/_api/_common/identityImage?id=f5b77bcb-8353-44bd-9d9f-74a7523ddd82",
"descriptor": "win.Uy0xLTUtMjEtMjEyNzUyMTE4NC0xNjA0MDEyOTIwLTE4ODc5Mjc1MjctMTgwMzU2MQ"
}
]
},
{
"id": 84,
"revision": 1,
"project": {
"id": "499b955d-7143-4382-932e-9cd17df45f83",
"name": "Project1",
"url": "https://dev.azure.com/fabrikam/_apis/projects/MyProject",
"state": "unchanged",
"visibility": "unchanged"
},
"lastPopulatedDate": "2018-08-31T10:16:54.82Z",
"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/aad.MGZkYmRhZDgtNmFmYi03MTQ5LTlhZjktYzBhMjE2MTM3ZDFk"
}
},
"id": "9b6bee0e-28b2-42b6-ab5b-5122b63d473c",
"uniqueName": "fabrikamfiber1@microsoft.com",
"imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=0fdbdad8-6afb-6149-9af9-c0a216137d1d",
"descriptor": "win.Uy0xLTUtMjEtMjE0Njc3MzA4NS05MDMzNjMyODUtNzE5MzQ0NzA3LTIwMjE0OTM"
},
"lastUpdatedDate": "2018-08-31T10:11:53.12Z",
"plan": {
"id": 79,
"name": "Sample Test Plan"
},
"_links": {
"_self": {
"href": "https://dev.azure.com/fabrikam/MyProject/_apis/testplan/Plans/79/Suites/84"
},
"testCases": {
"href": "https://dev.azure.com/fabrikam/MyProject/_apis/test/Plans/79/Suites/84/TestCases"
},
"testPoints": {
"href": "https://dev.azure.com/fabrikam/MyProject/_apis/test/Plans/79/Suites/84/Points"
}
},
"suiteType": "dynamicTestSuite",
"name": "New query-based suite",
"parentSuite": {
"id": 80,
"name": "Sample Test Plan"
},
"queryString": "select [System.Id], [System.WorkItemType], [System.Title], [Microsoft.VSTS.Common.Priority], [System.AssignedTo], [System.AreaPath] from WorkItems where [System.TeamProject] = @project and [System.WorkItemType] in group 'Microsoft.TestCaseCategory' and [System.AreaPath] under 'Project1'",
"inheritDefaultConfigurations": true
},
{
"id": 85,
"revision": 2,
"project": {
"id": "499b955d-7143-4382-932e-9cd17df45f83",
"name": "Project1",
"url": "https://dev.azure.com/fabrikam/_apis/projects/MyProject",
"state": "unchanged",
"visibility": "unchanged"
},
"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/aad.MGZkYmRhZDgtNmFmYi03MTQ5LTlhZjktYzBhMjE2MTM3ZDFk"
}
},
"id": "9b6bee0e-28b2-42b6-ab5b-5122b63d473c",
"uniqueName": "fabrikamfiber1@microsoft.com",
"imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=0fdbdad8-6afb-6149-9af9-c0a216137d1d",
"descriptor": "win.Uy0xLTUtMjEtMjE0Njc3MzA4NS05MDMzNjMyODUtNzE5MzQ0NzA3LTIwMjE0OTM"
},
"lastUpdatedDate": "2018-08-31T10:12:14.75Z",
"plan": {
"id": 79,
"name": "Sample Test Plan"
},
"_links": {
"_self": {
"href": "https://dev.azure.com/fabrikam/MyProject/_apis/testplan/Plans/79/Suites/85"
},
"testCases": {
"href": "https://dev.azure.com/fabrikam/MyProject/_apis/test/Plans/79/Suites/85/TestCases"
},
"testPoints": {
"href": "https://dev.azure.com/fabrikam/MyProject/_apis/test/Plans/79/Suites/85/Points"
}
},
"suiteType": "staticTestSuite",
"name": "SubSuite 1.1",
"parentSuite": {
"id": 81,
"name": "Sample Static Suite 1"
},
"inheritDefaultConfigurations": true
},
{
"id": 86,
"revision": 2,
"project": {
"id": "499b955d-7143-4382-932e-9cd17df45f83",
"name": "Project1",
"url": "https://dev.azure.com/fabrikam/_apis/projects/MyProject",
"state": "unchanged",
"visibility": "unchanged"
},
"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/aad.MGZkYmRhZDgtNmFmYi03MTQ5LTlhZjktYzBhMjE2MTM3ZDFk"
}
},
"id": "9b6bee0e-28b2-42b6-ab5b-5122b63d473c",
"uniqueName": "fabrikamfiber1@microsoft.com",
"imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=0fdbdad8-6afb-6149-9af9-c0a216137d1d",
"descriptor": "win.Uy0xLTUtMjEtMjE0Njc3MzA4NS05MDMzNjMyODUtNzE5MzQ0NzA3LTIwMjE0OTM"
},
"lastUpdatedDate": "2018-08-31T10:12:28.417Z",
"plan": {
"id": 79,
"name": "Sample Test Plan"
},
"_links": {
"_self": {
"href": "https://dev.azure.com/fabrikam/MyProject/_apis/testplan/Plans/79/Suites/86"
},
"testCases": {
"href": "https://dev.azure.com/fabrikam/MyProject/_apis/test/Plans/79/Suites/86/TestCases"
},
"testPoints": {
"href": "https://dev.azure.com/fabrikam/MyProject/_apis/test/Plans/79/Suites/86/Points"
}
},
"suiteType": "staticTestSuite",
"name": "SubSuite 1.2",
"parentSuite": {
"id": 81,
"name": "Sample Static Suite 1"
},
"inheritDefaultConfigurations": true
}
],
"count": 6
}Definitions
| Name | Description |
|---|---|
|
Identity |
|
|
Project |
Project state. |
|
Project |
Project visibility. |
|
Reference |
The class to represent a collection of REST reference links. |
|
Suite |
Include the children suites and testers details. |
|
Team |
Represents a shallow reference to a TeamProject. |
|
Test |
Test Configuration Reference |
|
Test |
The test plan reference resource. |
|
Test |
Test suite |
|
Test |
The test suite reference resource. |
|
Test |
Test suite type. |
IdentityRef
| Name | Type | Description |
|---|---|---|
| _links |
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 except Deleted. |
| 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. |
SuiteExpand
Include the children suites and testers details.
| Name | Type | Description |
|---|---|---|
| children |
string |
Include children in response. |
| defaultTesters |
string |
Include default testers in response. |
| none |
string |
Dont include any of the expansions in output. |
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 |
Project state. |
|
| url |
string |
Url to the full version of the object. |
| visibility |
Project visibility. |
TestConfigurationReference
Test Configuration Reference
| Name | Type | Description |
|---|---|---|
| id |
integer |
Id of the configuration |
| name |
string |
Name of the configuration |
TestPlanReference
The test plan reference resource.
| Name | Type | Description |
|---|---|---|
| id |
integer |
ID of the test plan. |
| name |
string |
Name of the test plan. |
TestSuite
Test suite
| Name | Type | Description |
|---|---|---|
| _links |
Links: self, testPoints, testCases, parent |
|
| children |
Child test suites of current test suite. |
|
| defaultConfigurations |
Test suite default configurations. |
|
| defaultTesters |
Test suite default testers. |
|
| hasChildren |
boolean |
Boolean value dictating if Child test suites are present |
| id |
integer |
Id of test suite. |
| inheritDefaultConfigurations |
boolean |
Default configuration was inherited or not. |
| lastError |
string |
Last error for test suite. |
| lastPopulatedDate |
string |
Last populated date. |
| lastUpdatedBy |
IdentityRef of user who has updated test suite recently. |
|
| lastUpdatedDate |
string |
Last update date. |
| name |
string |
Name of test suite. |
| parentSuite |
Test suite parent shallow reference. |
|
| plan |
Test plan to which the test suite belongs. |
|
| project |
Test suite project shallow reference. |
|
| queryString |
string |
Test suite query string, for dynamic suites. |
| requirementId |
integer |
Test suite requirement id. |
| revision |
integer |
Test suite revision. |
| suiteType |
Test suite type. |
TestSuiteReference
The test suite reference resource.
| Name | Type | Description |
|---|---|---|
| id |
integer |
ID of the test suite. |
| name |
string |
Name of the test suite. |
TestSuiteType
Test suite type.
| Name | Type | Description |
|---|---|---|
| dynamicTestSuite |
string |
Query Based test Suite |
| none |
string |
Default suite type |
| requirementTestSuite |
string |
Requirement based Test Suite |
| staticTestSuite |
string |
Static Test Suite |
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for