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

How to Unzip files in Selenium (Java)?

1) Using Java (Lengthy way) : Create a utility and use it:>> import java.io.BufferedOutputStream; import org.openqa.selenium.io.Zip; import java.io.File; import java.io.FileInputStream; import java.io.FileOutputStream; import java.io.IOException; import java.util.zip.ZipEntry; import java.util.zip.ZipInputStream;   public class UnzipUtil {     private static final int BUFFER_SIZE = 4096;     public void unzip (String zipFilePath, String destDirectory) throws IOException {         File destDir = new File(destDirectory);         if (!destDir.exists()) {             destDir.mkdir();         }         ZipInputStream zipIn = new ZipInputStream(new FileInputStream(zipFilePath));         ZipEntry entry = zipIn.getNextEntry();         // to iterates over entries in the zip folder         while (entry != null) {             String filePath = destDirectory + File.separator + entry.getName();             if (!entry.isDirectory()) {                 extractFile (zipIn, filePath);            
Post a Comment
Read more

Encode/Decode the variable/response using Postman itself

We get a lot of use cases where we may have to implement Base64 encoding and/or decoding while building our APIs. And, if you are wondering if it is possible to encode/decode the variable/response using Postman itself or how to encode/decode the token or password in postman and save it in a variable? To Base64 encode/decode, the quickest way is to use JavaScript methods btoa, atob: atob - It turns base64-encoded ASCII data back to binary. btoa - It turns binary data to base64-encoded ASCII. Sample code : var responseBody = pm.response.json(); var parsedPwd = JSON.parse(atob(responseBody.password)); // presuming password is in the payload pm.collectionVariables.set("password", parsedPwd);
Post a Comment
Read more

The use of Verbose attribute in testNG or POM.xml (maven-surefire-plugin)

At times, we see some weird behavior in your testNG execution and feel that the information displayed is insufficient and would like to see more details. At other times, the output on the console is too verbose and we may want to only see the errors. This is where a verbose attribute can help you- it is used to define the amount of logging to be performed on the console. The verbosity level is 0 to 10, where 10 is most detailed. Once you set it to 10, you'll see that console output will contain information regarding the tests, methods, and listeners, etc. <suite name="Suite" thread-count="5" verbose="10"> Note* You can specify -1 and this will put TestNG in debug mode. The default level is 0. Alternatively, you can set the verbose level through attribute in "maven-surefire-plugin" in pom.xml, as shown in the image. #testNG #automationTesting #verbose # #testAutomation
Post a Comment
Read more