Interface QueryHierarchyItem

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

interface QueryHierarchyItem {
    _links?: any;
    children?: QueryHierarchyItem[];
    clauses?: WorkItemQueryClause;
    columns?: WorkItemFieldReference[];
    createdBy?: IdentityReference;
    createdDate?: Date;
    filterOptions?: LinkQueryMode;
    hasChildren?: boolean;
    id?: string;
    isDeleted?: boolean;
    isFolder?: boolean;
    isInvalidSyntax?: boolean;
    isPublic?: boolean;
    lastExecutedBy?: IdentityReference;
    lastExecutedDate?: Date;
    lastModifiedBy?: IdentityReference;
    lastModifiedDate?: Date;
    linkClauses?: WorkItemQueryClause;
    name?: string;
    path?: string;
    queryRecursionOption?: QueryRecursionOption;
    queryType?: QueryType;
    sortColumns?: WorkItemQuerySortColumn[];
    sourceClauses?: WorkItemQueryClause;
    targetClauses?: WorkItemQueryClause;
    url?: string;
    wiql?: string;
}

Hierarchy (View Summary)

Properties

_links? children? clauses? columns? createdBy? createdDate? filterOptions? hasChildren? id? isDeleted? isFolder? isInvalidSyntax? isPublic? lastExecutedBy? lastExecutedDate? lastModifiedBy? lastModifiedDate? linkClauses? name? path? queryRecursionOption? queryType? sortColumns? sourceClauses? targetClauses? url? wiql?

Properties

Optional_links

_links?: any

Link references to related REST resources.

Optionalchildren

children?: QueryHierarchyItem[]

The child query items inside a query folder.

Optionalclauses

clauses?: WorkItemQueryClause

The clauses for a flat query.

Optionalcolumns

columns?: WorkItemFieldReference[]

The columns of the query.

OptionalcreatedBy

createdBy?: IdentityReference

The identity who created the query item.

OptionalcreatedDate

createdDate?: Date

When the query item was created.

OptionalfilterOptions

filterOptions?: LinkQueryMode

The link query mode.

OptionalhasChildren

hasChildren?: boolean

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

Optionalid

id?: string

The id of the query item.

OptionalisDeleted

isDeleted?: boolean

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.

OptionalisFolder

isFolder?: boolean

Indicates if this is a query folder or a query.

OptionalisInvalidSyntax

isInvalidSyntax?: boolean

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

OptionalisPublic

isPublic?: boolean

Indicates if this query item is public or private.

OptionallastExecutedBy

lastExecutedBy?: IdentityReference

The identity who last ran the query.

OptionallastExecutedDate

lastExecutedDate?: Date

When the query was last run.

OptionallastModifiedBy

lastModifiedBy?: IdentityReference

The identity who last modified the query item.

OptionallastModifiedDate

lastModifiedDate?: Date

When the query item was last modified.

OptionallinkClauses

linkClauses?: WorkItemQueryClause

The link query clause.

Optionalname

name?: string

The name of the query item.

Optionalpath

path?: string

The path of the query item.

OptionalqueryRecursionOption

queryRecursionOption?: QueryRecursionOption

The recursion option for use in a tree query.

OptionalqueryType

queryType?: QueryType

The type of query.

OptionalsortColumns

sortColumns?: WorkItemQuerySortColumn[]

The sort columns of the query.

OptionalsourceClauses

sourceClauses?: WorkItemQueryClause

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

OptionaltargetClauses

targetClauses?: WorkItemQueryClause

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

Optionalurl

url?: string

REST URL for the resource.

Optionalwiql

wiql?: string

The WIQL text of the query

Settings

Member Visibility

On This Page

Properties