QueryHierarchyItem interface
Represents an item in the work item query hierarchy. This can be either a query or a folder.
- Extends
Properties
| children | The child query items inside a query folder. |
| clauses | The clauses for a flat query. |
| columns | The columns of the query. |
| created |
The identity who created the query item. |
| created |
When the query item was created. |
| filter |
The link query mode. |
| has |
If this is a query folder, indicates if it contains any children. |
| id | The id of the query item. |
| is |
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. |
| is |
Indicates if this is a query folder or a query. |
| is |
Indicates if the WIQL of this query is invalid. This could be due to invalid syntax or a no longer valid area/iteration path. |
| is |
Indicates if this query item is public or private. |
| last |
The identity who last ran the query. |
| last |
When the query was last run. |
| last |
The identity who last modified the query item. |
| last |
When the query item was last modified. |
| link |
The link query clause. |
| name | The name of the query item. |
| path | The path of the query item. |
| query |
The recursion option for use in a tree query. |
| query |
The type of query. |
| sort |
The sort columns of the query. |
| source |
The source clauses in a tree or one-hop link query. |
| target |
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
clauses
columns
createdBy
The identity who created the query item.
createdBy: IdentityReferenceProperty Value
createdDate
When the query item was created.
createdDate: DateProperty Value
Date
filterOptions
hasChildren
If this is a query folder, indicates if it contains any children.
hasChildren: booleanProperty Value
boolean
id
The id of the query item.
id: stringProperty 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: booleanProperty Value
boolean
isFolder
Indicates if this is a query folder or a query.
isFolder: booleanProperty 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: booleanProperty Value
boolean
isPublic
Indicates if this query item is public or private.
isPublic: booleanProperty Value
boolean
lastExecutedBy
The identity who last ran the query.
lastExecutedBy: IdentityReferenceProperty Value
lastExecutedDate
When the query was last run.
lastExecutedDate: DateProperty Value
Date
lastModifiedBy
The identity who last modified the query item.
lastModifiedBy: IdentityReferenceProperty Value
lastModifiedDate
When the query item was last modified.
lastModifiedDate: DateProperty Value
Date
linkClauses
name
The name of the query item.
name: stringProperty Value
string
path
The path of the query item.
path: stringProperty Value
string
queryRecursionOption
The recursion option for use in a tree query.
queryRecursionOption: QueryRecursionOptionProperty Value
queryType
sortColumns
The sort columns of the query.
sortColumns: WorkItemQuerySortColumn[]Property Value
sourceClauses
The source clauses in a tree or one-hop link query.
sourceClauses: WorkItemQueryClauseProperty Value
targetClauses
The target clauses in a tree or one-hop link query.
targetClauses: WorkItemQueryClauseProperty Value
wiql
The WIQL text of the query
wiql: stringProperty Value
string
Inherited Property Details
url
REST URL for the resource.
url: stringProperty Value
string
Inherited From WorkItemTrackingResource.url