Edit

Share via


TestPlanHttpClientBase.GetTestPlansAsync Method

Definition

Overloads

GetTestPlansAsync(Guid, String, String, Nullable<Boolean>, Nullable<Boolean>, Object, CancellationToken)

[Preview API] Get a list of test plans

GetTestPlansAsync(String, String, String, Nullable<Boolean>, Nullable<Boolean>, Object, CancellationToken)

[Preview API] Get a list of test plans

GetTestPlansAsync(Guid, String, String, Nullable<Boolean>, Nullable<Boolean>, Object, CancellationToken)

[Preview API] Get a list of test plans

public virtual System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.VisualStudio.Services.TestManagement.TestPlanning.WebApi.TestPlan>> GetTestPlansAsync (Guid project, string owner = null, string continuationToken = null, Nullable<bool> includePlanDetails = null, Nullable<bool> filterActivePlans = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);
abstract member GetTestPlansAsync : Guid * string * string * Nullable<bool> * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.VisualStudio.Services.TestManagement.TestPlanning.WebApi.TestPlan>>
override this.GetTestPlansAsync : Guid * string * string * Nullable<bool> * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.VisualStudio.Services.TestManagement.TestPlanning.WebApi.TestPlan>>

Parameters

project
Guid

Project ID

owner
String

Filter for test plan by owner ID or name

continuationToken
String

If the list of plans returned is not complete, a continuation token to query next batch of plans is included in the response header as "x-ms-continuationtoken". Omit this parameter to get the first batch of test plans.

includePlanDetails
Nullable<Boolean>

Get all properties of the test plan

filterActivePlans
Nullable<Boolean>

Get just the active plans

userState
Object
cancellationToken
CancellationToken

The cancellation token to cancel operation.

Returns

Applies to

GetTestPlansAsync(String, String, String, Nullable<Boolean>, Nullable<Boolean>, Object, CancellationToken)

[Preview API] Get a list of test plans

public virtual System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.VisualStudio.Services.TestManagement.TestPlanning.WebApi.TestPlan>> GetTestPlansAsync (string project, string owner = null, string continuationToken = null, Nullable<bool> includePlanDetails = null, Nullable<bool> filterActivePlans = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);
abstract member GetTestPlansAsync : string * string * string * Nullable<bool> * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.VisualStudio.Services.TestManagement.TestPlanning.WebApi.TestPlan>>
override this.GetTestPlansAsync : string * string * string * Nullable<bool> * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.VisualStudio.Services.TestManagement.TestPlanning.WebApi.TestPlan>>

Parameters

project
String

Project ID or project name

owner
String

Filter for test plan by owner ID or name

continuationToken
String

If the list of plans returned is not complete, a continuation token to query next batch of plans is included in the response header as "x-ms-continuationtoken". Omit this parameter to get the first batch of test plans.

includePlanDetails
Nullable<Boolean>

Get all properties of the test plan

filterActivePlans
Nullable<Boolean>

Get just the active plans

userState
Object
cancellationToken
CancellationToken

The cancellation token to cancel operation.

Returns

Applies to