SQL Server guide

Get work items by predefined query ID


Returns work items from a saved shared or private query. Supply the query ID (from the result of the "List predefined queries" example or from the Azure DevOps query URL). Optionally specify a project and team; the query runs in that context and returns the same columns you would see in the Boards query view. Useful when you already maintain useful queries in the UI and want to pull the same result set via SQL.

Standard SQL query example

This is the base query accepted by the connector. To execute it in SQL Server, you have to pass it to the Data Gateway via a Linked Server. See how to accomplish this using the examples below.

SELECT * FROM get_workitems_by_query_id
WITH(
	  Query='e5150e18-1323-485d-8937-6991bf09ab1c' --see get_queries endpoint
	, Project='Odbc'
)

Using OPENQUERY in SQL Server

SELECT * FROM OPENQUERY([LS_TO_AZURE_DEVOPS_IN_GATEWAY], 'SELECT * FROM get_workitems_by_query_id
WITH(
	  Query=''e5150e18-1323-485d-8937-6991bf09ab1c'' --see get_queries endpoint
	, Project=''Odbc''
)')

Using EXEC in SQL Server (handling larger SQL text)

The major drawback of OPENQUERY is its inability to incorporate variables within SQL statements. This often leads to the use of cumbersome dynamic SQL (with numerous ticks and escape characters).

Fortunately, starting with SQL 2005 and onwards, you can utilize the EXEC (your_sql) AT [LS_TO_AZURE_DEVOPS_IN_GATEWAY] syntax.

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM get_workitems_by_query_id
WITH(
	  Query=''e5150e18-1323-485d-8937-6991bf09ab1c'' --see get_queries endpoint
	, Project=''Odbc''
)'
EXEC (@MyQuery) AT [LS_TO_AZURE_DEVOPS_IN_GATEWAY]