API changes from v8.5.4 to v8.5.5

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.5.5 that is scheduled in the end of October 2019. 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.5.4	Request Change	Response Change
Bulk Update Run Status	/rest/execution/runstatus/bulkupdate	PUT	Yes	Yes	Yes
Edit comments on Test Case Run and Test Case Step Run	/rest/execution/updaterun	PUT	Yes	No	No

Updated APIs

Bulk Update Run Status

API	/rest/execution/runstatus/bulkupdate
Method	PUT
Impact of change	Low
Backward Compatibility	Yes
Reason for change	New optional parameter "isAutoExecuted" is introduced in this API that can be set manually to mark the "Execution Type" field on Test Execution Screen to Automated / Manual using this API
Changes	"isAutoExecuted" when unspecified is "isAutoExecuted"=0. It can be specified in the request with values 0 or 1 "isAutoExecuted"=0 set "Execution Type" of the execution to Manual "isAutoExecuted"=1 set "Execution Type" of the execution to Automated

Version 8.5.4

Version 8.5.5

Request Body

{
    "entityIDs": 6151641,
    "entityType": "TCR",
    "qmTsRunId": "368874",
    "runStatusID": 351,
    "type": "TCR",
    "qmRunObj": "",
    "dropID": "",
}

Request Body

{
    "entityIDs": 6151641,
    "entityType": "TCR",
    "qmTsRunId": "368874",
    "runStatusID": 351,
    "type": "TCR",
    "qmRunObj": "",
    "dropID": "",
    "isAutoExecuted":1
}

Response Body

{
    "success": true,
    "code": "CO.UPDATE_RUNSTATUS_SUCCESS",
    "message": "Test Case(s) status was updated.",
    "data": [
        {
            "entityIDs": 6151641,
            "entityType": "TCR",
            "qmTsRunId": "368874",
            "runStatusID": 351,
            "type": "TCR",
            "qmRunObj": "",
            "dropID": "",
            "lastExecuted": "24-Oct-2019 06:54:30 AM",
            "tcrStatus": "351",
            "tcrStatusAlias": "Failed",
            "executedBy": "john.doe"
        }
    ]
}

Response

{
    "success": true,
    "code": "CO.UPDATE_RUNSTATUS_SUCCESS",
    "message": "Test Case(s) status was updated.",
    "data": [
        {
            "entityIDs": 6151641,
            "entityType": "TCR",
            "qmTsRunId": "368874",
            "runStatusID": 351,
            "type": "TCR",
            "qmRunObj": "",
            "dropID": "",
            "isAutoExecuted": 1,
            "lastExecuted": "24-Oct-2019 06:54:30 AM",
            "tcrStatus": "351",
            "tcrStatusAlias": "Failed",
            "executedBy": "john.doe"
        }
    ]
}

Edit comments on Test Case Run and Test Case Step Run

API	/rest/execution/updaterun
Method	PUT
Impact of change	Low
Backward Compatibility	Yes
Reason for change	New optional parameter "isAutoExecuted" is introduced in this API that can be set manually to mark the "Execution Type" field on Test Execution Screen to Automated / Manual using this API. This parameter existed earlier but was not used.
Changes	"isAutoExecuted" when unspecified is "isAutoExecuted"=0. It can be specified in the request with values 0 or 1 "isAutoExecuted"=0 set "Execution Type" of the execution to Manual "isAutoExecuted"=1 set "Execution Type" of the execution to Automated

Version 8.5.4

Version 8.5.5

Request Body

{
    "entityId": 6151641,
    "field": "comment",
    "fieldVal": "Outcome as expected",
    "isAutoExecuted": 0,
    "type": "TCR",
    "qmRunObj": "",
    "dropID": ""
}

Request

{
    "entityId": 6151641,
    "field": "comment",
    "fieldVal": "Outcome as expected",
    "isAutoExecuted": 1,
    "type": "TCR",
    "qmRunObj": "",
    "dropID": ""
}

Response

{
    "success": true,
    "code": "CO.COMMENTS_SAVED_SUCCESSFULLY",
    "message": "Comments saved successfully."
}

Response

{
    "success": true,
    "code": "CO.COMMENTS_SAVED_SUCCESSFULLY",
    "message": "Comments saved successfully."
}