Test Cases
Test cases live in the Test Management service and are shared by TestPilot and CaseWriter.
Base path: https://api.rabbitqa.com/tmt/company/api/v1/testCases
note
The path segment is camelCase — testCases, not test-cases.
List and retrieve
curl https://api.rabbitqa.com/tmt/company/api/v1/testCases \
-H "Authorization: Bearer $TOKEN" \
-H "X-Workspace-Id: 91"
| Method | Path | Purpose |
|---|---|---|
GET | /testCases | List test cases in the active workspace |
GET | /testCases/recent | Recently viewed or edited cases |
GET | /testCases/{testCaseId} | Retrieve by numeric id |
GET | /testCases/{code} | Retrieve by human-readable code, for example TC-118 |
GET | /testCases/{testCaseId}/audits | Change history for one case |
The code lookup accepts the PREFIX-NUMBER form shown in the interface, which makes it convenient for linking from an external tracker.
Create, update and delete
| Method | Path | Purpose |
|---|---|---|
POST | /testCases | Create a test case |
PUT | /testCases/{testCaseId} | Update a test case |
DELETE | /testCases/{testCaseId} | Delete one test case |
DELETE | /testCases | Delete several by id |
POST | /testCases/batch | Create several in one call |
POST | /testCases/changeSet | Apply a set of changes together |
Bulk operations
| Method | Path | Purpose |
|---|---|---|
POST | /testCases/bulk-move | Move cases between folders or projects |
POST | /testCases/bulk-delete-state | Check or apply a bulk delete |
Labels
| Method | Path | Purpose |
|---|---|---|
POST | /testCases/{testCaseId}/labels | Attach labels |
DELETE | /testCases/{testCaseId}/labels | Detach labels |
Labels themselves are managed at /tmt/company/api/v1/labels.
Test sets
A test set groups cases for execution.
Base path: https://api.rabbitqa.com/tmt/company/api/v1/testSets
| Method | Path | Purpose |
|---|---|---|
GET | /testSets | List test sets |
GET | /testSets/recent | Recently used sets |
GET | /testSets/{testSetId} | Retrieve by id |
GET | /testSets/{code} | Retrieve by code |
POST | /testSets | Create |
PUT | /testSets/{testSetId} | Update |
DELETE | /testSets/{testSetId} | Delete one |
DELETE | /testSets | Delete several |
POST | /testSets/move | Move within the tree |
Supporting lookups
These return the values accepted by the case fields:
/tmt/company/api/v1/testStatus/tmt/company/api/v1/testPriorities/tmt/company/api/v1/testComplexities/tmt/company/api/v1/labels
Structure and import
/tmt/company/api/v1/testTrees— folder structure, with move, duplicate, undo and redo run as asynchronous sessions/tmt/company/api/v1/testRepository— Excel and TestRail import and export, also asynchronous
