How to read Azure DevOps data in MS SQL/SSRS/Java using ZappySys Data Gateway?

In this section we will learn how to configure and use Azure DevOps Connector in the API Driver to extract data from the Azure DevOps.

Create Data Source in ZappySys Data Gateway based on API Driver

Download and install ZappySys ODBC PowerPack.
Search for gateway in start menu and Open ZappySys Data Gateway:
Go to Users Tab to add our first Gateway user. Click Add; we will give it a name tdsuser and enter password you like to give. Check Admin option and click OK to save. We will use these details later when we create linked server:
Now we are ready to add a data source. Click Add, give data source a name (Copy this name somewhere, we will need it later) and then select Native - ZappySys API Driver. Finally, click OK. And it will create the Data Set for it and open the ZS driver UI.

AzureDevOpsDSN
When the Configuration window appears give your data source a name if you haven't done that already, then select "Azure DevOps" from the list of Popular Connectors. If "Azure DevOps" is not present in the list, then click "Search Online" and download it. Then set the path to the location where you downloaded it. Finally, click Continue >> to proceed with configuring the DSN:

AzureDevOpsDSN

Azure DevOps

Now it's time to configure the Connection Manager. Select Authentication Type, e.g. Token Authentication. Then select API Base URL (in most cases, the default one is the right one). More info is available in the Authentication section.

OAuth [OAuth]

Steps to get Azure DevOps Credentials
Connecting to your Azure DevOps data requires you to authenticate your REST API access. Follow the instructions below:

Go to https://app.vsaex.visualstudio.com/app/register to register your app.
Fill in your application and company's information as required, and then select the scopes that your application needs. This should typically be Project and team (read and write) and Work items (read and write).

Your selected scopes when registering your app must match the scopes you enter here on the connector screen. If they don't match, the connector will not be able to work with your Azure DevOps account!

If you need further information about the scopes used in Azure DevOps, or need to see what to enter into the connector screen to match up with your selected scopes, visit https://learn.microsoft.com/en-us/azure/devops/integrate/get-started/authentication/oauth?view=azure-devops.
Select Create Application and then the Application Settings page will be displayed.
Record the application settings that are displayed for us to use later, especially the App ID and the Client Secret.
Visit https://aex.dev.azure.com. Once you are logged in, record your organization name in the URL that is displayed on the page. For example, if your organization is called "acmeinc", the URL on the page would be acmeinc.visualstudio.com.
Back at the connector screen, enter the App ID that was recorded in step 4 into the Client Id (App ID) field.
Enter the client secret that was recorded in step 4 into the Client Secret field. In order to edit the text in this field, select the ellipses (...) button that appears when the textbox is clicked and edit the client secret with the dialog box that appears.
Enter the organization that was recorded in step 5 into the Organization name or Id for url field.
Click Generate Token. If proper authentication occurs, you will see a notice saying so. You can click Yes to save a backup file of your generated tokens.
Select the project you want to connect to by default from the Default Project (Choose after Generating Token) field.
Select the Security tab.
Enter https://auditservice.dev.azure.com,https://almsearch.dev.azure.com into the Additional Trusted Domains field.
Select the Test Connection button at the bottom of the window to verify proper connectivity with your Azure DevOps account.
If the connection test succeeds, select OK.

Fill in all required parameters and set optional parameters if needed:

AzureDevOpsDSN

Azure DevOps

OAuth [OAuth]

https://dev.azure.com

Required Parameters
Client Id (App ID)	Fill in the parameter...
Client Secret	Fill in the parameter...
Organization name or Id for url (e.g. mycompany)	Fill in the parameter...
Return URL	Fill in the parameter...
Scope	Fill in the parameter...
API Version	Fill in the parameter...
Optional Parameters
Default Project Name (Choose after Generating Token)	Fill in the parameter...
RetryMode	Fill in the parameter...
RetryStatusCodeList	Fill in the parameter...
RetryCountMax	Fill in the parameter...
RetryMultiplyWaitTime	Fill in the parameter...

Personal Access Token (PAT) [Http]

Steps to get Azure DevOps Credentials
To connect to Azure DevOps using a Personal Access Token (PAT), you must first create a valid PAT:

