WorkItemTrackingHttpClientBase.GetQueryAsync Method

Definition

Namespace:

Microsoft.TeamFoundation.WorkItemTracking.WebApi

Assembly:

Microsoft.TeamFoundation.WorkItemTracking.WebApi.dll

Overloads

GetQueryAsync(Guid, String, Nullable<QueryExpand>, Nullable<Int32>, Nullable<Boolean>, Object, CancellationToken)	[Preview API] Retrieves an individual query and its children
GetQueryAsync(String, String, Nullable<QueryExpand>, Nullable<Int32>, Nullable<Boolean>, Object, CancellationToken)	[Preview API] Retrieves an individual query and its children

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

[Preview API] Retrieves an individual query and its children

public virtual System.Threading.Tasks.Task<Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.QueryHierarchyItem> GetQueryAsync (Guid project, string query, 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 GetQueryAsync : Guid * string * Nullable<Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.QueryExpand> * Nullable<int> * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.QueryHierarchyItem>
override this.GetQueryAsync : Guid * string * Nullable<Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.QueryExpand> * Nullable<int> * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.QueryHierarchyItem>

Parameters

project

Guid

Project ID

query

String

ID or path of the query.

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

Task<QueryHierarchyItem>

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

[Preview API] Retrieves an individual query and its children

public virtual System.Threading.Tasks.Task<Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.QueryHierarchyItem> GetQueryAsync (string project, string query, 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 GetQueryAsync : string * string * Nullable<Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.QueryExpand> * Nullable<int> * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.QueryHierarchyItem>
override this.GetQueryAsync : string * string * Nullable<Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.QueryExpand> * Nullable<int> * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.QueryHierarchyItem>

Parameters

project

String

Project ID or project name

query

String

ID or path of the query.

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

Task<QueryHierarchyItem>