API Overview

In Tricentis Test Management for Jira, you can choose to manage your tests via the graphical user interface or through the API. Our API gives you the tools you need to create, edit, and delete test cases and test runs, as well as manage folders and attachments.

You can use the API to perform the following tasks in your workspace:

  • Manage your Test Cases and Folders. This includes the ability to find a particular test case, add a new test case, update an existing test case, or delete an obsolete test case.

  • Track any of Test Cases that are automated by your tool of choice.

  • Work with Attachments.

  • Manage your Test Runs. This includes the ability to find a particular test run, add a new test run, or delete an obsolete test run.

Note that if you change a test type to automated through the API or update an automated test case through the API, you can't revert the test case to manual. Since the test is managed by your external automation system, we only allow changes from your external automation system to maintain your source of truth.

Help me understand this better. How about an example?

If you have an external automation system, you could use the API to send information from the automation system to the associated test case in Tricentis Test Management for Jira. This function can help you easily track information such as the automation system type, external test ID, and links to the test in the automation system, without the need for any manual entry.

You could also use your own application framework to automatically create test runs by searching for an existing test case, and then creating and attaching new test runs.

Prerequisites

Check out the Swagger documentation

The Swagger API documentation describes all requests and responses. To access it, navigate to https://api.ttm4j.tricentis.com.

Get started with the API

To start using the API with your tests in Tricentis Test Management for Jira, check out these topics: