Back to QMetry All Products Help Page
API for Test Suites
- Mrunalini Potnis
- Rachit Kacheria (Unlicensed)
- Shravani Hendre (Unlicensed)
- 1 Get List of Test Suites
- 2 Get Test Suite List along with Fields
- 3 View Test Suite Details
- 4 Create Test Suite
- 5 Update Test Suite
- 6 Copy a Test Suite
- 7 Copy a Test Suite with Rlease Cycle
- 8 Delete Test Suite
- 9 Delete Test Suites in Bulk
- 10 Get information of sub folders of a particular folder
- 11 Create Test Suite Folder
- 12 Archive Test Suite Folder
- 13 Unarchive Test Suite Folder
- 14 Update Test Suite Folder
- 15 Delete Test Suite Folder
- 16 Get all Releases & Cycles of Test Suite
- 17 Add Release & Cycle To Test Suite
- 18 Remove Release & Cycle from Test Suite
- 19 List Test Cases Linked to Test Suite
- 20 Link Test Cases to Test Suite
- 21 Update Test Case Linked to Test Suite with its Latest Version
- 22 Unlink Testcase(s) from Testsuite
- 23 List of Platforms Linked to a Test Suite
- 24 Link Platforms to Test Suite
- 25 Unlink Platforms from Test Suites
- 26 Assign Platform Owner to Test Suites
- 27 Assign Tester to Test Case During Execution
- 28 Update Run Comments
- 29 Get Execution List
- 30 Get Test Suite Run IDs
- 31 Get Test Case Run IDs
- 32 Get List of Test suites for a Testcase
- 33 Fetch Testcase List
- 34 List of Issues Linked to Execution
- 35 Get list of Issue available for linking or already linked to Test case Run
- 36 Get list of issue available for linking or already linked to Test case Step Run
- 37 Get list of Testcase Step Run for a Test Case execution along with dynamic columns
- 38 Link Issues to Test Case During Execution
- 39 Unlink Issues from Test Case During Execution
- 40 Link Issues to Test Case Step During Execution
- 41 Unlink Issues from Test Case Step During Execution
- 42 Display Issues linked to Test Case During Execution
- 43 Bulk Update Run Status
- 44 Reset Execution Status on Build Update
- 45 Schedule Test Execution using Scheduler
- 46 Schedule Test Execution using Scheduler
- 47 List Test Execution Run
- 48 Detail View Tab Order
Get List of Test Suites
POST /rest/testsuites/list
Request
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
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 |
tsFolderID | body | yes | FolderId of Test Suites | - | integer |
scope | body | yes | Scope of Testsuite, possible values project,release,cycle | - | string |
Response
Content-Type: application/json
Status Code | Reason | Response Model |
|---|---|---|
200 | Testsuite 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 Suite List along with Fields
POST /rest/testsuites/list/viewColumns
Description
Fetch specific data of test suites 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 Testsuite module. View ID can be fetched from latestViews section of Getinfo API. | - | integer |
folderPath | body | yes | Path of folder whose Testsuites 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 |
Response
Content-Type: application/json
Status Code | Reason | Response Model |
|---|---|---|
200 | Testsuite list fetched successfully | |
400 | Invalid json object or mandatory fields missing | - |
401 | Unauthorised or session expired | - |
500 | Returned when server connection times out | - |
View Test Suite Details
POST /rest/testsuites/detail/data
Request
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
id | body | yes | Id of Testsuite | - | integer |
Response
Content-Type: application/json
Status Code | Reason | Response Model |
|---|---|---|
200 | Test Suites detail fetch successfully | |
400 | Invalid json object or mandatory fields missing | - |
401 | Unauthorised or session expired | - |
500 | Returned when server connection times out | - |
Create Test Suite
POST /rest/testsuites
Description
API to create testsuite
Request
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
parentFolderId | body | yes | Parent folderId of Test Suites | - | string |
isAutomatedFlag | body | no | Default value false | - | boolean |
name | body | yes | Summary of Test Suites | - | string |
description | body | no | Description of Test Suites | - | string |
testsuiteOwner | body | no | Owner of Test Suites | - | integer |
testSuiteState | body | no | Status of Test Suites | - | integer |
associateRelCyc | body | no | Pass true only when releaseCycleMapping is passed | - | boolean |
releaseCycleMapping | body | no | An array of releaseId, buildID(Do not pass tsId) | - | Array[Data] |
requirementId | body | no | Id of the requirement from which user wants to create testsuite | - | string |
Response
Content-Type: application/json
Status Code | Reason | Response Model |
|---|---|---|
200 | TestSuite created successfully | |
400 | Invalid json object or mandatory fields missing | - |
401 | Unauthorised or session expired | - |
500 | Returned when server connection times out | - |
Update Test Suite
PUT /rest/testsuites
Request
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
parentFolderId | body | no | Parent folderId of Test Suites | - | string |
isAutomatedFlag | body | no | Default value false | - | boolean |
name | body | no | Summary of Test Suites | - | string |
description | body | no | Description of Test Suites | - | string |
owner | body | no | OwnerId of Test Suites | - | integer |
ownUser | body | no | An array of ownerId of Test Suites | - | Array[integer] |
owneralias | body | no | Owner name of Test Suites | - | string |
testSuiteState | body | no | StatusId of Test Suites | - | integer |
testSuiteStateAlias | body | no | Status name of Test Suites | - | string |
tsState | body | no | An array of statusId of Test Suites | - | Array[integer] |
entityKey | body | yes | EntityKey of Test Suites | - | string |
folderPath | body | no | Folder path of Test Suites | - | string |
TsFolderID | body | yes | Folder Id of Test Suites | - | integer |
id | body | yes | Id of Test Suites | - | integer |
Response
Content-Type: application/json
Status Code | Reason | Response Model |
|---|---|---|
200 | Test Suites update successfully | |
400 | Invalid json object or mandatory fields missing | - |
401 | Unauthorised or session expired | - |
500 | Returned when server connection times out | - |
Copy a Test Suite
PUT /rest/testsuites/copy
Description
Copy TestSuite in same folder or another folder
Request
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
srcFolderId | body | yes | Source FolderId of Testsuite | - | integer |
destFolderId | body | yes | Destination FolderId of Testsuite | - | integer |
id | body | yes | Id of Test Suites | - | string |
isBulkOperation | body | no | BulkOperation flag | - | boolean |
isPlatformCopy | body | no | copy platform(s) if flag is true (default:true) | - | boolean |
isReleaseCycleCopy | body | no | copy release(s)/cycle(s) if flag is true (default:true) | - | boolean |
executionStatusIds | body | no | copy only test cases having selected test execution status (Default :null) | - | string |
isPlatformCopyWithSelctedStatus | body | no | copy platform(s) with selected test execution status (default:false) | - | boolean |
isLatestVersionSync | body | no | sync latest version of test case(s) (default:false) | - | boolean |
isResetToNotrun | body | no | To preserve existing test execution status of test case(s) (default:true) | - | boolean |
isResetAssignee | body | no | To Reset Assignee of test case(s) (default:false) | - | boolean |
Response
Content-Type: application/json
Status Code | Reason | Response Model |
|---|---|---|
200 | TestSuite copied successfully | |
400 | Invalid json object or mandatory fields missing | - |
401 | Unauthorised or session expired | - |
500 | Returned when server connection times out | - |
Copy a Test Suite with Rlease Cycle
PUT /rest/testsuites/copyWithNewReleaseCycle
Description
Copy TestSuite in same folder or another folder with New Release Cycle
Request
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
srcFolderId | body | yes | Source FolderId of Testsuite | - | integer |
destFolderId | body | yes | Destination FolderId of Testsuite | - | integer |
executionStatusIds | body | no | Copy only test cases having selected test execution status (Default :null) | - | integer |
id | body | yes | Id of Test Suites | - | string |
build | body | no | Assign Build to Execution | - | integer |
isBulkOperation | body | no | BulkOperation flag | - | boolean |
isLatestVersionSync | body | no | Sync latest version of test case(s) (default:false) | - | boolean |
isOldReleaseCycleSelected | body | no | Reference Release Cycle is Selected Flag | - | boolean |
isPlatformCopy | body | no | Copy platform(s) if flag is true (default:true) | - | boolean |
isPlatformCopyWithSelctedStatus | body | no | Copy platform(s) with selected test execution status (default:false) | - | boolean |
isResetAssignee | body | no | To Reset Assignee of test case(s) (default:false) | - | boolean |
isResetToNotrun | body | no | To preserve existing test execution status of test case(s) (default:true) | - | boolean |
latestVersionSync | body | no | Sync Latest Testcase Version in new Execution | - | boolean |
newreleaseCycleMapping | body | no | An array of releaseId, buildID | - | Array[Data] |
oldReleaseCycleMappingId | body | no | Reference Release Cycle Mapping ID | - | integer |
oldReleaseCycleSelected | body | no | Reference Release Cycle Executions For Copying | - | boolean |
platformCopy | body | no | Copy platform | - | boolean |
platformCopyWithSelctedStatus | body | no | Copy Execution of Platform with Selected Status | - | boolean |
release | body | no | Copy release | - | integer |
resetAssignee | body | no | Reset Assignee in new Execution Flag | - | boolean |
resetToNotrun | body | no | Reset Execution Status in New Execution to Not Run Flag | - | boolean |
Response
Content-Type: application/json
Status Code | Reason | Response Model |
|---|---|---|
200 | Test Suite copied successfully | - |
201 | Created | - |
400 | Invalid json object or mandatory fields missing | - |
401 | Unauthorised or session expired | - |
403 | Forbidden | - |
404 | Not Found | - |
500 | Returned when server connection times out | - |
Delete Test Suite
POST /rest/testsuites/delete
Request
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
ids | body | yes | Id of Test Suite | - | integer |
Response
Content-Type: application/json
Status Code | Reason | Response Model |
|---|---|---|
200 | TestSuites deleted successfully | |
400 | Invalid json object | - |
401 | Unauthorised or session expired | - |
500 | Returned when server connection times out | - |
Delete Test Suites in Bulk
POST /rest/testsuites/deleteEntity
Request
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default |
|---|