Edit

Share via


WorkItemTrackingHttpClientBase.GetWorkItemAsync Method

Definition

Overloads

GetWorkItemAsync(Int32, IEnumerable<String>, Nullable<DateTime>, Nullable<WorkItemExpand>, Object, CancellationToken)

[Preview API] Returns a single work item.

GetWorkItemAsync(Guid, Int32, IEnumerable<String>, Nullable<DateTime>, Nullable<WorkItemExpand>, Object, CancellationToken)

[Preview API] Returns a single work item.

GetWorkItemAsync(String, Int32, IEnumerable<String>, Nullable<DateTime>, Nullable<WorkItemExpand>, Object, CancellationToken)

[Preview API] Returns a single work item.

GetWorkItemAsync(Int32, IEnumerable<String>, Nullable<DateTime>, Nullable<WorkItemExpand>, Object, CancellationToken)

[Preview API] Returns a single work item.

public virtual System.Threading.Tasks.Task<Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItem> GetWorkItemAsync (int id, System.Collections.Generic.IEnumerable<string> fields = null, Nullable<DateTime> asOf = null, Nullable<Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemExpand> expand = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);
abstract member GetWorkItemAsync : int * seq<string> * Nullable<DateTime> * Nullable<Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemExpand> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItem>
override this.GetWorkItemAsync : int * seq<string> * Nullable<DateTime> * Nullable<Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemExpand> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItem>

Parameters

id
Int32

The work item id

fields
IEnumerable<String>

Comma-separated list of requested fields

asOf
Nullable<DateTime>

AsOf UTC date time string

expand
Nullable<WorkItemExpand>

The expand parameters for work item attributes. Possible options are { None, Relations, Fields, Links, All }.

userState
Object
cancellationToken
CancellationToken

The cancellation token to cancel operation.

Returns

Applies to

GetWorkItemAsync(Guid, Int32, IEnumerable<String>, Nullable<DateTime>, Nullable<WorkItemExpand>, Object, CancellationToken)

[Preview API] Returns a single work item.

public virtual System.Threading.Tasks.Task<Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItem> GetWorkItemAsync (Guid project, int id, System.Collections.Generic.IEnumerable<string> fields = null, Nullable<DateTime> asOf = null, Nullable<Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemExpand> expand = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);
abstract member GetWorkItemAsync : Guid * int * seq<string> * Nullable<DateTime> * Nullable<Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemExpand> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItem>
override this.GetWorkItemAsync : Guid * int * seq<string> * Nullable<DateTime> * Nullable<Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemExpand> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItem>

Parameters

project
Guid

Project ID

id
Int32

The work item id

fields
IEnumerable<String>

Comma-separated list of requested fields

asOf
Nullable<DateTime>

AsOf UTC date time string

expand
Nullable<WorkItemExpand>

The expand parameters for work item attributes. Possible options are { None, Relations, Fields, Links, All }.

userState
Object
cancellationToken
CancellationToken

The cancellation token to cancel operation.

Returns

Applies to

GetWorkItemAsync(String, Int32, IEnumerable<String>, Nullable<DateTime>, Nullable<WorkItemExpand>, Object, CancellationToken)

[Preview API] Returns a single work item.

public virtual System.Threading.Tasks.Task<Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItem> GetWorkItemAsync (string project, int id, System.Collections.Generic.IEnumerable<string> fields = null, Nullable<DateTime> asOf = null, Nullable<Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemExpand> expand = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);
abstract member GetWorkItemAsync : string * int * seq<string> * Nullable<DateTime> * Nullable<Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemExpand> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItem>
override this.GetWorkItemAsync : string * int * seq<string> * Nullable<DateTime> * Nullable<Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemExpand> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItem>

Parameters

project
String

Project ID or project name

id
Int32

The work item id

fields
IEnumerable<String>

Comma-separated list of requested fields

asOf
Nullable<DateTime>

AsOf UTC date time string

expand
Nullable<WorkItemExpand>

The expand parameters for work item attributes. Possible options are { None, Relations, Fields, Links, All }.

userState
Object
cancellationToken
CancellationToken

The cancellation token to cancel operation.

Returns

Applies to