Use an index to query quick reference data in Azure Boards and Azure DevOps

Azure DevOps Services | Azure DevOps Server 2022 - Azure DevOps Server 2019

Use this index to quickly access example queries and information on opening, defining, and working with queries. To learn how to use the Query Editor, see Define a query. If you find that your queries take too long to return results, see Define a query/Best practices.

Example queries

You can list work items based on the following criteria...



Query tasks



Operators and macros supported for each data type

The following table indicates the operators and macros available for the different field data types. Each field is associated with a data type. You can find the data type listed in the descriptions of each field, which you can look up using the Work item field index. Operators available for defining a query clause depend on the data type of the field that you select. For more detailed descriptions of data types, operators, and macros, see Query fields, operators, and macros.

Note

The following macros are only supported from the web portal: @CurrentIteration, @CurrentIteration +/- n, @Follows, @MyRecentActivity, @RecentMentions, @RecentProjectActivity, and @TeamAreas. Queries that contain these macros won't work when opened in Visual Studio/Team Explorer, Microsoft Excel, or Microsoft Project.

Data type

Description

Supported operators and macros

Boolean

Supports a True/False value. Query samples: Query by assignment or workflow changes.

= , <> , =[Field] , <>[Field]

DateTime

A date field in which you can specify a variable, such as @Today or @Today-1, or a value, such as 1/1/2012. Enter dates in the Date Pattern you set for your personal profile. See Set personal preferences for details.

For query examples, see Query by date or@CurrentIteration.

= , <> , > , < , >= , <= , =[Field], <>[Field], >[Field], <[Field], >=[Field], <=[Field], In, Not In, Was Ever
Macros: @Today, valid with any DateTime field

Additional macros supported on Azure DevOps 2019 Update 1 and later versions::
@StartOfDay, @StartOfWeek, @StartOfMonth, and @StartOfYear, valid with any DateTime field

Double

Also referred to as Decimal and includes picklistDouble1. A real number, such as 0.2 or 3.5.

Query examples: Query by numeric fields.

= , <> , > , < , >= , <= , =[Field], <>[Field], >[Field], <[Field], >=[Field], <=[Field], In, Not In, Was Ever

GUID

A character string that represents a unique ID.

= , <> , > , < , >= , <= , =[Field], <>[Field], >[Field], <[Field], >=[Field], <=[Field], In, Not In, Was Ever

History

Custom formatted field used to track historical information and only assigned to the History field.

Query examples: History and auditing.

Contains Words, Does Not Contain Words

HTML

Text strings that support formatted descriptions, such as the Description or Repro Steps fields. These fields are automatically indexed for full-text search when full-text search is available. Query samples: Query by titles, IDs, and rich-text fields.

Contains Words, Does Not Contain Words, Is Empty2, Is Not Empty2

Identity

A String field that is used to hold a user identity. Query samples: Query by assignment or workflow changes.

= , <> , > , < , >= , <= , =[Field], <>[Field], >[Field], <[Field], >=[Field], <=[Field], Contains, Does Not Contain, In, Not In, In Group, Not In Group, Was Ever Macros: @me valid for all Identity fields.

Integer

Also includes picklistInteger1. A 32-bit integer that is signed, such as 0, 1, 2, 34.

Query samples: Query by numeric fields

= , <> , > , < , >= , <= , =[Field], <>[Field], >[Field], <[Field], >=[Field], <=[Field], In, Not In, Was Ever

Macros: @Follows, @MyRecentActivity, @RecentMentions, and @RecentProjectActivity, valid when used with the ID field.

PlainText

Multi-line text strings that support long descriptions and are automatically indexed for full-text search, when full-text search is available.
Query examples: Query by titles, IDs, and rich-text fields.

Contains Words, Does Not Contain Words, Is Empty, Is Not Empty

String

Also includes picklistString1. Short single-line text that can contain up to 255 Unicode characters. String fields support the Title field, picklists (drop-down menus), user accounts, Tags, and other fields.

Query examples: Query by titles, IDs, and rich-text fields and Query by picklist value.

= , <> , > , < , >= , <= , =[Field], <>[Field], >[Field], <[Field], >=[Field], <=[Field], Contains, Does Not Contain, In, Not In, In Group, Not In Group, Was Ever

Macros: [Any], valid with the Work Item Type field @Project, valid with the Team Project field.

TreePath

Field type that supports the Area Path and Iteration Path fields. You define the tree structure for a project—area paths and iteration paths.

Query examples: Query by area or iteration path and Query by date or current iteration.

Under, Not Under, =, <>, In, Not In

Macros: @TeamAreas3, valid with Area Path field
@CurrentIteration and @CurrentIteration+/- n4 valid with the Iteration Path field

Note

  1. The picklist... data types are only assigned to custom fields defined for an inherited process. The Inherited process model is only supported for Azure DevOps Server 2019 and later versions.
  2. The Is Empty and Is Not Empty operators are supported for Azure DevOps Server 2019 RC2 and later versions.
  3. The @TeamAreas macro is supported for Azure Boards and Azure DevOps Server 2019 and later versions.
  4. The @CurrentIteration +/- n macro is supported for Azure DevOps Server 2019 and later versions, and only when run from the web portal.

Date and time pattern

The date and time pattern you enter for DateTime fields should match that which you select through your profile. To view or change your selection, see Set user preferences for Time and Locale.

Screenshot that shows the Date Pattern dropdown options on the Time and Locale pane. Screenshot that shows the Time Pattern dropdown options on the Time and Locale pane.

Screenshot that shows the Time and Locale pane with Date pattern and Time pattern fields.

Example queries for select fields

The following table lists common query fields and their data type for which sample queries are provided. To determine the data type of a field, see Work item fields and attributes, List field attributes.

A

B

C

D-E-F

H-P

R

S

T

V-W