Edit

Share via


TestPlanHttpClientBase.GetTestSuiteByIdAsync Method

Definition

Overloads

GetTestSuiteByIdAsync(Guid, Int32, Int32, Nullable<SuiteExpand>, Object, CancellationToken)

[Preview API] Get test suite by suite id.

GetTestSuiteByIdAsync(String, Int32, Int32, Nullable<SuiteExpand>, Object, CancellationToken)

[Preview API] Get test suite by suite id.

GetTestSuiteByIdAsync(Guid, Int32, Int32, Nullable<SuiteExpand>, Object, CancellationToken)

[Preview API] Get test suite by suite id.

public virtual System.Threading.Tasks.Task<Microsoft.VisualStudio.Services.TestManagement.TestPlanning.WebApi.TestSuite> GetTestSuiteByIdAsync (Guid project, int planId, int suiteId, Nullable<Microsoft.VisualStudio.Services.TestManagement.TestPlanning.WebApi.SuiteExpand> expand = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);
abstract member GetTestSuiteByIdAsync : Guid * int * int * Nullable<Microsoft.VisualStudio.Services.TestManagement.TestPlanning.WebApi.SuiteExpand> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.VisualStudio.Services.TestManagement.TestPlanning.WebApi.TestSuite>
override this.GetTestSuiteByIdAsync : Guid * int * int * Nullable<Microsoft.VisualStudio.Services.TestManagement.TestPlanning.WebApi.SuiteExpand> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.VisualStudio.Services.TestManagement.TestPlanning.WebApi.TestSuite>

Parameters

project
Guid

Project ID

planId
Int32

ID of the test plan that contains the suites.

suiteId
Int32

ID of the suite to get.

expand
Nullable<SuiteExpand>

Include the children suites and testers details

userState
Object
cancellationToken
CancellationToken

The cancellation token to cancel operation.

Returns

Applies to

GetTestSuiteByIdAsync(String, Int32, Int32, Nullable<SuiteExpand>, Object, CancellationToken)

[Preview API] Get test suite by suite id.

public virtual System.Threading.Tasks.Task<Microsoft.VisualStudio.Services.TestManagement.TestPlanning.WebApi.TestSuite> GetTestSuiteByIdAsync (string project, int planId, int suiteId, Nullable<Microsoft.VisualStudio.Services.TestManagement.TestPlanning.WebApi.SuiteExpand> expand = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);
abstract member GetTestSuiteByIdAsync : string * int * int * Nullable<Microsoft.VisualStudio.Services.TestManagement.TestPlanning.WebApi.SuiteExpand> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.VisualStudio.Services.TestManagement.TestPlanning.WebApi.TestSuite>
override this.GetTestSuiteByIdAsync : string * int * int * Nullable<Microsoft.VisualStudio.Services.TestManagement.TestPlanning.WebApi.SuiteExpand> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.VisualStudio.Services.TestManagement.TestPlanning.WebApi.TestSuite>

Parameters

project
String

Project ID or project name

planId
Int32

ID of the test plan that contains the suites.

suiteId
Int32

ID of the suite to get.

expand
Nullable<SuiteExpand>

Include the children suites and testers details

userState
Object
cancellationToken
CancellationToken

The cancellation token to cancel operation.

Returns

Applies to