Jama Python Rest API - Python

Introduction

Jama is a product development platform that helps organizations to manage their product development processes. It provides a REST API that allows 3rd-party applications to interact with Jama and is available in Python as well. This API can be used to interact with items, projects, workflows, and other entities within the Jama platform. In this article, we will cover the Jama Python Rest API and how to use it.

Prerequisites

Before we use the Jama Python Rest API, we need to make sure that we have the following:

• An active Jama account
• An API key with permissions to interact with the Jama API
• Python installed on our system
• requests and json libraries installed using Python's pip package manager

Jama Python Rest API

The Jama Python Rest API is a set of functions and classes that allow us to interact with the Jama REST API using Python. We can use these functions and classes to access Jama's various resources and manipulate them according to our requirements. Let's start with the basics.

Importing Libraries

import requests, json

We need to import two libraries requests for sending the HTTP requests to the API endpoint and json for parsing the JSON response.

Setting up API URL

url = "https://your_jama_url.com/rest/latest/"

We need to set up the URL of the Jama REST API endpoint. We can get this URL from the Jama account settings.

Authentication

authToken = "Bearer your_api_key_here"
authHeaders = {'Authorization': authToken}

We need to authenticate ourselves before accessing the Jama API. We can do this by providing our API key with the HTTP Authorization header.

Sending a GET Request

def getJamaResult(endpoint):
    r = requests.get(url = url + endpoint, headers = authHeaders)
    jsonResponse = json.loads(r.content)
    return jsonResponse

We can send a GET request to the Jama API endpoint using the requests.get() method. We need to provide the URL of the endpoint along with the authentication headers. We then parse the JSON response using the json.loads() method.

Sending a POST Request

def postJamaResult(endpoint, data):
    r = requests.post(url = url + endpoint, headers = authHeaders, json = data)
    jsonResponse = json.loads(r.content)
    return jsonResponse

We can send a POST request to the Jama API endpoint using the requests.post() method. We need to provide the URL of the endpoint, authentication headers, and the data to be sent as a JSON payload.

Sending a PUT Request

def putJamaResult(endpoint, data):
    r = requests.put(url = url + endpoint, headers = authHeaders, json = data)
    jsonResponse = json.loads(r.content)
    return jsonResponse

We can send a PUT request to the Jama API endpoint using the requests.put() method. We need to provide the URL of the endpoint, authentication headers, and the data to be sent as a JSON payload.

Sending a DELETE Request

def deleteJamaResult(endpoint):
    r = requests.delete(url = url + endpoint, headers = authHeaders)
    jsonResponse = json.loads(r.content)
    return jsonResponse

We can send a DELETE request to the Jama API endpoint using the requests.delete() method. We need to provide the URL of the endpoint and authentication headers.

Conclusion

In this article, we learned about the Jama Python Rest API and how to use it. We saw how to import libraries, set up the API URL, authenticate ourselves, and send GET, POST, PUT, and DELETE requests to the Jama API endpoint. With this knowledge, we can now interact with Jama's various resources and manipulate them according to our requirements.