Endpoint Get List of Projects
Name
get_projects
Description
Gets a list of projects within the organization. [API reference]
Related Tables
Parameters
| Parameter | Required | Options | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| There are no parameters | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Output Columns
| Label | Data Type (SSIS) | Data Type (SQL) | Length | Description |
|---|---|---|---|---|
| Id |
DT_WSTR
|
nvarchar(500)
|
500 | |
| Name |
DT_WSTR
|
nvarchar(500)
|
500 | |
| Description |
DT_WSTR
|
nvarchar(1160)
|
1160 | |
| Url |
DT_WSTR
|
nvarchar(1000)
|
1000 | |
| State |
DT_WSTR
|
nvarchar(100)
|
100 | |
| Revision |
DT_I4
|
int
|
||
| Visibility |
DT_WSTR
|
nvarchar(100)
|
100 | |
| LastUpdateTime |
DT_DBTIMESTAMP
|
datetime
|
Input Columns
| Label | Data Type (SSIS) | Data Type (SQL) | Length | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| There are no Static columns defined for this endpoint. This endpoint detects columns dynamically at runtime. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Examples
SSIS
Use Azure DevOps Connector in API Source or in API Destination SSIS Data Flow components to read or write data.
API Source
This Endpoint belongs to the Projects table, therefore it is better to use it, instead of accessing the endpoint directly:
| There are no parameters to configure. |
API Destination
This Endpoint belongs to the Projects table, therefore it is better to use it, instead of accessing the endpoint directly. Use this table and table-operation pair to get list of projects:
| There are no parameters to configure. |
ODBC application
Use these SQL queries in your ODBC application data source:
List projects
<p>Returns all projects in the organization. Use this to discover project names and IDs for use in other queries or in the connection default project. Columns include Id, Name, Description, Url, State, Revision, Visibility, and LastUpdateTime.</p>
SELECT * FROM Projects
List projects (specific columns)
<p>Returns projects in the organization with only the columns you select (e.g. Id, Name, Description, Url, State, Revision, Visibility, LastUpdateTime). Use this to reduce payload size or to build a dropdown or report that needs a subset of project fields.</p>
SELECT Id, Name, Description, Url, State, Revision, Visibility, LastUpdateTime FROM Projects
get_projects endpoint belongs to
Projects
table(s), and can therefore be used via those table(s).
SQL Server
Use these SQL queries in SQL Server after you create a data source in Data Gateway:
List projects
<p>Returns all projects in the organization. Use this to discover project names and IDs for use in other queries or in the connection default project. Columns include Id, Name, Description, Url, State, Revision, Visibility, and LastUpdateTime.</p>
DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM Projects';
EXEC (@MyQuery) AT [LS_TO_AZURE_DEVOPS_IN_GATEWAY];
List projects (specific columns)
<p>Returns projects in the organization with only the columns you select (e.g. Id, Name, Description, Url, State, Revision, Visibility, LastUpdateTime). Use this to reduce payload size or to build a dropdown or report that needs a subset of project fields.</p>
DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT Id, Name, Description, Url, State, Revision, Visibility, LastUpdateTime FROM Projects';
EXEC (@MyQuery) AT [LS_TO_AZURE_DEVOPS_IN_GATEWAY];
get_projects endpoint belongs to
Projects
table(s), and can therefore be used via those table(s).