How to Properly Format an Azure DevOps Pipeline API JSON Request with a Variable in Python

Learn how to format a JSON request for Azure DevOps Pipeline API in Python. This guide explains how to pass variables correctly in your request to avoid issues like added quotes around variables.
---

Visit these links for original content and any more details, such as alternate solutions, latest updates/developments on topic, comments, revision history etc. For example, the original title of the Question was: How do I properly format an Azure Devops Pipeline API JSON request containing a variable in Python?

If anything seems off to you, please feel free to write me at vlogize [AT] gmail [DOT] com.
---
How to Properly Format an Azure DevOps Pipeline API JSON Request with a Variable in Python

When working with the Azure DevOps Pipeline API, you might encounter issues when attempting to pass a variable in your JSON request made via Python. A common problem developers face is formatting the JSON correctly such that it does not inadvertently include extra quotes around the variable when sending the request. If you are experiencing this problem, don't worry! In this post, we will delve into how to properly format your JSON request to avoid such issues.

Understanding the Problem

You may find yourself in a situation where your JSON request looks somewhat like this:

[[See Video to Reveal this Text or Code Snippet]]

Upon sending the request, the logs might show the variable build_version formatted with quotes, like this:

[[See Video to Reveal this Text or Code Snippet]]

However, when you enter the version manually in the GUI, the logs reflect the expected result without quotes:

[[See Video to Reveal this Text or Code Snippet]]

This discrepancy can be frustrating and may lead to failed requests. So, let's break down how we can resolve this issue effectively.

Step-by-Step Solution

1. Correct the URL Endpoint

The first step to solving the problem is ensuring that you are using the correct URL endpoint for your API call. Instead of using the build URL, you want to direct your request at the pipeline URL. Here's how the updated URL should look:

[[See Video to Reveal this Text or Code Snippet]]

2. Adjust the JSON Body Format

The second crucial adjustment you need to make is in the JSON body of your request. Instead of using templateParameters, the body should reference variables. It’s essential to structure your variables correctly; here’s the revised way to format it:

[[See Video to Reveal this Text or Code Snippet]]

Now, by implementing these changes, your final Python script should look like this:

[[See Video to Reveal this Text or Code Snippet]]

Conclusion

By correcting the API endpoint and formatting your JSON body appropriately with the variables key, you should no longer encounter the issue of unwanted quotes around your variable. Remember, always ensure that your endpoints and body structures are accurate to facilitate smoother API interactions.

Now that you're equipped with this knowledge, you can confidently send well-formed JSON requests in Python to the Azure DevOps Pipeline API! Happy coding!