Jama Connect User Guide

REST API and extensibility

Jama Connect offers a powerful REST API that allows your team to integrate and extend the out-of-box capabilities of Jama Connect.

Typical use cases include:

  • Integrating test results from automated test scripts

  • Extracting specific data for analysis in Business Intelligence tools

  • Automating batch manual tasks

You can see REST API swagger documentation at <your Jama URL>/api-docs/

Jama_REST_API.png

Interested in learning how to work with the Jama Connect REST API? The following resources can help you get started.

ID

Description

Project ID

Project IDs are unique to Jama Connect. Your administrator sets the default project and set keys.

Example: <project key> - <set key> # <SBX-REQ-1 or SBX-TEST-3>

Global ID

Global IDs are used to reference where a requirement or test was reused globally across Jama Connect projects. The Global ID isn’t unique because several copies of items might be connected that share the same Global ID.

Example: GID-1234

API ID

API IDs are the database identifier for an item and is used by developers when interacting with Jama Connect from the REST API.

In List View, you can locate the API ID as a column or in the browser URL for the item you’re viewing in Jama Connect.

Example: 21374

Find Project API ID in URL:

Project_API_ID.png

Find Filter API ID, navigate to the filter in Jama Connect and look at URL:

Filter_API_ID.png

Find Item API IDs:

Item_API_IDs.png

Find API IDs in List View:

List_View.png