API changes from v8.6.3 to v8.6.4

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.6.3 to 8.6.4 which will be released on 10th Oct for cloud customers and on 12th Oct 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.

1 Summarized API changes
2 Updated APIs
- 2.1 List of Cycles
- 2.2 Add BDD Configuration
- 2.3 Fetch Executions for Issues

Summarized API changes

API Name	REST URL	Method	Backward compatibility with 8.6.3	Request Change	Response Change

API Name	REST URL	Method	Backward compatibility with 8.6.3	Request Change	Response Change
List of Cycles	/rest/admin/cycle/list	POST	Yes	Yes	No
Add BDD Configuration	/rest/admin/bddConfiguration/add	POST	Yes	Yes	No
Fetch Executions for Issues	/rest/execution/getExecutionsForIssue	POST	Yes	No	Yes

Updated APIs

List of Cycles

API	/rest/admin/cycle/list

API	/rest/admin/cycle/list
Method	POST
Impact of change	Low
Backward Compatibility	Yes
Reason for change	To get the list of cycle from multiple releases
Changes	Use the parameter "releaseID" in the request to specify one or more release Id.

Version 8.6.3	Version 8.6.4

Version 8.6.3	Version 8.6.4
Request Body `{ "start": 0, "limit": 10, "page": 1, "params": { "releaseID":10925, "showArchive": true } }`	Request Body `{ "start": 0, "limit": 10, "page": 1, "params": { "releaseID": [3190,3191], "showArchive": true } }`

Add BDD Configuration

API	/rest/admin/bddConfiguration/add

API	/rest/admin/bddConfiguration/add
Method	POST
Impact of change	Low
Backward Compatibility	Yes
Reason for change	Added support for GitLab. Git Hub can also be authenticated with new "accessToken" parameter field in request body
Changes	Added below field in the request: accessToken

GITHUB

Version 8.6.3	Version 8.6.4

Version 8.6.3

Version 8.6.4

GITHUB

Request Body

{
    "repoSystem": "GIT",
    "url": "https://github.com/punitsamtani/amazondemo.git",
    "username": "username",
    "password": "******",
    "type": "Cloud",
    "projectID": "1257"
}

GITHUB

Request Body

{
    "repoSystem": "GIT",
    "url": "https://github.com/punitsamtani/amazondemo.git",
    "accessToken": "/agZaDrUaLjNjVI5E4eM",
    "type": "Cloud",
    "projectID": "1257"
}

GITLAB

Request Body

{
repoSystem: "GITLAB",
accessToken: "q1orrpV",
projectID: "1088",
repoSystem: "GITLAB",
url: "https://gitlab.com/neel5/bank-management.git"
}

Fetch Executions for Issues

API	/rest/execution/getExecutionsForIssue

API	/rest/execution/getExecutionsForIssue
Method	POST
Impact of change	Low
Backward Compatibility	Yes
Reason for change	Added IsPlatformArchived parameter in response to identify if the platform is archived in the execution in case of archived executions.
Changes	Added below field in the response: IsPlatformArchived

Version 8.6.3	Version 8.6.4

Version 8.6.3

Version 8.6.4

Response Body

{
    "data": [
        {
            "tcRunID": 18168519,
            "tcID": 755378,
            "dfID": 372536,
            "linkageLevel": "Test Step",
            "executedVersion": 1,
            "tcEntityKey": "PS-TC-2",
            "tcProjectIsApprovalWorkflowEnabled": false,
            "tcProjectID": 1252,
            "tcName": "Test",
            "tcAssociatedVersion": 1,
            "tcVersion": 1,
            "isArchived": false,
            "runStatusWeightage": 60000,
            "tsID": 14027,
            "tsName": "Test Suite",
            "tcApprovalStatus": 1,
            "tsEntityKey": "PS-TS-1",
            "isTestSuiteArchived": false,
            "tsProjectID": 1252,
            "tsRunID": 50606,
            "platformID": 2203,
            "platformName": "No Platform",
            "runStatusName": "notrun",
            "executionCreatedBy": 304,
            "executionCreatedByLoginID": "dhiraj",
            "executionCreatedByLoginAlias": "dhiraj",
            "executionCreatedByLoginName": "dhiraj sajagure",
            "cycleName": "Default Cycle",
            "isCycleArchived": false,
            "releaseName": "Default Release",
            "isReleaseArchived": false,
            "state": 1,
            "tsProjectIsApprovalWorkflowEnabled": false,
            "runStatusID": 8905,
            "isExecutionStatusArchived": false
        }
    ],
    "total": 1
}

Response Body

{
    "data": [
        {
            "tcRunID": 18168519,
            "tcID": 755378,
            "dfID": 372536,
            "linkageLevel": "Test Step",
            "executedVersion": 1,
            "tcEntityKey": "PS-TC-2",
            "tcProjectIsApprovalWorkflowEnabled": false,
            "tcProjectID": 1252,
            "tcName": "Test",
            "tcAssociatedVersion": 1,
            "tcVersion": 1,
            "isArchived": false,
            "runStatusWeightage": 60000,
            "tsID": 14027,
            "tsName": "Test Suite",
            "tcApprovalStatus": 1,
            "tsEntityKey": "PS-TS-1",
            "isTestSuiteArchived": false,
            "tsProjectID": 1252,
            "tsRunID": 50606,
            "platformID": 2203,
            "platformName": "No Platform",
            "isPlatformArchived": false,
            "runStatusName": "notrun",
            "executionCreatedBy": 304,
            "executionCreatedByLoginID": "dhiraj",
            "executionCreatedByLoginAlias": "dhiraj",
            "executionCreatedByLoginName": "dhiraj sajagure",
            "cycleName": "Default Cycle",
            "isCycleArchived": false,
            "releaseName": "Default Release",
            "isReleaseArchived": false,
            "state": 1,
            "tsProjectIsApprovalWorkflowEnabled": false,
            "runStatusID": 8905,
            "isExecutionStatusArchived": false
        }
    ],
    "total": 1
}