Back to QMetry All Products Help Page
API for Test Suites
- Mrunalini Potnis
- 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 New Release 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 (Deprecated)
- 21 Link Test Cases to Test Suite
- 22 Update Test Case Linked to Test Suite with its Latest Version
- 23 Unlink Testcase(s) from Testsuite (Deprecated)
- 24 Unlink Testcase(s) from Testsuite
- 25 List of Platforms Linked to a Test Suite
- 26 Link Platforms to Test Suite
- 27 Unlink Platforms from Test Suites
- 28 Assign Platform Owner to Test Suites
- 29 Assign Tester to Test Case During Execution
- 30 Update Run Comments
- 31 Get Test Suite Run IDs
- 32 Fetch Testcase List
- 33 Get list of Issue available for linking or already linked to Test case Run
- 34 Get list of issue available for linking or already linked to Test case Step Run
- 35 Get list of Testcase Step Run for a Test Case execution along with dynamic columns
- 36 Link Issues to Test Case During Execution
- 37 Unlink Issues from Test Case During Execution
- 38 Link Issues to Test Case Step During Execution
- 39 Unlink Issues from Test Case Step During Execution
- 40 Display Issues linked to Test Case During Execution
- 41 Bulk Update Run Status
- 42 Reset Execution Status on Build Update
- 43 Schedule Test Execution using Scheduler
- 44 List Test Execution Run
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 New Release Cycle
PUT /rest/testsuites/copyWithNewReleaseCycle
Description
Copy Test Suite 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 | Schema |
|---|---|---|---|---|---|
entityIds | body | yes | Id of Testsuites that have to be deleted | - | Array[integer] |
Response
Content-Type: application/json
Status Code | Reason | Response Model |
|---|---|---|
200 | Testsuites deleted successfully | |
400 | Invalid json object or mandatory fields missing | - |
401 | Unauthorised or session expired | - |
500 | Returned when server connection times out | - |
Get information of sub folders of a particular folder
POST /rest/testsuites/tree
Request
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
tsFolderID | body | yes | Folder ID of Selected TestSuite Folder | - | integer |
hideFolders | body | no | Flag to Hide empty Folders | - | boolean |
sort | body | no | Sort Folders by date or name | - | string |
Response
Content-Type: application/json
Status Code | Reason | Response Model |
|---|---|---|
200 | TestSuite folder tree listed successfully. | |
400 | Invalid json object or mandatory fields missing | - |
401 | Unauthorised or session expired | - |
500 | Returned when server connection times out | - |
Create Test Suite Folder
POST /rest/testsuites/folders
Request
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
name | body | yes | Folder Name | - | string |
parentId | body | yes | ID of parent folder | - | integer |
Response
Content-Type: application/json
Status Code | Reason | Response Model |
|---|---|---|
200 | TestSuite Folder created successfully | |
400 | Folder already exists | - |
401 | Unauthorised or session expired | - |
500 | Returned when server connection times out | - |
Archive Test Suite Folder
POST /rest/testsuites/folder/archive
Request
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
Archive Folder Request | body | yes | Archive Folder Inputs | - |
Response
Content-Type: application/json
Status Code | Reason | Response Model |
|---|---|---|
200 | Folder archived successfully | |
400 | Following fields are missing:tsFolderIDs | - |
401 | Unauthorised or session expired | - |
500 | Returned when server connection times out | - |
Unarchive Test Suite Folder
POST /rest/testsuites/folder/unarchive
Request
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
Unarchive Folder Request | body | yes | Unarchive Folder Inputs | - |
Response
Content-Type: application/json
Status Code | Reason | Response Model |
|---|---|---|
200 | Folder unarchived successfully | |
400 | Following fields are missing:tsFolderIDs | - |
401 | Unauthorised or session expired | - |
500 | Returned when server connection times out | - |
Update Test Suite Folder
PUT /rest/testsuites/folders
Request
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
folderId | body | yes | Unique identifier of Testsuite Folder to update | - | integer |
name | body | yes | Update Testsuite Folder name | - | string |
Response
Content-Type: application/json
Status Code | Reason | Response Model |
|---|---|---|
200 | Testsuite Folder updated successfully | |
400 | Invalid json object or mandatory fields missing | - |
401 | Unauthorised or session expired | - |
500 | Returned when server connection times out | - |
Delete Test Suite Folder
POST /rest/testsuites/folders/delete
Request
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
tsFolderID | body | yes | FolderId of Test Suites | - | integer |
Response
Content-Type: application/json
Status Code | Reason | Response Model |
|---|---|---|
200 | TestSuite folder successfully deleted. | |
400 | Invalid json object or mandatory fields missing. | - |
401 | Unauthorised or session expired. | - |
500 | Returned when server connection times out. | - |
Get all Releases & Cycles of Test Suite
POST /rest/testsuites/getReleaseCycleForTestSuite
Request
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
tsID | body | yes | Id of Testsuite | - | integer |
limit | body | yes | Number of record per page | - | integer |
page | body | yes | Page number to be displayed | - | integer |
start | body | yes | Start index of records | - | integer |
Response
Content-Type: application/json
Status Code | Reason | Response Model |
|---|---|---|
200 | Release & Cycle list fetch successfully | |
400 | Invalid json object or mandatory fields missing | - |
401 | Unauthorised or session expired | - |
500 | Returned when server connection times out | - |
Add Release & Cycle To Test Suite
POST /rest/testsuites/mapReleaseCycle
Request
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
data | body | yes | An array of Data | - | Array[Data] |
Response
Content-Type: application/json
Status Code | Reason | Response Model |
|---|---|---|
200 | Scope successfully added to testsuite | |
400 | Invalid json object or mandatory fields missing | - |
401 | Unauthorised or session expired | - |
500 | Returned when server connection times out | - |
Remove Release & Cycle from Test Suite
POST /rest/testsuites/unMapReleaseCycle
Request
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
tsReleaseCycleMapID | body | yes | Id of Testsuite's Release Cycle mapping | - | integer |
Response
Content-Type: application/json
Status Code | Reason | Response Model |
|---|---|---|
200 | Scope successfully deleted to testsuite | |
400 | Invalid json object or mandatory fields missing | - |
401 | Unauthorised or session expired | - |
500 | Returned when server connection times out | - |
List Test Cases Linked to Test Suite
POST /rest/testsuites/testcase/list
Request
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
filter | body | no | Filter to only show unshared Testcases | - | Array[Filter] |
tsID | body | yes | Id of Testsuite whose linked Testcases are to be obtained | - | integer |
start | body | yes | start index of records | - | integer |
limit | body | yes | number of records per page | - | integer |
page | body | yes | page number to be displayed | - | integer |
Response
Content-Type: application/json
Status Code | Reason | Response Model |
|---|---|---|
200 | Testcases linked with the Testsuite shown successfully | |
400 | Invalid json object or mandatory fields missing | - |
401 | Unauthorised or session expired | - |
500 | Returned when server connection times out | - |
Link Test Cases to Test Suite (Deprecated)
PUT /rest/testsuites/link/testcases
Request
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
tsID | body | yes | Unique identifier of Testsuite | - | integer |
tcIDs | body | yes | Version ID of Testcases which are to be linked with Testsuite | - | Array[integer] |
fromReqs | body | yes | True for Testcase link from Requirement otherwise false | - | boolean |
linktc | body | yes | True for Testcase link, default value true | - | boolean |
Response
Content-Type: application/json
Status Code | Reason | Response Model |
|---|---|---|
200 | TestCases successfully linked to TestSuite | |
400 | Invalid json object or mandatory fields missing | - |
401 | Unauthorised or session expired | - |
500 | Returned when server connection times out | - |
Link Test Cases to Test Suite
PUT /rest/testsuites/dolink/TCs
Request
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
tsID | body | yes | Unique identifier of Testsuite | - | integer |
tcvdIDs | body | yes | tcVersionIDs to link to testsuite | - | Array[integer] |
fromReqs | body | no | True for Testcase link from Requirement otherwise false | - | boolean |
rqEntitykeys | body | no | Comma-separated value of Requirement's entityKey, it can use for when pass True for Testcase link from Requirement | - | string |
tcEntitykeys | body | no | Comma-separated value of Testcase's entityKey, it can use for when pass False for Testcase link from Requirement | - | string |
isTcSkip | body | no | If you want to skip already linked Testcase's/Requirement's than pass true else false | - | boolean |
Response
Content-Type: application/json
Status Code | Reason | Response Model |
|---|---|---|
200 | TestCases successfully linked to TestSuite | |
400 | Invalid json object or mandatory fields missing | - |
401 | Unauthorised or session expired | - |
500 | Returned when server connection times out | - |
Update Test Case Linked to Test Suite with its Latest Version
POST /rest/testsuites/link/testcaseWithLatestVersion
Request
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
tcRunID | body | yes | Unique identifier of Testcase Run | - | Array[integer] |
syncAll | body | no | Flag to Sync all Testcase Run | - | boolean |
tsRunID | body | yes | Unique identifier of Testsuite Run | - | integer |
username | body | no | Username of the user who is being authenticated | - | string |
password | body | no | Password of the user who being authenticated | - | string |
Response
Content-Type: application/json
Status Code | Reason | Response Model |
|---|---|---|
200 | Linked Testcase of the Testsuite successfully updated to latest available version | |
400 | Invalid json object or mandatory fields missing | - |
401 | Unauthorised or session expired | - |
500 | Returned when server connection times out | - |
Unlink Testcase(s) from Testsuite (Deprecated)
PUT /rest/testsuites/unlink/testcases
Request
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
tcIDs | body | yes | An array of TestcaseId of Test Cases | - | Array[string] |
tsID | body | yes | EntityKey of Test Suites | - | string |
Response
Content-Type: application/json
Status Code | Reason | Response Model |
|---|---|---|
200 | Testcase successfully unlinked to testsuite | |
400 | Invalid json object or mandatory fields missing | - |
401 | Unauthorised or session expired | - |
500 | Returned when server connection times out | - |
Unlink Testcase(s) from Testsuite
PUT /rest/testsuites/doUnlink/TCs
Description
Unlink testcases from TestSuite.
Request
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
tcTsIDs | body | yes | Comma separated string of tcTsIds | - | Array[integer] |
Response
Content-Type: application/json
Status Code | Reason | Response Model |
|---|---|---|
200 | Testcase successfully unlinked to testsuite | |
400 | Invalid json object or mandatory fields missing | - |
401 | Unauthorised or session expired | - |
500 | Returned when server connection times out | - |
List of Platforms Linked to a Test Suite
POST /rest/testsuites/getplatformwithname
Request
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
tsID | body | yes | Id of Testsuite | - | integer |
Response
Content-Type: application/json
Status Code | Reason | Response Model |
|---|---|---|
200 | Successfully get linked platforms from testsuite | |
400 | Invalid json object or mandatory fields missing | - |
401 | Unauthorised or session expired | - |
500 | Returned when server connection times out | - |
Link Platforms to Test Suite
PUT /rest/testsuites/link/platforms
Request
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
qmTsId | body | yes | Id of Test Suites | - | integer |
qmPlatformId | body | yes | Comma-separated value of PlatformId | - | string |
Response
Content-Type: application/json
Status Code | Reason | Response Model |
|---|---|---|
200 | Selected platforms successfully linked to testsuite | |
400 | Invalid json object or mandatory fields missing | - |
401 | Unauthorised or session expired | - |
500 | Returned when server connection times out | - |
Unlink Platforms from Test Suites
PUT /rest/testsuites/unlink/platforms
Request
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
qmTsId | body | yes | Id of Test Suites | - | integer |
platformID | body | yes | Comma-separated value of platformId of Platform | - | string |
Response
Content-Type: application/json
Status Code | Reason | Response Model |
|---|---|---|
200 | Platforms successfully unlinked to testsuite | |
400 | Invalid json object or mandatory fields missing | - |
401 | Unauthorised or session expired | - |
500 | Returned when server connection times out | - |
Assign Platform Owner to Test Suites
PUT /rest/testsuites/assign/platform
Request
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
platformowner | body | yes | OwnerId of selected User | - | integer |
qmAllowBulkEmail | body | no | True for send email to selected user otherwise false | - | boolean |
tsRunIds | body | yes | TestRunId of Test Suites | - | integer |
Response
Content-Type: application/json
Status Code | Reason | Response Model |
|---|---|---|
200 | Successfully assigned owner of platform from testsuites | |
400 | Invalid json object or mandatory fields missing | - |
401 | Unauthorised or session expired | - |
500 | Returned when server connection times out | - |
Assign Tester to Test Case During Execution
PUT /rest/testsuites/assign/tester
Request
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
qmAllowBulkEmail | body | yes | Flag to decide whether an email to the watchers of the Testsuite is to be sent | - | boolean |
qmTsRunId | body | yes | Unique identifier of the Testsuite Run | - | boolean |
tcrIDs | body | yes | Id of Testcase Runs to whom a tester is to be assigned | - | string |
userId | body | yes | Id of user which is to be assigned as tester for the specified Testcase Runs | - | integer |
Response
Content-Type: application/json
Status Code | Reason | Response Model |
|---|---|---|
200 | Tester assigned successfully | |
400 | Invalid json object or mandatory fields missing | - |
401 | Unauthorised or session expired | - |
500 | Returned when server connection times out | - |
Update Run Comments
PUT /rest/execution/updaterun
Description
API to update run comment
Request
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
type | body | yes | Abbreviated entity type | - | string |
fieldVal | body | yes | Value of field | - | string |
isAutoExecuted | body | yes | True if it is to be automatically executed and false if otherwise | - | integer |
entityId | body | yes | Unique identifier of Testcase Run | - | integer |
field | body | yes | Field which is to be updated | - | string |
Response
Content-Type: application/json
Status Code | Reason | Response Model |
|---|---|---|
200 | Run Status updated successfully | |
400 | Invalid json object or mandatory fields missing | - |
401 | Unauthorised or session expired | - |
500 | Returned when server connection times out | - |
Get Test Suite Run IDs
POST /rest/execution/list/platformHome
Description
Find the number of executions of a test suite.
Request
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
tsFolderID | body | no | Testsuite FolderID | - | integer |
tsID | body | no | ID of Testsuite | - | integer |
entityIdsForBulk | body | no | Send true for getting TsRunID for Bulk Operation | - | boolean |
Response
Content-Type: application/json
Status Code | Reason | Response Model |
|---|---|---|
200 | Successfully fetched Testcase Runs | ResponseEntityString |
400 | Invalid json object or mandatory fields missing | - |
401 | Unauthorised or session expired | - |
500 | Returned when server connection times out | - |
Fetch Testcase List
POST /rest/testcases/list/forTS
Description
Testcase list for testsuite.
Request
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
start | body | no | Start index of records | - | integer |
showAllStateEntities | body | no | True to get testcases of approved state only, false to get testcases of any state | - | boolean |
getLinked | body | no | True to get only those testcases that are linked with this defect, false to get all testcases. While using True "tsID" is mandatory | - | boolean |
tsID | body | no | Id of Test Suite | - | integer |
showEntityWithReleaseCycle | body | no | List only those Testcases which have the same associated releases and cycles as the Testsuite | - | boolean |
limit | body | no | Number of records per page | - | integer |
page | body | no | Page number to be displayed | - | integer |
getColumns | body | no | True to get list of all available filters(System + UDF) in 'filterTemplate' field | - | boolean |
udfFilter | body | no | Apply filter on user defined fields' values | - | Array[UdfFilter]
|
filter | body | no | System filters to be applied | - | Array[Filter] |
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 list of Issue available for linking or already linked to Test case Run
POST /rest/execution/issue/list/forTCRun
Request
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
entityId | body | yes | TestcaseRunId | - | string |
getLinked | body | yes | True for get linked testcase otherwise false | - | boolean |
getColumns | body | yes | True for get default filtered column list | - | 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 |
Response
Content-Type: application/json
Status Code | Reason | Response Model |
|---|---|---|
200 | Issues of particular execution shown successfully | |
400 | Invalid json object or mandatory fields missing | - |
401 | Unauthorised or session expired | - |
500 | Returned when server connection times out | - |
Get list of issue available for linking or already linked to Test case Step Run
POST /rest/execution/issue/list/forTCStepRun
Request
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
entityId | body | yes | TestcaseStepRunId | - | string |
getLinked | body | yes | True for get linked testcase otherwise false | - | boolean |
getColumns | body | yes | True for get default filtered column list | - | 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 |
Response
Content-Type: application/json
Status Code | Reason | Response Model |
|---|---|---|
200 | Issues of particular execution shown successfully | |
400 | Invalid json object or mandatory fields missing | - |
401 | Unauthorised or session expired | - |
500 | Returned when server connection times out | - |
Get list of Testcase Step Run for a Test Case execution along with dynamic columns
POST /rest/execution/tcStepRun/list/viewColumns
Request
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
tcrID | body | yes | Unique identifier of Testcase Run whose Testcase Step Runs are to be fetched | - | integer |
viewId | body | yes | View ID of the user for that particular project and Testcase Step Run module | - | 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 |
Response
Content-Type: application/json
Status Code | Reason | Response Model |
|---|---|---|
200 | List of Testcase Step Runs fetched successfully | |
400 | Invalid json object or mandatory fields missing | - |
401 | Unauthorised or session expired | - |
500 | Returned when server connection times out | - |
Link Issues to Test Case During Execution
PUT /rest/execution/link/issue
Description
API to link issues to the testcase being executed
Request
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
issueIds | body | yes | ID of issues to be linked to Testcase Run | - | Array[string] |
tcrId | body | yes | ID of Testcase Run to link issues with | - | integer |
Response
Content-Type: application/json
Status Code | Reason | Response Model |
|---|---|---|
200 | Issues successfully linked to execution | |
400 | Invalid json object or mandatory fields missing | - |
401 | Unauthorised or session expired | - |
500 | Returned when server connection times out | - |
Unlink Issues from Test Case During Execution
POST /rest/execution/unlink/issue
Description
API to unlink issues from the Testcase Run being executed
Request
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
issueIds | body | yes | Ids of Issues to be unlinked | - | Array[string] |
tcrId | body | yes | Id of Testcase Run to unlink issues from | - | integer |
Response
Content-Type: application/json
Status Code | Reason | Response Model |
|---|---|---|
200 | Issues successfully unlinked from Testcase Run | |
400 | Invalid json object or mandatory fields missing | - |
401 | Unauthorised or session expired | - |
500 | Returned when server connection times out | - |
Link Issues to Test Case Step During Execution
PUT /rest/execution/link/issueWithTCStepRun
Description
API to link issues to the testcase step run being executed
Request
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
issueIds | body | yes | Ids of issues to link | - | Array[string] |
tcsrId | body | yes | Id of Testcase Step to link issues with | - | integer |
Response
Content-Type: application/json
Status Code | Reason | Response Model |
|---|---|---|
200 | Issues successfully linked to execution | |
400 | Invalid json object or mandatory fields missing | - |
401 | Unauthorised or session expired | - |
500 | Returned when server connection times out | - |
Unlink Issues from Test Case Step During Execution
POST /rest/execution/unlink/issueWithTCStepRun
Description
API to un-link issues from the test case step during its execution
Request
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
issueIds | body | yes | Ids of issues to unlink | - | string |
tcsrId | body | yes | Id of Testcase Step to unlink issues from | - | integer |
Response
Content-Type: application/json
Status Code | Reason | Response Model |
|---|---|---|
200 | Issues successfully unlinked from execution | |
400 | Invalid json object or mandatory fields missing | - |
401 | Unauthorised or session expired | - |
500 | Returned when server connection times out | - |
Display Issues linked to Test Case During Execution
POST /rest/issues/getIssuesForTestCase
Description
API to display issues linked to test cases during its execution.
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 |
linkedAsset | body | yes | LinkedAsset Type=DF, ID= {respective DefectId} | - | LinkedAsset |
Response
Content-Type: application/json
Status Code | Reason | Response Model |
|---|---|---|
200 | List of issues shown successfully | |
400 | Invalid json object or mandatory fields missing | - |
401 | Unauthorised or session expired | - |
500 | Returned when server connection times out | - |
Bulk Update Run Status
PUT /rest/execution/runstatus/bulkupdate
Description
API to bulk update run status
Request
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
runStatusID | body | yes | Id of the execution status to set(Id can be obtained from getInfo service response) | - | integer |
dropID | body | no | Unique identifier of drop on which execution is to be performed | - | integer |
qmTsRunId | body | yes | Id of Testsuite Run to execute | - | string |
entityIDs | body | yes | Ids of Testcase Runs to execute | - | string |
entityType | body | yes | Type of Entity('TCR'/'TCSR') to Execute | - | string |
isAutoExecuted | body | no | 0 Manual 1 Automated | 0 | boolean |
username | body | no | Username of the user who is being authenticated | - | string |
password | body | no | Password of the user who is being authenticated | - | string |
Response
Content-Type: application/json
Status Code | Reason | Response Model |
|---|---|---|
200 | Execution performed successfully | ResponseEntityString |
400 | Invalid json object or mandatory fields missing | - |
401 | Unauthorised or session expired | - |
500 | Returned when server connection times out | - |
Reset Execution Status on Build Update
PUT /rest/execution/resetstatus
Description
API to reset execution status after changing build.
Request
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
qmTsRunId | body | yes | Testsuite Run Id | - | string |
dropID | body | yes | buildId on which testcases and testcase steps are to be executed | - | string |
isBulkStausSetNotNotRun | body | yes | send true to reset status to 'Not Run' | - | boolean |
username | body | no | Username of the user who is being authenticated | - | string |
password | body | no | Passwird of the user who is being authenticated | - | string |
Response
Content-Type: application/json
Status Code | Reason | Response Model |
|---|---|---|
200 | Execution status reset successfully. | ResponseEntityString |
400 | Invalid json object or mandatory fields missing | - |
401 | Unauthorised or session expired | - |
500 | Returned when server connection times out | - |
Schedule Test Execution using Scheduler
POST /rest/testsuites/linkplatform/assignagent/createSchedulerRun
Description
API to create scheduler run
Request
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
agentParam | body | yes | provide agentParam | - |
Response
Content-Type: application/json
Status Code | Reason | Response Model |
|---|---|---|
200 | Agent scheduled successfully. | |
400 | Invalid json object or mandatory fields missing | - |
401 | Unauthorised or session expired | - |
500 | Returned when server connection times out | - |
List Test Execution Run
Get List of Test Run under execution.
POST /rest/execution/list/viewColumns
Request
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
tsrunID | body | yes | Unique identifier of Test Execution Run | - | integer |
viewId | body | yes | View ID of the user for that particular project and Test Execution Run module | - | 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 |
Response
Content-Type: application/json
Status Code | Reason | Response Model |
|---|---|---|
200 | successful operation | ResponseEntityString |
Definitions
AgentParam
name | type | required | description | example |
|---|---|---|---|---|
testSuiteId | string | optional | - | |
pluginAgentId | string | optional | - | |
platformId | string | optional | - | |
tsRunId | string | optional | - | |
dropID | string | optional | - | |
scheduledate | string | optional | - | |
scheduletime | string | optional | - |
Data
name | type | required | description | example |
|---|---|---|---|---|
tsId | integer | required | Id of Test Suites | |
buildID | integer | required | Id of Cycle | |
releaseId | integer | required | Id of Release |
Filter
name | type | required | description | example |
|---|---|---|---|---|
value | object | required | Value to search based on type of filter | |
comparison | string | required | The comparison operator 'lt' or 'gt' for Date type filter | |
type | string | required | Type of Filter | |
field | string | required | Field name on which filter is to be applied |
ResponseEntity
name | type | required | description | example |
|---|---|---|---|---|
headers | object | optional | - | |
body | object | optional | - | |
statusCode | string | optional | - |
LinkedAsset
name | type | required | description | example |
|---|---|---|---|---|
id | integer | required | Unique identifier of asset whose linked entities are to be fetched | 3778 |
type | string | required | Abbreviated Entityname | DF/RQ/TC/TS |
TestSuiteReleaseCycleMap
name | type | required | description | example |
|---|---|---|---|---|
tsId | integer | required | Unique identifier of Testsuite whose execution is to be created | |
releaseId | integer | required | Id of release to create Test execution in | |
cycleId | integer | required | Id of cycle to create Test execution in |
TsFolderArchiveRequestDetail
name | type | required | description | example |
|---|---|---|---|---|
tsFolderIDs | array[integer] | required | Array of Test Suite Folder Ids | |
isBulkOperation | boolean | optional | IsBulkOpeartion Flag | |
includeRootFolderEntities | boolean | optional | Required to include Root Folder Entities |
TsFolderUnarchiveRequestDetail
name | type | required | description | example |
|---|---|---|---|---|
tsFolderIDs | array[integer] | required | Array of Test Suite Folder Ids | |
isBulkOperation | boolean | optional | IsBulkOpeartion flag | |
includeRootFolderEntities | boolean | optional | Required to include Root Folder Entities |
UdfFilter
name | type | required | description | example |
|---|---|---|---|---|
type | string | required | Type of Filter | |
value | string | required | Value to search based on type of UDF | |
udfmID | integer | required | Unique Identifier based on project-module-udf-user | |
field | string | required | Name of User Defined Field |
ResponseEntityString
name | type | required | description | example |
|---|---|---|---|---|
headers | object | optional | - | |
body | string | optional | - | |
statusCode | string | optional | - | |
statusCodeValue | integer | optional | - |
|
Related content
Back to QMetry All Products Help Page