API method to retrieve associated Test Groups for a given Test Case

Audience: Everyone

Environmental details: Cloud and Self-Hosted

Summary

The Jama Connect® API does not have a direct method to retrieve the test groups that contain a specific test case. A single test case might be included in dozens to hundreds of test groups throughout a project. This guide describes a method for programmatically retrieving the test groups associated with a given test case.

Solution

A method to retrieve the test groups that a specific test case or cases is part of is to query GET /testplans/{id}/testgroups, if you know the specific test plan. This will return all of the test groups in a specific test plan. From there, iterate through the test groups and for each one, call GET /testplans/{id}/testgroups/{testgroupid}/testcases and test the membership of the test case in each of the test groups.

If you'd like to find the test groups throughout the entire project, you would extend this approach by first calling GET /testplans and iterating through all of the test plans. 

Note: depending on the size of your project, this may cause many requests to be made to the API.

Additional Information/Metadata

• API
• Test Groups
• Test Cases

References

• Jama Connect Rest Client Documentation
• Examples to help get started with the Jama REST API

Please feel free to leave feedback in the comments below.