API changes from v8.5.4 to v8.6

With the new and upcoming releases of QMetry, we continue to add exciting and useful new features that improve usability. With the new features and improvements being added to QMetry also necessitates changes in the APIs. This page enlists such APIs that will be changed from version 8.5.4 to 8.6 that is scheduled at the end of Feb 2020. The purpose of this document is to help Integration Teams keep their code updated and current with the API changes/updates to the existing APIs. In case you do not use any of these APIs, these changes can be safely ignored.


Summarized API changes

API NameREST URLMethodBackward compatibility with 8.5.4Request Change

Response Change

Get Details of a Requirement

/rest/requirements/list

POST

Yes

No

Yes

Fetch Requirement List For Issue

/rest/requirements/list/forIS

POST

Yes

No

Yes

Get List of Users

/rest/admin/user/list

POST

Yes

No

Yes

Get List of Testcases in Folder

/rest/testcases/list

POST

Yes

No

Yes

Get Info Services

/rest/admin/project/getinfoGETYesNoYes
Bulk Update Run Status/rest/execution/runstatus/bulkupdatePUTYesYesNo
Update Test Case linked to Test Suites with latest version/rest/testsuites/link/testcaseWithLatestVersionPOSTYesYesNo
Reset execution status on bulk update/rest/execution/resetstatusPUTYesYesNo
Get list of all projects/rest/admin/project/listPOSTYesNoYes
Get list of all releases in a project/rest/admin/release/listPOSTNoNo Yes
Copy a Test Suite/rest/testsuites/copyPUTYesYesNo
Get list of Test Suites for a Test Case/rest/testsuites/list/forTCPOSTNoNoYes
Link Requirement(s) with Test Case/rest/testcases/link/requirementPUTYesYesNo

Link Test Case(s) to Requirement

/rest/requirements/link/testcasesPUTYesYesNo
Link Test Suite(s) to Test Case/rest/testcases/link/testsuitesPUTYesYesNo
Link Test Case(s) to Test Suite/rest/testsuites/dolink/TCsPUTYesYesNo

Common Request Body Changes in below APIs 

Get Requirement list along with Custom Fields/rest/requirements/list/viewColumnsPOSTYesYesNo
Get Test Case List along with Custom Fields/rest/testcases/list/viewColumnsPOSTYesYesNo
Get Test Suite List along with Fields/rest/testsuites/list/viewColumnsPOSTYesYesNo
List Test Execution Run/rest/execution/list/viewColumnsPOSTYesYesNo
Get Issue list along with Custom Fields (Only for projects that are not integrated with Jira)/rest/issues/list/viewColumnsPOSTYesYesNo
Get Test case linked to a Requirement/rest/testcases/list/forRQPOSTYesYesNo
Get List of Issues for a Requirement/rest/issues/list/ForRQPOSTYesYesNo
Fetch Requirement List For Test Case/rest/requirements/list/forTCPOSTYesYesNo
Get List of Test suites for a Testcase/rest/testsuites/list/forTCPOSTYesYesNo
Get List of Requirements while Linking to a Test suite/rest/requirements/list/forTSPOSTYesYesNo
Get Test case linked to a TestSuite/rest/testcases/list/forTSPOSTYesYesNo
Get list of issue available for linking or already linked to Test case Step Run/rest/execution/issue/list/forTCStepRunPOSTYesYesNo
Get list of Issue available for linking or already linked to Test case Run/rest/execution/issue/list/forTCRunPOSTYesYesNo
Fetch Requirement List For Issue/rest/requirements/list/forISPOSTYesYesNo
Search Requirement/Test Case/Test Suite/Issue/rest/searchPOSTYesYesNo

Updated APIs

Get Details of a Requirement

