TestCompatHttpClientBase.GetTestSuiteByIdAsync Method

Definition

Namespace:: Microsoft.TeamFoundation.TestManagement.WebApi

Assembly:: Microsoft.TeamFoundation.TestManagement.WebApi.dll

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

GetTestSuiteByIdAsync(Guid, Int32, Int32, Nullable<Boolean>, Object, CancellationToken)	Obsolete. [Preview API]
GetTestSuiteByIdAsync(Guid, Int32, Int32, Nullable<Int32>, Object, CancellationToken)	Obsolete. [Preview API] Get test suite by suite id.
GetTestSuiteByIdAsync(String, Int32, Int32, Nullable<Boolean>, Object, CancellationToken)	Obsolete. [Preview API]
GetTestSuiteByIdAsync(String, Int32, Int32, Nullable<Int32>, Object, CancellationToken)	Obsolete. [Preview API] Get test suite by suite id.

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

Caution

This API is now deprecated.

[Preview API]

[System.Obsolete]
public virtual System.Threading.Tasks.Task<Microsoft.TeamFoundation.TestManagement.WebApi.TestSuite> GetTestSuiteByIdAsync(Guid project, int planId, int suiteId, Nullable<bool> includeChildSuites, object userState, System.Threading.CancellationToken cancellationToken);

abstract member GetTestSuiteByIdAsync : Guid * int * int * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.TestManagement.WebApi.TestSuite>
override this.GetTestSuiteByIdAsync : Guid * int * int * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.TestManagement.WebApi.TestSuite>

Parameters

project: Guid

Project ID

planId: Int32

suiteId: Int32

includeChildSuites: Nullable<Boolean>

userState: Object

cancellationToken: CancellationToken

The cancellation token to cancel operation.

Returns

Task<TestSuite>

Attributes: ObsoleteAttribute

Applies to

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

Caution

This API is now deprecated.

[Preview API] Get test suite by suite id.

[System.Obsolete]
public virtual System.Threading.Tasks.Task<Microsoft.TeamFoundation.TestManagement.WebApi.TestSuite> GetTestSuiteByIdAsync(Guid project, int planId, int suiteId, Nullable<int> expand = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);

abstract member GetTestSuiteByIdAsync : Guid * int * int * Nullable<int> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.TestManagement.WebApi.TestSuite>
override this.GetTestSuiteByIdAsync : Guid * int * int * Nullable<int> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.TestManagement.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<Int32>

Include the children suites and testers details

userState: Object

cancellationToken: CancellationToken

The cancellation token to cancel operation.

Returns

Task<TestSuite>

Attributes: ObsoleteAttribute

Applies to

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

Caution

This API is now deprecated.

[Preview API]

[System.Obsolete]
public virtual System.Threading.Tasks.Task<Microsoft.TeamFoundation.TestManagement.WebApi.TestSuite> GetTestSuiteByIdAsync(string project, int planId, int suiteId, Nullable<bool> includeChildSuites, object userState, System.Threading.CancellationToken cancellationToken);

abstract member GetTestSuiteByIdAsync : string * int * int * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.TestManagement.WebApi.TestSuite>
override this.GetTestSuiteByIdAsync : string * int * int * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.TestManagement.WebApi.TestSuite>

Parameters

project: String

Project ID or project name

planId: Int32

suiteId: Int32

includeChildSuites: Nullable<Boolean>

userState: Object

cancellationToken: CancellationToken

The cancellation token to cancel operation.

Returns

Task<TestSuite>

Attributes: ObsoleteAttribute

Applies to

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

Caution

This API is now deprecated.

[Preview API] Get test suite by suite id.

[System.Obsolete]
public virtual System.Threading.Tasks.Task<Microsoft.TeamFoundation.TestManagement.WebApi.TestSuite> GetTestSuiteByIdAsync(string project, int planId, int suiteId, Nullable<int> expand = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);

abstract member GetTestSuiteByIdAsync : string * int * int * Nullable<int> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.TestManagement.WebApi.TestSuite>
override this.GetTestSuiteByIdAsync : string * int * int * Nullable<int> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.TestManagement.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<Int32>

Include the children suites and testers details

userState: Object

cancellationToken: CancellationToken

The cancellation token to cancel operation.

Returns

Task<TestSuite>

Attributes: ObsoleteAttribute

Applies to

Feedback

Was this page helpful?