LibraryWorkItemsDataProviderRequest interface

Package:

azure-devops-extension-api

This is the request data contract for LibraryTestCaseDataProvider.

Properties

columnOptions	Specifies the list of column options to show in test cases table.
continuationToken	The continuation token required for paging of work items. This is required when getting subsequent sets of work items when OrderByField is Id.
filterValues	List of filter values to be supplied. Currently supported filters are Title, State, AssignedTo, Priority, AreaPath.
isAscending	Whether the data is to be sorted in ascending or descending order. When not supplied, defaults to descending.
libraryQueryType	The type of query to run.
orderByField	Work item field on which to order the results. When not supplied, defaults to work item IDs.
workItemIds	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.

Property Details

columnOptions

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

columnOptions: string[]

Property Value

string[]

continuationToken

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

continuationToken: string

Property Value

string

filterValues

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

filterValues: TestPlansLibraryWorkItemFilter[]

Property Value

TestPlansLibraryWorkItemFilter[]

isAscending

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

isAscending: boolean

Property Value

boolean

libraryQueryType

The type of query to run.

libraryQueryType: TestPlansLibraryQuery

Property Value

TestPlansLibraryQuery

orderByField

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

orderByField: string

Property Value

string

workItemIds

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.

workItemIds: number[]

Property Value

number[]