Skip to content

Latest commit

 

History

History
486 lines (424 loc) · 22.9 KB

query-index-quick-ref.md

File metadata and controls

486 lines (424 loc) · 22.9 KB
title titleSuffix description ms.custom ms.service ms.topic ms.author author monikerRange ms.date
Use an index to query examples, tasks, operators, and macros
Azure Boards
Learn how to use an index to query operators, macros, and sample queries that are used to list work items for Azure Boards and Azure DevOps.
boards-queriess, engagement-fy23
azure-devops-boards
overview
chcomley
chcomley
<= azure-devops
10/05/2022

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

[!INCLUDE version-lt-eq-azure-devops]

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...

:::row::: :::column span="1"::: Keywords, wildcard queries
- Keyword or phrase query with wildcards - Undefined field value queries - Empty or not empty HTML field queries - Category based queries
- Items you're following
- Recent activity work items

  **Tag based queries**  
  ::: moniker range="azure-devops"
  - [Items containing a specific tag](add-tags-to-work-items.md#query)
  - [Items that don't contain a specific tag](add-tags-to-work-items.md#query)
  - [Items that contain two or more tags](add-tags-to-work-items.md#query)  
  - [Items that have no tag assignments](add-tags-to-work-items.md#no-tags)
  - [Chart work items and group by tags](add-tags-to-work-items.md#group-by-tags)
  ::: moniker-end   
  ::: moniker range="< azure-devops"
  - [Items containing a specific tag](add-tags-to-work-items.md#query)
  - [Items that don't contain a specific tag](add-tags-to-work-items.md#query)
  - [Items that contain two or more tags](add-tags-to-work-items.md#query)  
  - [Items that have no tag assignments](add-tags-to-work-items.md#no-tags)
  - [Chart work items and group by tags](add-tags-to-work-items.md#group-by-tags)
  ::: moniker-end   

  **State, reason, or workflow change queries**    
  - [Resolved user stories](query-by-workflow-changes.md#workflow-change)
  - [Items I resolved in the last week](query-by-workflow-changes.md#workflow-change)
  - [Items failing acceptance tests](query-by-workflow-changes.md#workflow-change)
  - [Items closed within the last 15 days](query-by-workflow-changes.md#workflow-change)
  - [Items removed as they're duplicate](query-by-workflow-changes.md)
  - [Items closed and then reactivated](query-by-workflow-changes.md#reactivated)
  - [Stories in the Code/Doing column](query-by-workflow-changes.md#kanban_query_fields)
  - [Items in the Expedite swimlane](query-by-workflow-changes.md#kanban_query_fields)
  - [Items in a swimlane containing "Test"](query-by-workflow-changes.md#kanban_query_fields)  

  **Date and iteration-based queries**   
  - [Items created in the last 30 days](query-by-date-or-current-iteration.md)
  - [Items modified on a specific date](query-by-date-or-current-iteration.md)
  - [Items resolved today](query-by-date-or-current-iteration.md)
  - [Items closed within a specific time period](query-by-date-or-current-iteration.md)
  - [Items whose updated status](query-by-date-or-current-iteration.md)
  - [Items closed in the current sprint](query-by-date-or-current-iteration.md)

  **Link and attachment count queries**   
  - [All child items of a single epic](linking-attachments.md)
  - [All related items](linking-attachments.md)
  - [Items with one or more attachments](linking-attachments.md)
  - [Items with 2 or more hyperlinks](linking-attachments.md)
  - [Items containing external links](linking-attachments.md)  
   :::column-end:::

:::column span="1":::

  **Identity-based queries**  
  - [Active items assigned to me](query-by-workflow-changes.md#me)
  - [Closed items that were assigned to me](query-by-workflow-changes.md#me)
  - [Active items assigned to my team](query-by-workflow-changes.md#me)
  - [Items I've modified in the last 30 days](query-by-workflow-changes.md#me)
  - [Items I closed](query-by-workflow-changes.md#workflow-change-who)
  - [Items I resolved in the last week](query-by-workflow-changes.md#workflow-change-who) 
  - [Team or group membership queries](query-by-workflow-changes.md#group) 
  - [My recent activity work items](titles-ids-descriptions.md#recent-macros)   

 **Work item count and numeric field queries**   
  - [Count of active bugs per developer](query-numeric.md#counts)
  - [Count of bugs by area and states](query-numeric.md#counts)
  - [Sum of story points and their status](query-numeric.md#effort)
  - [Burnup chart of user stories for a sprint](query-numeric.md#effort)
  - [Sum of remaining work per developer](query-numeric.md#work)  

  **History, Discussion, and revision-change queries**  
  - [History contains a specific word](history-and-auditing.md)
  - [History doesn't contain a specific word](history-and-auditing.md)
  - [Reactivated items](history-and-auditing.md)
  - [Items closed within a time period](history-and-auditing.md)
  - [Items you've been associated with](history-and-auditing.md)  

  **Team focus queries**
  ::: moniker range=">= azure-devops-2019"
  - [Assigned to a member of a team](query-by-workflow-changes.md#group)  
  - [Assigned to a team's area path](query-by-area-iteration-path.md#team-area-path)  
  - [Assigned to a team's current sprint](query-by-date-or-current-iteration.md#current-iteration)  
  - [Assigned to a team's sprint window](query-by-date-or-current-iteration.md#current-iteration-plus-minus-n)  
  ::: moniker-end
  ::: moniker range="tfs-2018"
  - [Assigned to a member of a team](query-by-workflow-changes.md#group)
  - [Assigned to a team's current sprint](query-by-date-or-current-iteration.md#current-iteration)  |
  ::: moniker-end

  **Build and test field queries**  
  - [List bugs and linked test cases](build-test-integration.md#linked-bugs)
  - [List automated test cases](build-test-integration.md)
  - [List requirement-based test suites](build-test-integration.md)
  - [List query-based test suites](build-test-integration.md) 
  
  **Other**  
  - [List deleted work items (Recycle bin)](../backlogs/remove-delete-work-items.md#restore-or-destroy-work-items)
  - [Query by field value comparisons](query-field-value.md)

:::column-end::: :::row-end:::

Query tasks

:::row::: :::column span="1"::: - Add a query - Add a query chart - Add a query chart to a dashboard - Add a query tile to a dashboard - Add query results to a dashboard - Add a query folder - Add columns to query results - Bulk modify query items - Bulk update existing work items (csv) - Copy query URL - Define a clause - Delete a query or query folder - Direct-links query :::column-end::: :::column span="1"::: - Edit a query - Email a query - Export a query to Excel - Export a query (csv) - Favorite a query - Favorite a query as a team favorite - Filter a query - Flat-list query - Group a clause - Group a chart by tags - Import new work items (csv) - Open a query - Query across projects - Query based on tags :::column-end::: :::column span="1"::: ::: moniker range="azure-devops" - Rename a query or query folder - Run a query - Save a query - Set query permissions - Tree query - View a query - View query results with Parent field - Understand link types - Ungroup a clause - Work Item Query Language (WIQL) ::: moniker-end ::: moniker range="< azure-devops" - Rename a query or query folder - Run a query - Save a query - Save a query as a team favorite
- Set query permissions - Tree query - View a query - Understand link types - Ungroup a clause - Work Item Query Language (WIQL) ::: moniker-end :::column-end::: :::row-end:::

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.

[!INCLUDE temp]

:::row::: :::column span="1"::: Data type :::column-end::: :::column span="3"::: Description :::column-end::: :::column span="3"::: Supported operators and macros :::column-end::: :::row-end::: :::row::: :::column span="1"::: Boolean :::column-end::: :::column span="3"::: Supports a True/False value. Query samples: Query by assignment or workflow changes. :::column-end::: :::column span="3"::: = , <> , =[Field] , <>[Field] :::column-end::: :::row-end::: :::row::: :::column span="1"::: DateTime :::column-end::: :::column span="3"::: 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. :::column-end::: :::column span="3"::: = , <> , > , < , >= , <= , =[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 :::column-end::: :::row-end::: :::row::: :::column span="1"::: Double :::column-end::: :::column span="3"::: Also referred to as Decimal and includes picklistDouble1. A real number, such as 0.2 or 3.5.

Query examples: Query by numeric fields.

:::column-end::: :::column span="3"::: = , <> , > , < , >= , <= , =[Field], <>[Field], >[Field], <[Field], >=[Field], <=[Field], In, Not In, Was Ever :::column-end::: :::row-end::: :::row::: :::column span="1"::: GUID :::column-end::: :::column span="3"::: A character string that represents a unique ID. :::column-end::: :::column span="3"::: = , <> , > , < , >= , <= , =[Field], <>[Field], >[Field], <[Field], >=[Field], <=[Field], In, Not In, Was Ever :::column-end::: :::row-end::: :::row::: :::column span="1"::: History :::column-end::: :::column span="3"::: Custom formatted field used to track historical information and only assigned to the History field.

Query examples: History and auditing.

:::column-end::: :::column span="3"::: Contains Words, Does Not Contain Words :::column-end::: :::row-end::: :::row::: :::column span="1"::: HTML :::column-end::: :::column span="3"::: 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. :::column-end::: :::column span="3"::: Contains Words, Does Not Contain Words, Is Empty2, Is Not Empty2 :::column-end::: :::row-end::: :::row::: :::column span="1"::: Identity :::column-end::: :::column span="3"::: A String field that is used to hold a user identity. Query samples: Query by assignment or workflow changes. :::column-end::: :::column span="3"::: = , <> , > , < , >= , <= , =[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. :::column-end::: :::row-end::: :::row::: :::column span="1"::: Integer :::column-end::: :::column span="3"::: Also includes picklistInteger1. A 32-bit integer that is signed, such as 0, 1, 2, 34.

Query samples: Query by numeric fields :::column-end::: :::column span="3"::: = , <> , > , < , >= , <= , =[Field], <>[Field], >[Field], <[Field], >=[Field], <=[Field], In, Not In, Was Ever

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

:::column-end::: :::row-end::: :::row::: :::column span="1"::: PlainText :::column-end::: :::column span="3"::: 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.

:::column-end::: :::column span="3"::: Contains Words, Does Not Contain Words, Is Empty, Is Not Empty :::column-end::: :::row-end::: :::row::: :::column span="1"::: String :::column-end::: :::column span="3"::: 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. :::column-end::: :::column span="3"::: = , <> , > , < , >= , <= , =[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. :::column-end::: :::row-end::: :::row::: :::column span="1"::: TreePath :::column-end::: :::column span="3"::: 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.

:::column-end::: :::column span="3"::: Under, Not Under, =, <>, In, Not In

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

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.

[!INCLUDE date-time-pattern]

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.

:::row::: :::column span="1":::

A

B

C

:::column-end::: :::column span="1":::

D-E-F

H-P

R

S

T

V-W

Related articles