QueryHierarchyItem interface

  • Reference
Package:
azure-devops-extension-api

Represents an item in the work item query hierarchy. This can be either a query or a folder.

Extends
WorkItemTrackingResource

Properties

children

The child query items inside a query folder.
clauses

The clauses for a flat query.
columns

The columns of the query.
createdBy

The identity who created the query item.
createdDate

When the query item was created.
filterOptions

The link query mode.
hasChildren

If this is a query folder, indicates if it contains any children.
id

The id of the query item.
isDeleted

Indicates if this query item is deleted. Setting this to false on a deleted query item will undelete it. Undeleting a query or folder will not bring back the permission changes that were previously applied to it.
isFolder

Indicates if this is a query folder or a query.
isInvalidSyntax

Indicates if the WIQL of this query is invalid. This could be due to invalid syntax or a no longer valid area/iteration path.
isPublic

Indicates if this query item is public or private.
lastExecutedBy

The identity who last ran the query.
lastExecutedDate

When the query was last run.
lastModifiedBy

The identity who last modified the query item.
lastModifiedDate

When the query item was last modified.
linkClauses

The link query clause.
name

The name of the query item.
path

The path of the query item.
queryRecursionOption

The recursion option for use in a tree query.
queryType

The type of query.
sortColumns

The sort columns of the query.
sourceClauses

The source clauses in a tree or one-hop link query.
targetClauses

The target clauses in a tree or one-hop link query.
wiql

The WIQL text of the query

Inherited Properties

url

REST URL for the resource.

Property Details

children

The child query items inside a query folder.

children: QueryHierarchyItem[]

Property Value

QueryHierarchyItem[]

clauses

The clauses for a flat query.

clauses: WorkItemQueryClause

Property Value

WorkItemQueryClause

columns

The columns of the query.

columns: WorkItemFieldReference[]

Property Value

WorkItemFieldReference[]

createdBy

The identity who created the query item.

createdBy: IdentityReference

Property Value

IdentityReference

createdDate

When the query item was created.

createdDate: Date

Property Value

Date

filterOptions

The link query mode.

filterOptions: LinkQueryMode

Property Value

LinkQueryMode

hasChildren

If this is a query folder, indicates if it contains any children.

hasChildren: boolean

Property Value

boolean

id

The id of the query item.

id: string

Property Value

string

isDeleted

Indicates if this query item is deleted. Setting this to false on a deleted query item will undelete it. Undeleting a query or folder will not bring back the permission changes that were previously applied to it.

isDeleted: boolean

Property Value

boolean

isFolder

Indicates if this is a query folder or a query.

isFolder: boolean

Property Value

boolean

isInvalidSyntax

Indicates if the WIQL of this query is invalid. This could be due to invalid syntax or a no longer valid area/iteration path.

isInvalidSyntax: boolean

Property Value

boolean

isPublic

Indicates if this query item is public or private.

isPublic: boolean

Property Value

boolean

lastExecutedBy

The identity who last ran the query.

lastExecutedBy: IdentityReference

Property Value

IdentityReference

lastExecutedDate

When the query was last run.

lastExecutedDate: Date

Property Value

Date

lastModifiedBy

The identity who last modified the query item.

lastModifiedBy: IdentityReference

Property Value

IdentityReference

lastModifiedDate

When the query item was last modified.

lastModifiedDate: Date

Property Value

Date

linkClauses

The link query clause.

linkClauses: WorkItemQueryClause

Property Value

WorkItemQueryClause

name

The name of the query item.

name: string

Property Value

string

path

The path of the query item.

path: string

Property Value

string

queryRecursionOption

The recursion option for use in a tree query.

queryRecursionOption: QueryRecursionOption

Property Value

QueryRecursionOption

queryType

The type of query.

queryType: QueryType

Property Value

QueryType

sortColumns

The sort columns of the query.

sortColumns: WorkItemQuerySortColumn[]

Property Value

WorkItemQuerySortColumn[]

sourceClauses

The source clauses in a tree or one-hop link query.

sourceClauses: WorkItemQueryClause

Property Value

WorkItemQueryClause

targetClauses

The target clauses in a tree or one-hop link query.

targetClauses: WorkItemQueryClause

Property Value

WorkItemQueryClause

wiql

The WIQL text of the query

wiql: string

Property Value

string

Inherited Property Details

url

REST URL for the resource.

url: string

Property Value

string

Inherited From WorkItemTrackingResource.url