Skip to main content

How to use Azure DevOps REST API to extract and update data within Azure DevOps?

Azure DevOps offers a fantastic set of REST APIs which allows you to extract and operate data within Azure DevOps by sending an HTTP request to a specific service.

It is up to you how you want to call these APIs i.e., using Postman if you are not a fan of coding much or you can use RestAssured, RestSharp libraries if you can write code.

I am using Postman here to execute these APIs; all the Azure DevOps Rest APIs expect you to follow these things:

1)    Provide the PAT (Personal Access Token) in the Authorization tab:

o  Type: Basic Auth

o  Username: leave it blank

o  Password: Enter your PAT

Note* Here is how you can create a PAT: https://docs.microsoft.com/en-us/azure/devops/organizations/accounts/use-personal-access-tokens-to-authenticate?view=azure-devops&tabs=Windows#create-personal-access-tokens-to-authenticate-access

2)     Send the request

o Select the HTTP Method (Get, Post, Patch, etc.)

o Create a request URL, replacing your organization and your project name of your Azure DevOps:

Sample endpoint: https://dev.azure.com/yourOrganizationName/yourProjectName/_apis/test/plans?api-version=5.0



3)    Receive the response

Once you have the request ready, send the request. If all turns good we should now see a response like:

{"value": [{"id": 6,"name": "Demo","url": "https://dev.azure.com/dheerajgambhir/AutomationFramework/_apis/test/Plans/6","project": {"id": "67beff99-e912-4068-abd0-1c4096tre141","name": "AutomationFramework","url": "https://dev.azure.com/dheerajgambhir/_apis/projects/AutomationFramework"},"area": {"id": "0","name": "AutomationFramework"},"iteration": "AutomationFramework","owner": null,"revision": 0,"state": "Active","rootSuite": {"id": "7"},"clientUrl": "mtms://dev.azure.com:443/dheerajgambhir/p:AutomationFramework/Testing/testplan/connect?id=6"}],"count": 1}

Here are a few major services that are available in the Azure DevOps:

·      Get Test Plan ID:

Endpoint: https://dev.azure.com/yourOrganizationName/yourProjectName/_apis/test/plans?api-version=5.0

·      Get Suite ID:

Endpoint: https://dev.azure.com/yourOrganizationName/yourProjectName/_apis/test/plans/planID/suites?api-version=5.0

·      Get Test Case ID:

Endpoint: https://dev.azure.com/yourOrganizationName/yourProjectName/_apis/test/plans/planID/suites/suiteID/points?api-version=5.0

·      Get Test Point ID:

Endpoint: https://dev.azure.com/yourOrganizationName/yourProjectName/_apis/test/plans/planID/suites/suiteID/points?testCaseId=tcID&api-version=5.0

·      Create Test Run:

Endpoint: https://dev.azure.com/yourOrganizationName/yourProjectName/_apis/test/runs?api-version=5.0

·      Get Suite ID:

Endpoint: https://dev.azure.com/yourOrganizationName/yourProjectName/_apis/test/runs/runID/results?api-version=6.0-preview.6

·      Create a bug:

Endpoint: https://dev.azure.com/yourOrganizationName/yourProjectName/_apis/wit/workitems/$bug?api-version=5.0

·      Update test results in test run:

Endpoint: https://dev.azure.com/yourOrganizationName/yourProjectName/_apis/test/runs/runID/results?api-version=6.0-preview.6

For more info: https://docs.microsoft.com/en-us/rest/api/azure/devops/?view=azure-devops-rest-7.1&viewFallbackFrom=azure-devops-rest-5.1

 

Labels:

Comments

Post a Comment

Popular posts from this blog

Clipboardy: Node.js library

 Clipboardy is a popular Node.js library that provides a cross-platform solution for interacting with the system clipboard. It supports both synchronous and asynchronous operations, and it can be used to copy, paste, and read the clipboard contents. Features of Clipboardy: 1. Cross-platform compatibility: It works on macOS, Windows, Linux, OpenBSD, FreeBSD, Android with Termux, and modern browsers. 2. Synchronous and asynchronous operations: It provides both synchronous and asynchronous methods for clipboard operations, making it suitable for a variety of use cases. 3. Copy, paste, and read operations: It supports copying, pasting, and reading the clipboard contents, making it a versatile tool for interacting with the clipboard. 4. Promise-based API: It is an asynchronous method that returns promises, making it easy to handle asynchronous operations in a clean and concise way. 5. Easy to use: It has a simple and intuitive API that is easy to learn and use. How to Use Clipboardy: To...
Post a Comment
Read more

ARIA Snapshot in Playwright

  What is an ARIA Snapshot in Playwright? An  ARIA snapshot  in Playwright is a structured representation of a page’s  accessibility tree , which is used by assistive technologies (e.g., screen readers) to interpret the content of a web page. This snapshot helps verify if elements have the correct  roles, names, and properties  required for accessibility. Playwright provides the page.accessibility.snapshot() API to capture this accessibility tree at any given moment during test execution. How Does ARIA Work? ARIA ( Accessible Rich Internet Applications ) is a set of attributes that help improve accessibility by defining roles, states, and properties for elements that are not natively accessible. Example: In this case, the aria-label ensures that screen readers identify the button as “Submit Form.” How to Use ARIA Snapshots in Playwright? Playwright’s  accessibility.snapshot()   method retrieves the  accessible structure  of the page. Ex...
Post a Comment
Read more

Bruno vs Postman: Which API Client Should You Choose?

  As API testing becomes more central to modern software development, the tools we use to test, automate, and debug APIs can make a big difference. For years, Postman has been the go-to API client for developers and testers alike. But now, Bruno , a relatively new open-source API client, is making waves in the community. Let’s break down how Bruno compares to Postman and why you might consider switching or using both depending on your use case. ✨ What is Bruno? Bruno is an open-source, Git-friendly API client built for developers and testers who prefer simplicity, speed, and local-first development. It stores your API collections as plain text in your repo, making it easy to version, review, and collaborate on API definitions. 🌟 What is Postman? Postman is a full-fledged API platform that offers everything from API testing, documentation, and automation to mock servers and monitoring. It comes with a polished UI, robust integration, and support for collaborati...
Post a Comment
Read more