Edit

Share via


WorkItemTrackingHttpClientBase.GetWorkItemTemplateAsync Method

Definition

Overloads

GetWorkItemTemplateAsync(Guid, String, String, Nullable<DateTime>, Nullable<WorkItemExpand>, Object, CancellationToken)

[Preview API] Returns a single work item from a template.

public virtual System.Threading.Tasks.Task<Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItem> GetWorkItemTemplateAsync(Guid project, string type, 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 GetWorkItemTemplateAsync : Guid * string * 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.GetWorkItemTemplateAsync : Guid * string * 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

type
String

The work item type name

fields
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

GetWorkItemTemplateAsync(String, String, String, Nullable<DateTime>, Nullable<WorkItemExpand>, Object, CancellationToken)

[Preview API] Returns a single work item from a template.

public virtual System.Threading.Tasks.Task<Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItem> GetWorkItemTemplateAsync(string project, string type, 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 GetWorkItemTemplateAsync : string * string * 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.GetWorkItemTemplateAsync : string * string * 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

type
String

The work item type name

fields
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