Go to your Azure DevOps home page: https://dev.azure.com/{your organization name}.
On the home page, select the User Settings menu dropdown (looks like a person icon with a small gear over it), and then select Personal access tokens.
Select the New Token button.
Enter a name for the new personal access token.
Select the appropriate organization for the new personal access token.
Select the expiration date for the new personal access token.
Select the scopes for this token. (You may be restricted from creating full-scoped PATs. If so, your Azure DevOps administrator in Azure AD has enabled a policy which limits you to a specific custom defined set of scopes.)
Select the Create button.
The new Personal Access Token (PAT) is created and displayed. Copy and save this token, since it is as sensitive as a password.
Visit https://aex.dev.azure.com. Once you are logged in, record your organization name in the URL that is displayed on the page. For example, if your organization is called "acmeinc", the URL on the page would be acmeinc.visualstudio.com.
Back at the connector screen, enter the token you recorded from step 9 into the Personal Access Token (PAT) field.
Enter the organization that was recorded in step 10 into the Organization name or Id for url field.
Enter the name or Id of the project you want to connect to by default in the Default Project (Choose after above fields) field.
Select the Security tab.
Enter https://auditservice.dev.azure.com,https://almsearch.dev.azure.com,https://analytics.dev.azure.com into the Additional Trusted Domains field.
Select the Test Connection button at the bottom of the window to verify proper connectivity with your Azure DevOps account.
If the connection test succeeds, select OK.

Fill in all required parameters and set optional parameters if needed:

AzureDevOpsDSN

Azure DevOps

Personal Access Token (PAT) [Http]

https://dev.azure.com

Required Parameters
Personal Access Token (PAT)	Fill in the parameter...
Organization name or Id for url	Fill in the parameter...
API Version	Fill in the parameter...
Optional Parameters
AuthScheme	Fill in the parameter...
AuthHeader	Fill in the parameter...
UserName	Fill in the parameter...
Default Project Name (Choose after Generating Token)	Fill in the parameter...
RetryMode	Fill in the parameter...
RetryStatusCodeList	Fill in the parameter...
RetryCountMax	Fill in the parameter...
RetryMultiplyWaitTime	Fill in the parameter...

Once the data source has been configured, you can preview data. Select the Preview tab and use settings similar to the following to preview data:
Click OK to finish creating the data source.

Reading data from client application

Firstly, to get data from ODBC data source based on ZappySys ODBC driver, in your client application, you would need to connect to ODBC source and then from the list select the data source.
Finally, to read the data just read tables/views in your app or enter a SQL statement to extract data, e.g.:
SELECT * FROM WorkItems

Azure DevOps Connector Examples

The ZappySys API Driver is a user-friendly interface designed to facilitate the seamless integration of various applications with the Azure DevOps API. With its intuitive design and robust functionality, the ZappySys API Driver simplifies the process of configuring specific API endpoints to efficiently read or write data from Azure DevOps.

Click here to find more Azure DevOps Connector examples designed for seamless integration with the ZappySys API ODBC Driver under ODBC Data Source (36/64) or ZappySys Data Gateway, enhancing your ability to connect and interact with Prebuilt Connectors effectively.

Consume Data inside your App / Programming Language

Once you know how to load data from Azure DevOps Connector, you can click on one of the below links to learn the steps how to consume data inside your App / Programming Language from Azure DevOps Connector.

ODBC inside ETL / Reporting / BI Tools

ODBC inside Programming Languages

Key features of the ZappySys API Driver include:

The API ODBC driver facilitates the reading and writing of data from numerous popular online services (refer to the complete list here) using familiar SQL language without learning complexity of REST API calls. The driver allows querying nested structure and output as a flat table. You can also create your own ODBC / Data Gateway API connector file and use it with this driver.

Intuitive Configuration: The interface is designed to be user-friendly, enabling users to easily set up the specific API endpoints within Azure DevOps without requiring extensive technical expertise or programming knowledge.
Customizable Endpoint Setup: Users can conveniently configure the API endpoint settings, including the HTTP request method, endpoint URL, and any necessary parameters, to precisely target the desired data within Azure DevOps.
Data Manipulation Capabilities: The ZappySys API Driver allows for seamless data retrieval and writing, enabling users to fetch data from Azure DevOps and perform various data manipulation operations as needed, all through an intuitive and straightforward interface.
Secure Authentication Integration: The driver provides secure authentication integration, allowing users to securely connect to the Azure DevOps API by inputting the necessary authentication credentials, such as API tokens or other authentication keys.
Error Handling Support: The interface is equipped with comprehensive error handling support, ensuring that any errors or exceptions encountered during the data retrieval or writing process are efficiently managed and appropriately communicated to users for prompt resolution.
Data Visualization and Reporting: The ZappySys API Driver facilitates the seamless processing and presentation of the retrieved data from Azure DevOps, enabling users to generate comprehensive reports and visualizations for further analysis and decision-making purposes.

Overall, the ZappySys API Driver serves as a powerful tool for streamlining the integration of applications with Azure DevOps, providing users with a convenient and efficient way to access and manage data, all through a user-friendly and intuitive interface.