Jama Connect® REST API Basics (90 Minutes)

Published Date: August 2026
Validated: Yes
Audience: Signed-in Users
Products and Versions Covered:

• Jama Connect®
• REST API

Summary

Resolution

Prerequisites

• Jama Connect user account with a Named Creator License in order to access the Jama REST API
• Basic REST concepts (requests, responses, status codes)
• Proficiency in reading JSON data structures
• Ability to use an API client (Postman, curl, Insomnia) or write simple HTTP calls in your preferred language

Introduction video

• Jama Connect REST API Training Deck 

Module 1: Availability & Authentication

In this part, you’ll confirm your Jama instance supports the REST API and learn the authentication approach you’ll use for the rest of the course. Follow along with slides 3–4 in the master deck.

Module 2: Example Use Cases

In this part, you’ll walk through practical ways teams use the Jama REST API and the kinds of workflows you can automate or integrate.

Module 3: API Response Format

In this part, you’ll learn how to read and interpret Jama REST API responses—what fields to expect, how objects are structured, and how to spot the information you need quickly.

Module 4: Support & Documentation

In this part, you’ll learn where to find REST API documentation, what to bookmark, and how to get help when you hit a blocker.

Module 5: Frequently Asked Questions

In this video, we’ll explore some of the most frequently asked questions about the Jama REST API, offering insights and guidance to help you successfully address common challenges and requests.

Module 6: Demo - Swagger UI (Cloud)

In this video, we walk through a live demonstration of how to use the Swagger UI available in every Jama Cloud instance. You’ll see where to find it, how to authenticate, and how to run calls directly in the browser.

What to do while you watch: Open Swagger UI in your own Jama Cloud instance and follow along: locate an endpoint, authorize, run a request, and inspect the response and headers.

Module 7: Demo - Searching with Abstract Items

Quick demo of how to use the abstract items endpoint to search Jama items, attachments, and other objects. This is a practical “watch and try it” segment — no slide deck required.

Try it yourself. After watching, run one search query in Swagger UI (or your API client) and confirm you can return: (1) items, (2) an attachment, and (3) at least one other object type.

Module 8: Demo - Handling Items (GET, POST, PUT, DELETE)

In this demo, you’ll use the built-in Swagger UI to perform common item workflows in Jama: listing items in a project, retrieving a single item, creating a new item, updating an item, and deleting an item. No slide deck for this part — it’s hands-on.

Try it yourself. After watching, repeat the flow in your own Swagger UI: (1) list items in a project, (2) GET one item, (3) POST a new item, (4) PUT an update, and (5) DELETE the test item you created.

In this final demo, you’ll see how to create an attachment in Jama Connect using the REST API, combining the built-in Swagger UI with Postman to complete the workflow end-to-end. No slide deck for this part — it’s hands-on.

Try it yourself. After watching, repeat the flow with a test item: create an attachment via Postman, confirm it exists in Jama, and verify the attachment metadata using a GET call.

• 1. Jama REST API Basics - Introduction.mp410 MB
• Jama REST API Training - June 2026.pdf1 MB