API changes from v8.7 to v8.7.1

With the new and upcoming releases of QMetry, we continue to add exciting and useful new features that improve usability. The new features and improvements being added to QMetry also necessitate changes in the APIs. This page enlists such APIs that will be changed from version 8.7 to 8.7.1 which will be released on 30th Jan for Cloud customers and on 1st Feb for the Server customers. 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 Name	REST URL	Method	Backward compatibility with 8.7	Request Change	Response Change
List Test Execution Run	/rest/execution/list/viewColumns	POST	Yes	No	Yes

Updated APIs

List Test Execution Run

API	/rest/execution/list/viewColumns
Method	POST
Impact of change	Low
Backward Compatibility	Yes
Reason for change	With QMetry v8.7.1, a new response parameter as "currentParamJson" is added to display data parameter name and value with special characters.
Changes	New parameter in the response body - "currentParamJson"

Version 8.7

Version 8.7.1

Response Body

{
    "data": [
        {
            "tsRunID": 429881,
            "tcRunID": 5999872,
            "tcID": 1640474,
            "tcVersionID": 2322417,
            "projectID": 4906,
            "runStatus": "Not Run",
            "attachmentCount": 0,
            "entityKey": "CM-TC-67",
            "tcFolderId": 146831,
            "tctsorderId": 1,
            "runStatusID": 34265,
            "isVersionArchived": false,
            "associatedVersion": 3,
            "summary": "Test Case 2 Shareable steps",
            "linkedDfCount": 0,
            "executedVersion": 3,
            "stepCount": 13,
            "linkedStepDfCount": 0,
            "isTcArchived": false,
            "hasRows": 0,
            "currentParam": "{\"1304\":\"Username_2020\"}",
            "latestVersion": 3,
            "tctsID": 2352664,
            "isChild": false
        }
    ],
    "total": 1,
    "noOfUnarchivedRecord": 1,
    "viewId": 23893,
    "filter": "[]",
    "viewName": "Custom",
    "udfFilter": "[]",
    "showTcWithDefects": false
}

Response Body

{
    "data": [
        {
            "tsRunID": 429881,
            "tcRunID": 5999872,
            "tcID": 1640474,
            "tcVersionID": 2322417,
            "projectID": 4906,
            "runStatus": "Not Run",
            "attachmentCount": 0,
            "entityKey": "CM-TC-67",
            "tcFolderId": 146831,
            "tctsorderId": 1,
            "runStatusID": 34265,
            "isVersionArchived": false,
            "associatedVersion": 3,
            "summary": "Test Case 2 Shareable steps",
            "linkedDfCount": 0,
            "executedVersion": 3,
            "stepCount": 13,
            "linkedStepDfCount": 0,
            "isTcArchived": false,
            "hasRows": 0,
            "currentParam": "{\"1304\":\"Username_2020\"}",
			"currentParamJson":,
            "latestVersion": 3,
            "tctsID": 2352664,
            "isChild": false
        }
    ],
    "total": 1,
    "noOfUnarchivedRecord": 1,
    "viewId": 23893,
    "filter": "[]",
    "viewName": "Custom",
    "udfFilter": "[]",
    "showTcWithDefects": false
}