API/rest/requirements/list
MethodPOST
Impact of changeLow
Backward CompatibilityYes
Reason for changeFor requirements imported from Jira, API fetches comments with new parameter showExtComments . Also, QMetry specfic attachments are identified using parameter showQmetryAttachments. Internal fixes in the formatting for "extUdfFields" while fetching comma separated UDF values from Jira.
ChangesAdded showExtComments and showQmetryAttachments in the response body; also, the response format of "extUdfFields" is updated.
Version 8.5.4Version 8.6
Response Body
{
	"data": [{
		"statusId": 5293,
		"rqBuildMapID": 0,
		"plannerFlag": false,
		"rqId": 459019,
		"entityKey": "BD-RQ-252",
		"archivedTcTotal": 0,
		"unarchivedTcTotal": 0,
		"projectId": 775,
		"linkedTcCount": 0,
		"linkedDfCount": 0,
		"dtKey": "FIT-17",
		"name": "Do multiple ATM transactions",
		"rqVersion": 1,
		"attachmentCount": 1,
		"createdDate": "11-06-2019 02:47:44",
		"isVersionArchived": false,
		"createdSystem": "JIRA",
		"updatedDate": "11-13-2019 18:31:25",
		"updatedBy": 216,
		"updatedByAlias": "jatin (jatin)",
		"createdByAlias": "jatin (jatin)",
		"parentFolderId": 3292,
		"folderPath": "/Shape Up/Imported from Jira",
		"rqVersionID": 562594,
		"rqVersionList": "[{\"isArchived\":0,\"rqVersion\":1,\"rqVersionID\":562594,
\"rqVersionName\":\"Version-1\"}]",
		"releaseName": "Release 2",
		"projectName": "Shape Up",
		"isArchived": false,
		"externalFields": "[{\"name\":\"Key\", \"isDisplay\":true, \"type\":\"text\",\"value\":\"FIT-17\" },
{\"name\":\"Description\",\"isDisplay\":true,
\"type\":\"LARGETEXT\",\"value\": \"\"}]",
		"trackerUrl": "https://qmetry.atlassian.net",
		"buildName": "Build 2.2",
		"extUdfFields": "[{\"name\":\"Sprint\",\"type\":\"array\",
\"value\":\"FIT Sprint 2\",\"isDisplay\":true}]",
		"isCurrentlyConfiguredProject": false,
		"totalWatchers": 1,
		"isCurrentUserWatcher": false
	}],
	"total": 1,
	"buildId": 1729,
	"cycleId": 2700,
	"UDFTypeData": {
		"Cost": "STRING",
		"Edition": "LOOKUPLIST",
		"Shapeupsprint": "LOOKUPLIST",
		"Component_Field": "MULTILOOKUPLIST"
	}
}
Response Body
{
	"data": [{
		"statusId": 5293,
		"rqBuildMapID": 0,
		"plannerFlag": false,
		"rqId": 459019,
		"entityKey": "BD-RQ-252",
		"archivedTcTotal": 0,
		"unarchivedTcTotal": 0,
		"projectId": 775,
		"linkedTcCount": 0,
		"linkedDfCount": 0,
		"dtKey": "FIT-17",
		"name": "Do multiple ATM transactions",
		"rqVersion": 1,
		"attachmentCount": 1,
		"createdDate": "11-06-2019 02:47:44",
		"isVersionArchived": false,
		"createdSystem": "JIRA",
		"updatedDate": "11-13-2019 18:31:25",
		"updatedBy": 216,
		"updatedByAlias": "jatin (jatin)",
		"createdByAlias": "jatin (jatin)",
		"parentFolderId": 3292,
		"folderPath": "/Shape Up/Imported from Jira",
		"rqVersionID": 562594,
		"rqVersionList": "[{\"isArchived\":0,\"rqVersion\":1,\"rqVersionID\":562594,
\"rqVersionName\":\"Version-1\"}]",
		"releaseName": "Release 2",
		"projectName": "Shape Up",
		"isArchived": false,
		"externalFields": "[{\"name\":\"Key\", \"isDisplay\":true,
\"type\":\"text\",\"value\":\"FIT-17\" },
{\"name\":\"Description\",\"isDisplay\":true,  \"type\":\"LARGETEXT\",\"value\": \"\"}]",
		"trackerUrl": "https://qmetry.atlassian.net",
		"showExtComments": true,
		"showQmetryAttachments": true,
		"buildName": "Build 2.2",
        "extUdfFields": "[{\"FieldID\":\"customfield_10104\",\"type\":\"array\",
\"name\":\"Sprint\",
\"FieldValue\":\"\"}...]",
		"isCurrentlyConfiguredProject": false,
		"totalWatchers": 1,
		"isCurrentUserWatcher": false
	}],
	"total": 1,
	"buildId": 1729,
	"cycleId": 2700,
	"UDFTypeData": {
		"Cost": "STRING",
		"Edition": "LOOKUPLIST",
		"Shapeupsprint": "LOOKUPLIST",
		"Component_Field": "MULTILOOKUPLIST"
	}
}

Fetch Requirement List For Issue

API/rest/requirements/list/forIS
MethodPOST
Impact of changeLow
Backward CompatibilityYes
Reason for changeWith v8.5.6, issues module will be enabled for Jira integrated projects as well. This existing API which displays requirements linked to the issue, will also fetch the external Jira keys of linked requirements that are imported from Jira.
Changes

Added externalKey parameter in response.

Version 8.5.4Version 8.6
Response Body
{
	"data": [{
		"priority": 223620,
		"priorityAlias": "Blocker",
		"projectID": 1708,
		"rqID": 146762,
		"entityKey": "LD-RQ-1",
		"latestUnarchivedVersion": 1,
		"latestVersion": 1,
		"rqVersionID": 244810,
		"rqVersion": 1,
		"cycleNameList": "Cycle 2,Cycle 3,Cycle 4,Default Cycle",
		"releaseNameList": "Release Q1,Release Q2,Release Q3",
		"name": "Login DP (Requirement)",
		"description": "Testing Data Parameterization module",
		"attachmentCount": 1,
		"ownerId": 1723,
		"isArchived": false,
		"isVersionArchived": false,
		"projectName": "Login DataParameterization",
		"requirementStateAlias": "Open",
		"createdByAlias": "afjal"
	}],
	"total": 1
}
Response Body
{
	"data": [{
		"priority": 223620,
		"priorityAlias": "Blocker",
		"projectID": 1708,
		"rqID": 146762,
		"entityKey": "LD-RQ-1",
		"externalKey": "CC-6",
		"latestUnarchivedVersion": 1,
		"latestVersion": 1,
		"rqVersionID": 244810,
		"rqVersion": 1,
		"cycleNameList": "Cycle 2,Cycle 3,Cycle 4,Default Cycle",
		"releaseNameList": "Release Q1,Release Q2,Release Q3",
		"name": "Login DP (Requirement)",
		"attachmentCount": 1,
		"ownerId": 1723,
		"isArchived": false,
		"isVersionArchived": false,
		"projectName": "Login DataParameterization",
		"requirementStateAlias": "Open",
		"createdByAlias": "afjal",
		"trackerUrl": "https://yourjira.qmetry.com"
	}],
	"total": 1
}


Get List of Users

API/rest/admin/user/list
MethodPOST
Impact of changeLow
Backward CompatibilityYes
Reason for changeAdded "isDeleted" parameter in the response for internal feature to identify and keep track of changes by users that were deleted.
Changes

Added isDeleted parameter in the response.

Version 8.5.4Version 8.6
Response Body
{
	"userID": 3566,
	"loginId": "Jane",
	"userAlias": "Jane",
	"firstName": "Jane",
	"lastName": "Doe",
	"email": "jane.doe@qmetry.com",
	"isActive": true,
	"authType": "QMETRY",
	"userType": 1,
	"isSysAdmin": false
}
Response Body
{
	"userID": 3566,
	"loginId": "Jane",
	"userAlias": "Jane",
	"firstName": "Jane",
	"lastName": "Doe",
	"email": "jane.doe@qmetry.com",
	"isActive": true,
	"authType": "QMETRY",
	"userType": 1,
	"isSysAdmin": false,
	"isDeleted": false
}

Get List of Testcases in Folder

API/rest/testcases/list
MethodPOST
Impact of changeLow
Backward CompatibilityYes
Reason for changeAdded "isParameterized" flag to identify the test cases that have data parameters added in steps.
Changes

Added isParameterized flag in the response

Version 8.5.4Version 8.6
Response Body
{
	"data": [{
		"isVersionArchived": false,
		"isShared": false,
		"associatedCycles": "Default Cycle",
		"state": 1,
		"releaseNameDetail": "Release Q1",
		"cycleNameDetail": "Default Cycle",
		"cycleIdsAsVersion": "7645",
		"releaseIdsAsVersion": "4085",
		"tcrCount": 0,
		"associatedVersion": 1,
		"tcID": 1005825,
		"paramIdList": "[849, 706]",
		"entityKey": "LD-TC-8",
		"projectId": 1708,
		"projectName": "Login DataParameterization",
		"summary": "Calculate Distance",
		"tcVersion": 1,
		"createdDate": "12-30-2019 07:19:11 PM",
		"updatedDate": "12-31-2019 01:17:28 AM",
		"description": "",
		"updatedBy": "QMetry",
		"updatedByAlias": "admin (admin)",
		"createdBy": "Karthik",
		"createdByAlias": "Karthik (karthik1)",
		"designerAlias": "",
		"testingType": 223627,
		"testingTypeAlias": "Manual",
		"testCaseType": 223634,
		"testCaseTypeAlias": "Functional",
		"testCaseState": 223626,
		"testCaseStateAlias": "Open",
		"testCaseStateLabel": "Open",
		"priority": 223621,
		"priorityAlias": "Critical",
		"tcFolderID": 137781,
		"folderPath": "/Login DataParameterization/Moved",
		"tcVersionID": 1632193,
		"testScriptName": "",
		"ownerAlias": "",
		"modifiedReasonAlias": "",
		"executionMinutes": "",
		"preCondition": "",
		"postCondition": "",
		"isLatestVersion": true,
		"currentTcVersion": 1,
		"isArchived": false,
		"attachmentCount": 0,
		"statusId": 11704,
		"isChild": false,
		"component": "[423282]",
		"componentAlias": "Lab Test",
		"componentAlias_search": "Lab Test",
		"totalWatchers": 1,
		"isCurrentUserWatcher": false,
		"isCreatedByActive": true
	}],
	"total": 1,
	"buildId": 4085,
	"cycleId": 7645,
	"UDFTypeData": {}
}
Response Body
{
 "data": [
  {
   "isVersionArchived": false,
   "isShared": false,
   "associatedCycles": "Default Cycle",
   "state": 1,
   "releaseNameDetail": "Release Q1",
   "cycleNameDetail": "Default Cycle",
   "cycleIdsAsVersion": "7645",
   "releaseIdsAsVersion": "4085",
   "tcrCount": 0,
   "associatedVersion": 1,
   "tcID": 1005825,
   "paramIdList": "[849, 706]",
   "entityKey": "LD-TC-8",
   "projectId": 1708,
   "projectName": "Login DataParameterization",
   "summary": "Calculate Distance",
   "tcVersion": 1,
   "createdDate": "12-30-2019 07:19:11 PM",
   "description": "",
   "updatedBy": "QMetry",
   "updatedByAlias": "admin (admin)",
   "createdBy": "Karthik",
   "createdByAlias": "Karthik(Karthik1)",
   "designerAlias": "",
   "testingType": 223627,
   "testingTypeAlias": "Manual",
   "testCaseTypeAlias": "Functional",
   "testCaseStateAlias": "Open",
   "testCaseStateLabel": "Open",
   "priorityAlias": "Critical",
   "tcFolderID": 137781,
   "folderPath": "/Login DataParameterization/Moved",
   "tcVersionID": 1632193,
   "testScriptName": "",
   "ownerAlias": "",
   "modifiedReasonAlias": "",
   "executionMinutes": "",
   "preCondition": "",
   "postCondition": "",
   "isLatestVersion": true,
   "currentTcVersion": 1,
   "isArchived": false,
   "attachmentCount": 0,
   "statusId": 11704,
   "isChild": false,
   "component": "[423282]",
   "componentAlias": "Lab Test",
   "componentAlias_search": "Lab Test",
   "totalWatchers": 1,
   "isCurrentUserWatcher": false,
   "isCreatedByActive": true,
   "isParameterized": true
  }
 ],
 "total": 1,
 "buildId": 4085,
 "cycleId": 7645,
 "UDFTypeData": {}
}

Get Info Service

API/rest/admin/project/getinfo
MethodGET
Impact of changeLow
Backward CompatibilityYes
Reason for changeAdded "isPartLevelComplianceEnabled" boolean parameter in API response. This parameter checks and returns the status of Part 11 Compliance setting for the project under eSignatures > Approval Access. (Settings require eSignature package enabled).
Changes

Added isPartLevelComplianceEnabled flag in the response.

Version 8.5.4Version 8.6
Response Body
{...
    "maxAttachmentSize": 10,
    "agentUrl": "https://s3.amazonaws.com/qprof-automationagent/qmetryagent/QMetryAgent_8.5.6.zip",
    "isTestingTypeVisible": true,
    "clientCode": "ABC123",
    "isMatrixViewEnabled": true,
    "isPlatformScopeFeatureEnabled": true,
    "isSyncAcrossDomainEnabled": false,
    "isTestDataEnabled": false,
    "isTestCaseApprover": true,
    "isTestSuiteApprover": true,
    "isApprovalWorkflowEnabled": true,
    "userType": 1,
    "defaultPlatformId": 259,
    "isSaasEnabled": false,
    "timeFormat": 12,
    "dateTimeFormatID": 1,
    "matrixPlatformCount": 20,
    "testSuiteTescaseCount": 50,
...}
Response Body
{...
    "maxAttachmentSize": 10,
    "agentUrl": "https://s3.amazonaws.com/qprof-automationagent/qmetryagent/QMetryAgent_8.5.6.zip",
    "isTestingTypeVisible": true,
    "clientCode": "ABC123",
    "isMatrixViewEnabled": true,
    "isPlatformScopeFeatureEnabled": true,
    "isSyncAcrossDomainEnabled": false,
    "isTestDataEnabled": false,
    "isTestCaseApprover": true,
    "isTestSuiteApprover": true,
    "isApprovalWorkflowEnabled": true,
    "isPartLevelComplianceEnabled": false,
    "userType": 1,
    "defaultPlatformId": 259,
    "isSaasEnabled": false,
    "timeFormat": 12,
    "dateTimeFormatID": 1,
    "matrixPlatformCount": 20,
    "testSuiteTescaseCount": 50,
...}

Bulk Update Run Status

API/rest/execution/runstatus/bulkupdate
MethodPUT
Impact of changeLow
Backward CompatibilityYes
Reason for change
  • Added "isPartLevelComplianceEnabled" boolean parameter in API response. This parameter checks and returns the status of Part 11 Compliance setting for the project under eSignatures > Approval Access. (Settings require eSignature package enabled). New parameters "username" and "password" in request and response for authentication and to update the the Execution Status.
  • To manually specify an execution type during a test case execution, pass "isAutoExecuted" parameter in request with Boolean value 0 (zero) or 1 (one). It means "false" or "true" respectively. Value = 0 means "Manual" and 1 means "Automated".
Changes
  • Added isAutoExecuted flag in request.
  • Added  username and password parameter in request and response (for Part 11 Compliance enabled projects).
Version 8.5.4Version 8.6
Request Body
{
 "entityIDs": "3188290",
 "entityType": "TCR",
 "qmTsRunId": "272389",
 "runStatusID": 4171,
 "dropID": 0,
 "qmRunObj": ""
}
Response Body
{
    "success": true,
    "code": "CO.UPDATE_RUNSTATUS_SUCCESS",
    "message": "Test Case(s) status was updated.",
    "data": [{
        "entityIDs": 114563,
        "entityType": "TCR",
        "qmTsRunId": "10043",
        "runStatusID": 718,
        "type": "TCR",
        "qmRunObj": "Mac_string:test",
        "dropID": "",
        "lastExecuted": "01-02-2020 09:13:16 PM",
        "tcrStatus": "718",
        "tcrStatusAlias": "Passed",
        "executedBy": "admin"
    }]
}
Request Body
{
 "entityIDs": "1262,1275,1283,1291",
 "entityType": "TCR",
 "qmTsRunId": "295",
 "runStatusID": 301,
 "dropID": 0,
 "qmRunObj": "",
 "isAutoExecuted": 1,
 "username": "admin",
 "password": "password123#"
}
Response Body
{
    "success": true,
    "code": "CO.UPDATE_RUNSTATUS_SUCCESS",
    "message": "Test Case(s) status was updated.",
    "data": [{
        "entityIDs": 114563,
        "entityType": "TCR",
        "qmTsRunId": "10043",
        "runStatusID": 718,
        "username": "admin",
        "password": "password123#",
        "type": "TCR",
        "qmRunObj": "Mac_string:test",
        "dropID": "",
        "lastExecuted": "01-02-2020 09:13:16 PM",
        "tcrStatus": "718",
        "tcrStatusAlias": "Passed",
        "executedBy": "admin"
    }]
}

Update Test Case linked to Test Suites with its Latest Version

API/rest/testsuites/link/testcaseWithLatestVersion
MethodPOST
Impact of changeLow
Backward CompatibilityYes
Reason for changeAdded "isPartLevelComplianceEnabled" boolean parameter in API request. This parameter checks and returns the status of Part 11 Compliance setting for the project under eSignatures > Approval Access. (Settings require eSignature package enabled). New parameters "username" and "password" parameter in request to authentication and to update the the Execution Status.
Changes

Added  username and password parameter in request.

Version 8.5.4Version 8.6
Request Body
{
	"tcRunIDs": 1278
}
Request Body
{
	"tcRunIDs": 283,
	"username": "admin",
	"password": "password123#"
}

Reset execution status on bulk update

API/rest/execution/resetstatus
MethodPUT
Impact of changeLow
Backward CompatibilityYes
Reason for changeWhenever user wants to change the execution type at that time user has to pass field name as "isAutoExecuted" and in entityID user has to pass ID's list as mentioned in the comment.
There is no change for old request body because in request "isAutoExecuted" flag was there but we were not using it.
Right now by updating this flag value user can set Execution type at TCR level.
Changes

Added isAutoExecuted flag in request

Version 8.5.4Version 8.6
Request Body
{
	"entityId": 3188290,
	"field": "comment",
	"fieldVal": "This is a test comment",
	"isAutoExecuted": 0,
	"type": "TCR",
	"qmRunObj": "",
	"dropID": ""
}
Request Body
#For Comment Field
{
	"entityId": 759189,
	"field": "comment",
	"fieldVal": "This is a test comment",
	"type": "TCR",
	"qmRunObj": "",
	"dropID": ""
}
#For Execution Type Field
{
	"field": "isAutoExecuted",
	"fieldVal": "0",
	"isAutoExecuted": "0",
	"entityId": [759189],
	"type": "TCR",
	"dropID": 0,
	"qmRunObj": ""
}

Get List of all Projects

API
/rest/admin/project/list
MethodPOST
Impact of changeMinor
Backward CompatibilityYes
Reason for change
To identify if the project has Part Level Compliance enabled under eSignatures > Approval Access. (Settings require eSignature package enabled).
Changes

Added isPartLevelComplianceEnabled flag in the response.

Version 8.5.4Version 8.6
Request Body
{
	"data": [{
		"projectID": 265,
		"name": "Internal Issue",
		"isArchived": false,
		"projectKey": "IIC",
		"isLocked": false,
		"userDefault": false,
		"isRichText": false,
		"isAutoAddValue": true,
		"isSyncTCMailSend": false,
	}
}
Request Body
{
	"data": [{
		"projectID": 265,
		"name": "Internal Issue",
		"isArchived": false,
		"projectKey": "IIC",
		"isLocked": false,
		"userDefault": false,
		"isRichText": false,
		"isAutoAddValue": true,
		"isSyncTCMailSend": false,
		"isPartLevelComplianceEnabled": false
	}
}

Get List of all Releases

API
/rest/admin/release/list
MethodPOST
Impact of changeMajor
Backward CompatibilityNo
Reason for changeAPI changed to optimize performance.
ChangesRemoved "isNonDeletable" from response.
Version 8.5.4Version 8.6
Response Body
{
  "total": 1,
  "data": [
    {
      "projectID": 185,
      "createdDate": "03-19-2018 07:00:00 PM",
      "releaseID": 1098,
      "name": "Default Release",
      "description": "release description",
      "NoofCycles": 1,
      "isArchived": false,
      "Associatedproject": "Demo",
      "isLocked": false,
      "isDefault": 1,
      "isNonDeletable": false
    }
  ]
}
Response Body
{
	"data": [
		{
			"projectID": 185,
			"createdDate": "02-20-2020 03:06:20",
			"releaseID": 1098,
			"name": "Default Release",
			"description": "release description",
			"NoofCycles": 1,
			"isArchived": false,
			"Associatedproject": "Demo",
			"isLocked": false,
			"isDefault": 1
		}
	],
	"total": 1
}

Copy a Test Suite

API/rest/testsuites/copy
MethodPUT
Impact of changeLow
Backward CompatibilityYes
Reason for change

With introduction to the ability to copy Test Suite with the more options like below several new parameters are introduced in the API request.

  • optionally copy platforms
  • copy platforms with selected Execution Status
  • optionally copy release cycle
  • copy/sync latest version of linked test case
  • optionally reset executions to Not Run
  • optionally remove the assigned user, new flags below have been introduced in the request body.
Changes

New parameter flags

  • isPlatformCopy
  • isPlatformCopyWithSelctedStatus
  • executionStatusIds
  • executionStatusIds
  • isReleaseCycleCopy
  • isLatestVersionSync
  • isResetToNotrun
  • isResetAssignee


Version 8.5.4Version 8.6
Request Body
{
	"srcFolderId": 1097,
	"destFolderId": 1097,
	"id": "193755"
}
Request Body
{
	"srcFolderId": 169,
	"destFolderId": 184,
	"id": "855",
	"isPlatformCopy": true,
	"executionStatusIds": [515, 514, 519, 516, 518],
	"isReleaseCycleCopy": true,
	"isLatestVersionSync": true,
	"isPlatformCopyWithSelctedStatus": true,
	"isResetToNotrun": true,
	"isResetAssignee": false
}

Get list of Test Suites to be linked in a Test Case

API/rest/testsuites/list/forTC
MethodPOST
Impact of changeLow
Backward CompatibilityNo
Reason for changeMultiple boolean flags are added in the response in regards to the confirmation message validation check for release, cycle or archived platforms in test suites
ChangesAdded the following boolean flags in the response:
  • isCycleArchived
  • isReleaseArchived
  • isAnyPlatRelCycArchived
Version 8.5.4Version 8.6
Response Body
{
	"tsID": 193754,
	"projectID": 578,
	"entityKey": "PLA-TS-27",
	"tsFolderID": 1097,
	"name": "iMobile Pay Suite",
	"linkedTcCount": 2,
	"linkedPlatform": 1,
	"platform": "Android,Firefox,Google Chrome,Internet Explorer,Safari",
	"attachmentCount": 0,
	"releaseNameList": "Pro,Macro",
	"cycleNameList": "Pro Q1-20,Alpha Macro",
	"createdDate": "02-21-2020 22:16:54",
	"createdBy": "John",
	"createdByAlias": "john",
	"isPlatformArchived": false,
	"isArchived": false,
	"canLink": true
}
Response Body
{
	"tsID": 5145,
	"projectID": 74,
	"entityKey": "FIT-TS-14",
	"tsFolderID": 169,
	"name": "iMobile Pay Suite",
	"linkedTcCount": 36,
	"linkedPlatform": 5,
	"platform": "Android,Firefox,Google Chrome,Internet Explorer,Safari",
	"attachmentCount": 0,
	"releaseNameList": "Pro,Macro",
	"cycleNameList": "Pro Q1-20,Alpha Macro",
	"createdDate": "27-02-2020 05:23:00 PM",
	"createdBy": "Jane",
	"createdByAlias": "jane",
	"ownerAlias": "jane",
	"testSuiteState": 9751,
	"testSuiteStateAlias": "In Progress",
	"isCycleArchived": true,
	"isReleaseArchived": true,
	"isPlatformArchived": false,
	"isArchived": false,
	"canLink": false,
	"isAnyPlatRelCycArchived": true
}

Link Requirement(s) to Test Case

API/rest/testcases/link/requirement
MethodPUT
Impact of changeLow
Backward CompatibilityYes
Reason for changeWith introduction feature to be able to link Requirement(s) to a Test Case using the Requirement Entity Key directly, with the Version 8.6, a new parameter is introduced to pass the requirement(s) key as comma separated values through Rest API.
ChangesAbility to use the option "rqEntitykeys" in the request to specify one or more requirement key.
Version 8.5.4Version 8.6
Request Body
{
	"tcID": "PLA-TC-42",
	"tcVersionId": 1626274,
	"rqVersionIds": "546473,546472"
}
Request Body
{
	"tcID": "FIT-TC-8",
	"tcVersionId": 203819,
	"rqEntitykeys": "FIT-RQ-1,FIT-RQ-2"
}

Link Test Case(s) to Requirement

API/rest/requirements/link/testcases
MethodPUT
Impact of changeLow
Backward CompatibilityYes
Reason for changeWith introduction of feature to be able to link Test Case(s) to a Requirement using the Test Case's Entity Key directly, with the Version 8.6, an option is introduced to pass the test case(s) key as comma separated values through Rest API.
ChangesAbility to use the option "tcEntitykeys" in the request to specify one or more test case key.
Version 8.5.4Version 8.6
Request Body
{
	"rqID": "PLA-RQ-2035",
	"rqVersionId": 546473,
	"tcVersionIds": "1757615,1757614,1757613"
}
Request Body
{
	"rqID": "FIT-RQ-1",
	"rqVersionId": 876240,
	"tcEntitykeys": "FIT-TC-9,FIT-TC-10,FIT-TC-11"
}

Link Test Suite(s) to Test Case

API/rest/testcases/link/testsuites
MethodPUT
Impact of changeLow
Backward CompatibilityYes
Reason for changeWith introduction of feature to be able to link Test Suites(s) to a Test Case using the Test Suite's Entity Key directly, with the Version 8.6, an option is introduced to pass the test suite(s) key as comma separated values through Rest API.
ChangesAbility to use the option "tsIDs" in the request to specify one or more test suite key.
Version 8.5.4Version 8.6
Request Body
{
	"tcID": "PLA-TC-40",
	"tsIDs": "PLA-TS-30,PLA-TS-29",
	"tcVersion": 2,
	"testSuiteIds": [193945, 193944]
}
Request Body
{
	"tcID": "FIT-TC-59",
	"tcVersion": 1,
	"tsIDs": "FIT-TS-7,FIT-TS-8",
}

Link Test Case(s) to Test Suite

API/rest/testsuites/dolink/TCs
MethodPUT
Impact of changeLow
Backward CompatibilityNo
Reason for changeWith introduction to be able to link Test Case(s) to a Test Suite using the Test Case's Entity Key directly, with the Version 8.6, an option is introduced to pass the test case(s) key as comma separated values through Rest API.
ChangesAbility to use the option "tcEntitykeys" in the request to specify one or more test case key.
Version 8.5.4Version 8.6
Request Body
{
	"tsID": 193944,
	"tcvdIDs": [1757616, 1757614, 1757615],
	"fromReqs": false
}
Request Body
{
	"tsID": 5087,
	"isTcSkip": true,
	"tcEntitykeys": "FIT-TC-3,FIT-TC-4"
}

Common Changes to Request of Following APIs

APIs/rest/requirements/list/viewColumns
/rest/testcases/list/viewColumns
/rest/testsuites/list/viewColumns
/rest/execution/list/viewColumns
/rest/issues/list/viewColumns
/rest/testcases/list/forRQ
/rest/issues/list/ForRQ
/rest/requirements/list/forTC
/rest/testsuites/list/forTC
/rest/requirements/list/forTS
/rest/testcases/list/forTS
/rest/execution/issue/list/forTCStepRun
/rest/execution/issue/list/forTCRun
/rest/requirements/list/forIS
/rest/search
MethodPOST
Impact of changeLow
Backward CompatibilityYes
Reason for changeAbility to search assets in filters by using comma separated entity IDs.
Changes to Request Body
Filter object now supports passing entity keys comma separated for search:
"filter": "[{\"type\":\"string\",\"value\":\"QTM-RQ-20, QTM-RQ-21\",\"field\":\"entityKeyId\"}]"
OR
"filter": "[{\"type\":\"string\",\"value\":\"20,21\",\"field\":\"entityKeyId\"}]"

Deprecated APIs

API NameDeprecated REST LinkAlternate REST Link
Get list of test run under execution/rest/execution/list/tcr/rest/execution/list/viewColumns
Get list of issues linked on Execution or Available for linking/rest/execution/issue/list
  • (Get list of Issue available for linking or already linked to Test case Run)
    /rest/execution/issue/list/forTCRun
  • (Get list of issue available for linking or already linked to Test case Step Run)
    /rest/execution/issue/list/forTCStepRun
Upload Attachment/rest/attachments/reference/rest/attachments
Update Parameter/rest/parameter/deleteValue/{parameterValueID}/rest/parameter/update/{paramID}
Fetch Testcases linked with RQ/rest/requirements/testcase/list/rest/testcases/list/forRQ
Search Entities/rest/search/result/rest/search