Skip to content
Software Testing Journal
Software Testing Journal

Your daily dose of learning!

  • Blog
  • Help Center
  • Video Playlist
  • Podcast & FAQ
  • Privacy Policy
Software Testing Journal

Your daily dose of learning!

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

Dheeraj Gambhir, 2023-08-142023-09-11

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/dg/AutomationFramework/_apis/test/Plans/6″,”project”: {“id”: “67beff99-e912-4068-abd0-1c4096tre141″,”name”: “AutomationFramework”,”url”: “https://dev.azure.com/dg/_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/dg/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

If you find this post helpful, please share them with your colleagues and friends.

  • Facebook
  • Twitter
  • LinkedIn
  • Email
DevOps AzureQuality Engineering

Post navigation

Previous post
Next post
©2025 Software Testing Journal | WordPress Theme by SuperbThemes