Edit

Share via


PredefinedQuery interface

Represents a single pre-defined query.

Properties

hasMore

Whether or not the query returned the complete set of data or if the data was truncated.

id

Id of the query

name

Localized name of the query

results

The results of the query. This will be a set of WorkItem objects with only the 'id' set. The client is responsible for paging in the data as needed.

url

REST API Url to use to retrieve results for this query

webUrl

Url to use to display a page in the browser with the results of this query

Property Details

hasMore

Whether or not the query returned the complete set of data or if the data was truncated.

hasMore: boolean

Property Value

boolean

id

Id of the query

id: string

Property Value

string

name

Localized name of the query

name: string

Property Value

string

results

The results of the query. This will be a set of WorkItem objects with only the 'id' set. The client is responsible for paging in the data as needed.

results: WorkItem[]

Property Value

url

REST API Url to use to retrieve results for this query

url: string

Property Value

string

webUrl

Url to use to display a page in the browser with the results of this query

webUrl: string

Property Value

string