Azure DevOps – REST APIs – Part 1 – for Projects

Azure DevOPs Rest API - Getting all the projects from the Organization

Hi All,

LIFE IS BEAUTIFUL 🙂 I hope we all are safe 🙂 STAY SAFE, STAY HEALTHY,  STAY HOME 🙂

Background: We have started discussing Azure DevOps. In last seven articles of Azure DevOps we discussed

In this article we will move ahead and will discuss REST APIs for DevOps projects. We will access REST APIs from browser and in next upcoming articles we will discuss how we can programmatically access REST APIs

Take away from this article: At the end of this article we will got to know about

  • What are REST APIs
  • What are REST APIs
  • What are REST APIs

Azure DevOps REST APIs scenarios : This is good question 🙂 why we require REST APIs for Azure DevOps services. There are quite few scenarios where I think we can utilize DevOps REST APIs such as

  • Consider Jira Integration, as soon as bug / CR created in Jira, there should be new workitem in DevOps
  • Similarly integration with Service Now tickets
  • Integration with time card applications

Prerequisites :

  • We must have an organization in Azure DevOps.
  • Bit knowledge of REST APIs

What are REST APIs :

  • Microsoft Defines – Representational State Transfer (REST) APIs are service endpoints that support sets of HTTP operations (methods)
  • Azure REST APIs support GET, HEAD, PUT, POST, and PATCH methods
  • These REST APIs can be consumed from browser and get the data in JSON format

Azure DevOps request URI :

  • Format of the Azure DevOps request URI – What are REST APIs
    • instance – The Azure DevOps Services organization. eg. – https://dev.azure.com/{organization}
    • resource path: The resource path is as follows: _apis/{area}/{resource}. For example _apis/wit/workitems.
    • api-version: api-versions are in the following format: {major}.{minor}[-{stage}[.{resource-version}]], for example:
      • api-version=1.0
      • api-version=1.2-preview
      • api-version=2.0-preview.1
    • Best Practice : API version must be specified with every request.

Examples :

  • Fetching all the projects in given Organization
  • If we want specific project details, we can use Project ID or Project name as

References:

Next Article : In next article we will discuss how to access/call Azure DevOps REST APIs programmatically.

We have very good series going on Azure DevOps. Please have a look once – https://knowledge-junction.com/?s=Azure+DevOps

Thanks for reading 🙂 Feel free to discuss / comment / questions 🙂 . SHARING IS CARING 🙂

Share In Teams:

Enjoy the beautiful life 🙂 Have a FUN 🙂 HAVE A SAFE LIFE 🙂 TAKE CARE 🙂

This site uses Akismet to reduce spam. Learn how your comment data is processed.