API for Test Cases
- 1 Get List of Testcases in Folder
- 2 Get Test Case List along with Custom Fields
- 3 Get Test case Details
- 4 List of Test case(s) for Bulk Operations
- 5 Get Test case linked to a Requirement
- 6 Get Test case linked to a TestSuite
- 7 Get information of parameters associated with the Testcase linked to a Testsuite
- 8 List Version details of Test case
- 9 View Test Case Details
- 10 List Test Case Steps
- 11 Get All Versions of Testcase
- 12 Create Testcase
- 13 Update Test case(s)
- 14 Archive Testcase
- 15 Delete Testcase
- 16 Delete a Testcase Version
- 17 Link Issue(s) to Testcase
- 18 Unlink Issue(s) from Testcase
- 19 Get sub folder information of a particular folder
- 20 Get Details of Test Case Folder
- 21 Create Test Case Folder
- 22 Archive Testcase Folder
- 23 Unarchive Testcase Folder
- 24 Update Test Case Folder
- 25 Delete Test Case folder
- 26 Get Release & Cycle of Test Case
- 27 Add Release & Cycle to Test Case
- 28 Remove Release & Cycle from Test Case
- 29 Add Testcase Comments
- 30 Update Testcase Comments
- 31 Get Testcase Comments
- 32 Delete Testcase Comments
- 33 Get List of Requirements in Test Case
- 34 Link Requirement(s) to Testcase
- 35 Unlink Requirement(s) fromTestcase
- 36 Link TestSuites to Testcase
- 37 List Test Case Executions
- 38 List Test Cases Linked with Shared Test Case
Get List of Testcases in Folder
POST /rest/testcases/list
Description
Get test case list based on particular ID of test case or folder inside all data or particular version related data.
Request
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
id | body | yes | Id of Testcase | - | integer |
version | body | yes | Version number of Testcase | - | integer |
start | body | no | Start index of records | - | integer |
limit | body | no | Number of records per page | - | integer |
page | body | no | Page number to be displayed | - | integer |
tcFolderID | body | no | FolderId of Testcase | - | integer |
scope | body | yes | Scope of Testcase, possible values project,release,cycle | - | integer |
Response
Content-Type: application/json
Status Code | Reason | Response Model |
|---|---|---|
200 | Testcase list fetch successfully | |
400 | Invalid json object or mandatory fields missing | - |
401 | Unauthorised or session expired | - |
500 | Returned when server connection times out | - |
Get Test Case List along with Custom Fields
POST /rest/testcases/list/viewColumns
Description
Fetch specific data of test cases with custom fields.
Request
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
viewId | body | yes | View ID of the user for that particular project and Testcase module. View ID can be fetched from latestViews section of Getinfo API. | - | integer |
folderPath | body | yes | Path of folder whose Testcases are to be fetched | - | string |
start | body | no | Start index of records | - | integer |
limit | body | no | Number of records per page | - | integer |
page | body | no | Page number to be displayed | - | integer |
havingSharedTestcases | body | no | True value will fetch test cases having shared testcases linked with it | - | boolean |
isForCopyPasteTestStep | body | no | This will fetch version number list of testcase's in response | - | boolean |
isForCopyPaste | body | no | Get version number list of testcase's in response | - | boolean |
Response
Content-Type: application/json
Status Code | Reason | Response Model |
|---|---|---|
200 | Testcase list fetched successfully | |
400 | Invalid json object or mandatory fields missing | - |
401 | Unauthorised or session expired | - |
500 | Returned when server connection times out | - |
Get Test case Details
POST /rest/testcases/list
Description
Get details of Testcase.
Request
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
id | body | Yes | Id of Testcase. Get it from "Get Testcase in Folder" API parameter "tcID" | - | integer |
version | body | Yes | Version number of Testcase. | - | integer |
scope | body | Yes | Scope of Testcase, possible values project,release,cycle | - | integer |
Response
Content-Type: application/json
Status Code | Reason | Response Model |
|---|---|---|
200 | Testcase list fetch successfully | |
400 | Invalid json object or mandatory fields missing | - |
401 | Unauthorised or session expired | - |
500 | Returned when server connection times out | - |
List of Test case(s) for Bulk Operations
POST /rest/testcases/listForBulkOperation
Request
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
folderPath | body | yes | FolderPath of Testcase Folder whose testcases are to be listed | - | string |
showAllStateEntities | body | yes | value "true" | - | boolean |
start | body | no | Start index of records | - | integer |
limit | body | no | Number of records per page | - | integer |
page | body | no | Page number to be displayed | - | integer |
filter | body | yes | Filter test cases for respective bulk operations. The following is explanation of filters:
Example: {\"type\":\"list\",\"value\":[\"Critical\"],\"field\":\"priorityAlias\"}
Example: {\"type\":\"string\",\"comparison\":\"eq\",\"value\":\"JQ-TC-11\",\"field\":\"entityKeyId\"}
Example: {\"type\":\"string\",\"value\":\"Verify Login\",\"field\":\"name\"}
0 Does not display sharable testcases 1 Displays sharable testcases
1 Displays test cases with “In Review” status 2 Displays test cases with “Approved” status | *Note | string |
*Note:
IsShared: Default value is "0"
approvalStatus:
→ If approval workflow is enabled, the default value is "1"
→ If approval workflow is disabled, the default values is "2"
Response
Content-Type: application/json
Status Code | Reason | Response Model |
|---|---|---|
200 | TestCase list fetch successfully | |
400 | Invalid json object or mandatory fields missing | - |
401 | Unauthorised or session expired | - |
500 | Returned when server connection times out | - |
Get Test case linked to a Requirement
POST /rest/testcases/list/forRQ
Description
Get test case list based on particular id of requirement.
Request
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
rqID | body | no | Id of Requirement | - | integer |
tsID | body | no | Id of test suite | - | integer |
start | body | no | Start index of records | - | integer |
getLinked | body | no | 'True' to get only those testcases that are linked with this Requirement, 'false' to get those testcases which are not linked with this Requirement | - | boolean |
showEntityWithReleaseCycle | body |