TestPlanHttpClientBase.GetTestSuitesForPlanAsync Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
| GetTestSuitesForPlanAsync(String, Int32, Nullable<SuiteExpand>, String, Nullable<Boolean>, Object, CancellationToken) |
[Preview API] Get test suites for plan. |
| GetTestSuitesForPlanAsync(Guid, Int32, Nullable<SuiteExpand>, String, Nullable<Boolean>, Object, CancellationToken) |
[Preview API] Get test suites for plan. |
GetTestSuitesForPlanAsync(String, Int32, Nullable<SuiteExpand>, String, Nullable<Boolean>, Object, CancellationToken)
[Preview API] Get test suites for plan.
public virtual System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.VisualStudio.Services.TestManagement.TestPlanning.WebApi.TestSuite>> GetTestSuitesForPlanAsync(string project, int planId, Nullable<Microsoft.VisualStudio.Services.TestManagement.TestPlanning.WebApi.SuiteExpand> expand = null, string continuationToken = null, Nullable<bool> asTreeView = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);abstract member GetTestSuitesForPlanAsync : string * int * Nullable<Microsoft.VisualStudio.Services.TestManagement.TestPlanning.WebApi.SuiteExpand> * string * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.VisualStudio.Services.TestManagement.TestPlanning.WebApi.TestSuite>>
override this.GetTestSuitesForPlanAsync : string * int * Nullable<Microsoft.VisualStudio.Services.TestManagement.TestPlanning.WebApi.SuiteExpand> * string * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.VisualStudio.Services.TestManagement.TestPlanning.WebApi.TestSuite>>Parameters
- project
- String
Project ID or project name
- planId
- Int32
ID of the test plan for which suites are requested.
- expand
- Nullable<SuiteExpand>
Include the children suites and testers details.
- continuationToken
- 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.
- userState
- Object
- cancellationToken
- CancellationToken
The cancellation token to cancel operation.
Returns
Applies to
GetTestSuitesForPlanAsync(Guid, Int32, Nullable<SuiteExpand>, String, Nullable<Boolean>, Object, CancellationToken)
[Preview API] Get test suites for plan.
public virtual System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.VisualStudio.Services.TestManagement.TestPlanning.WebApi.TestSuite>> GetTestSuitesForPlanAsync(Guid project, int planId, Nullable<Microsoft.VisualStudio.Services.TestManagement.TestPlanning.WebApi.SuiteExpand> expand = null, string continuationToken = null, Nullable<bool> asTreeView = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);abstract member GetTestSuitesForPlanAsync : Guid * int * Nullable<Microsoft.VisualStudio.Services.TestManagement.TestPlanning.WebApi.SuiteExpand> * string * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.VisualStudio.Services.TestManagement.TestPlanning.WebApi.TestSuite>>
override this.GetTestSuitesForPlanAsync : Guid * int * Nullable<Microsoft.VisualStudio.Services.TestManagement.TestPlanning.WebApi.SuiteExpand> * string * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.VisualStudio.Services.TestManagement.TestPlanning.WebApi.TestSuite>>Parameters
- project
- Guid
Project ID
- planId
- Int32
ID of the test plan for which suites are requested.
- expand
- Nullable<SuiteExpand>
Include the children suites and testers details.
- continuationToken
- 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.
- userState
- Object
- cancellationToken
- CancellationToken
The cancellation token to cancel operation.