WorkItemBatchGetRequest interface

Describes a request to get a set of work items

Properties

$expand

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

asOf

AsOf UTC date time string

errorPolicy

The flag to control error policy in a bulk get work items request. Possible options are {Fail, Omit}.

fields

The requested fields

ids

The requested work item ids

Property Details

$expand

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

$expand: WorkItemExpand

Property Value

asOf

AsOf UTC date time string

asOf: Date

Property Value

Date

errorPolicy

The flag to control error policy in a bulk get work items request. Possible options are {Fail, Omit}.

errorPolicy: WorkItemErrorPolicy

Property Value

fields

The requested fields

fields: string[]

Property Value

string[]

ids

The requested work item ids

ids: number[]

Property Value

number[]