Edit

Share via


WorkItemTrackingHttpClientBase.GetQueriesAsync Method

Definition

Overloads

GetQueriesAsync(Guid, Nullable<QueryExpand>, Nullable<Int32>, Nullable<Boolean>, Object, CancellationToken)

[Preview API] Gets the root queries and their children

public virtual System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.QueryHierarchyItem>> GetQueriesAsync(Guid project, Nullable<Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.QueryExpand> expand = null, Nullable<int> depth = null, Nullable<bool> includeDeleted = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);
abstract member GetQueriesAsync : Guid * Nullable<Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.QueryExpand> * Nullable<int> * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.QueryHierarchyItem>>
override this.GetQueriesAsync : Guid * Nullable<Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.QueryExpand> * Nullable<int> * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.QueryHierarchyItem>>

Parameters

project
Guid

Project ID

expand
Nullable<QueryExpand>

Include the query string (wiql), clauses, query result columns, and sort options in the results.

depth
Nullable<Int32>

In the folder of queries, return child queries and folders to this depth.

includeDeleted
Nullable<Boolean>

Include deleted queries and folders

userState
Object
cancellationToken
CancellationToken

The cancellation token to cancel operation.

Returns

Applies to

GetQueriesAsync(String, Nullable<QueryExpand>, Nullable<Int32>, Nullable<Boolean>, Object, CancellationToken)

[Preview API] Gets the root queries and their children

public virtual System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.QueryHierarchyItem>> GetQueriesAsync(string project, Nullable<Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.QueryExpand> expand = null, Nullable<int> depth = null, Nullable<bool> includeDeleted = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);
abstract member GetQueriesAsync : string * Nullable<Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.QueryExpand> * Nullable<int> * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.QueryHierarchyItem>>
override this.GetQueriesAsync : string * Nullable<Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.QueryExpand> * Nullable<int> * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.QueryHierarchyItem>>

Parameters

project
String

Project ID or project name

expand
Nullable<QueryExpand>

Include the query string (wiql), clauses, query result columns, and sort options in the results.

depth
Nullable<Int32>

In the folder of queries, return child queries and folders to this depth.

includeDeleted
Nullable<Boolean>

Include deleted queries and folders

userState
Object
cancellationToken
CancellationToken

The cancellation token to cancel operation.

Returns

Applies to