This data model is used in Work item-based tabs of Test Plans Library.

interface LibraryWorkItemsData {
    columnOptions?: string[];
    continuationToken?: string;
    exceededWorkItemQueryLimit: boolean;
    hasMoreElements: boolean;
    returnCode: LibraryTestCasesDataReturnCode;
    workItemIds?: number[];
    workItems: WorkItemDetails[];
}

Properties

columnOptions?: string[]

Specifies the column option field names

continuationToken?: string

Continuation token to fetch next set of elements. Present only when HasMoreElements is true.

exceededWorkItemQueryLimit: boolean

Boolean indicating if the WIQL query has exceeded the limit of items returned.

hasMoreElements: boolean

Boolean indicating if there are more elements present than what are being sent.

Specifies if there was an error while execution of data provider.

workItemIds?: number[]

List of work items returned when OrderByField is sent something other than Id.

workItems: WorkItemDetails[]

List of work items to be returned.