Interface LibraryWorkItemsDataProviderRequest

This is the request data contract for LibraryTestCaseDataProvider.

interface LibraryWorkItemsDataProviderRequest {
    columnOptions?: string[];
    continuationToken?: string;
    filterValues?: TestPlansLibraryWorkItemFilter[];
    isAscending?: boolean;
    libraryQueryType?: TestPlansLibraryQuery;
    orderByField?: string;
    workItemIds?: number[];
}

Properties

columnOptions? continuationToken? filterValues? isAscending? libraryQueryType? orderByField? workItemIds?

Properties

OptionalcolumnOptions

columnOptions?: string[]

Specifies the list of column options to show in test cases table.

OptionalcontinuationToken

continuationToken?: string

The continuation token required for paging of work items. This is required when getting subsequent sets of work items when OrderByField is Id.

OptionalfilterValues

filterValues?: TestPlansLibraryWorkItemFilter[]

List of filter values to be supplied. Currently supported filters are Title, State, AssignedTo, Priority, AreaPath.

OptionalisAscending

isAscending?: boolean

Whether the data is to be sorted in ascending or descending order. When not supplied, defaults to descending.

OptionallibraryQueryType

libraryQueryType?: TestPlansLibraryQuery

The type of query to run.

OptionalorderByField

orderByField?: string

Work item field on which to order the results. When not supplied, defaults to work item IDs.

OptionalworkItemIds

workItemIds?: number[]

List of work items to query for field details. This is required when getting subsequent sets of work item fields when OrderByField is other than Id.

Settings

Member Visibility

On This Page

Properties