API changes from v8.5.2.7 to v8.5.3

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.2.7 to 8.5.3 that is scheduled during end of July. 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 View Test Suite Details
- 2.2 List Test Cases Linked with Shared Test Case
- 2.3 Link Platforms to Test Suite
- 2.4 Unlink Platforms to Test Suite
- 2.5 Get Issue list along with Custom Fields
- 2.6 List Test Case Executions
- 2.7 Get Test Suite Run IDs
- 2.8 List of Platforms Linked to a Test Suite
- 2.9 Get Test case linked to a TestSuite
- 2.10 Link Test Cases to Test Suite
- 2.11 Create Requirement
- 2.12 Create Test Suite
- 2.13 Create Test case(s)
- 2.14 Get List of all Automation Agents
- 2.15 Get Test Case List along with Custom Fields
- 2.16 List Platform
- 2.17 Clone Project

Summarized API Changes

API Name	REST URL	Method	Backward Compatible with 8.5.2	Request Change	Response Change

API Name	REST URL	Method	Backward Compatible with 8.5.2	Request Change	Response Change
View Test Suite Details	/rest/testsuites/detail/data	POST	Yes	No	Yes
Link Platforms to Test Suite	/rest/testsuites/link/platforms	PUT	Yes	No	Yes
Unlink Platforms to Test Suite	/rest/testsuites/unlink/platforms	PUT	Yes	No	Yes
List Test Cases Linked with Shared Test Case	/rest/testcases/list/forSharedTestcase	POST	Yes	Yes	Yes
Get Issue list along with Custom Fields	/rest/issues/list/viewColumns	POST	Yes	No	Yes
List Test Case Executions	/rest/testcases/execution	POST	No	No	Yes
Get Test Suite Run IDs	/rest/execution/list/platformHome	POST	Yes	No	Yes
List of Platforms Linked to a Test Suite	/rest/testsuites/getplatformwithname	POST	Yes	No	Yes
Get Test case linked to a TestSuite	/rest/testcases/list/forTS	POST	Yes	Yes	Yes
Link Test Cases to Test Suite	/rest/testsuites/dolink/TCs	PUT	Yes	No	Yes
Create Requirement	/rest/requirements	POST	Yes	Yes	No
Create Test Suite	/rest/testsuites	POST	Yes	Yes	No
Create Test case(s)	/rest/testcases	POST	Yes	Yes	No
Get List of all Automation Agents	/rest/admin/agent/read	POST	Yes	No	Yes
Get Test Case List along with Custom Fields	/rest/testcases/list/viewColumns	POST	No	No	Yes
List Platform	/rest/admin/platform/list	POST	No	No	Yes
Clone Project	/rest/admin/project/clone	POST	Yes	No	Yes

Updated APIs

View Test Suite Details

API	/rest/testsuites/detail/data

API	/rest/testsuites/detail/data
Method	POST
Impact of Change	Low
Backward Compatible	Yes
Reason for Change	Get the count of platforms linked to test suite from this API
Changes	Added platformCount in response.

Version 8.5.2.7	Version 8.5.3

Version 8.5.2.7

Version 8.5.3

Response Body

{
	"updatedby": "jane (jane)",
	"cycleIdsAsVersion": "448",
	"createddate": "03-04-2019 08:03:06",
	"isArchived": false,
	"totalWatchers": 1,
	"watchers": "118",
	"description": "",
	"folderPath": "/Flight Simulator",
	"UDFTypeData": {
		"Match": "STRING"
	},
	"createdby": "jane (jane)",
	"id": 635,
	"testSuiteStateAlias": "Open",
	"releaseIdsAsVersion": "389",
	"owner": 118,
	"isAutomatedFlag": false,
	"entityKey": "SS-TS-1",
	"owneralias": "jane",
	"testSuiteState": 24032,
	"TsFolderID": 504,
	"isCurrentUserWatcher": true,
	"name": "Strike 1",
	"updateddate": "03-05-2019 07:56:56",
	"attachmentCount": 0,
	"autoGenerated": false
}

Response Body

{
	"updatedby": "jane (jane)",
	"cycleIdsAsVersion": "448",
	"createddate": "03-04-2019 08:03:06",
	"isArchived": false,
	"totalWatchers": 1,
	"watchers": "118",
	"description": "",
	"folderPath": "/Flight Simulator",
	"UDFTypeData": {
		"Match": "STRING"
	},
	"createdby": "jane (jane)",
	"platformCount": 2,
	"id": 635,
	"testSuiteStateAlias": "Open",
	"releaseIdsAsVersion": "389",
	"owner": 118,
	"isAutomatedFlag": false,
	"entityKey": "SS-TS-1",
	"owneralias": "jane",
	"testSuiteState": 24032,
	"TsFolderID": 504,
	"isCurrentUserWatcher": true,
	"name": "Strike 1",
	"updateddate": "03-05-2019 07:56:56",
	"attachmentCount": 0,
	"autoGenerated": false
}

List Test Cases Linked with Shared Test Case

API	/rest/testcases/list/forSharedTestcase

API	/rest/testcases/list/forSharedTestcase
Method	POST
Impact of Change	Low
Backward Compatible	Yes
Reason for Change	Get the version of the sharable test case linked to other test cases.
Changes	Request : Added tcID Response : Added sharedTcVersion

Version 8.5.2.7	Version 8.5.3

Version 8.5.2.7

Version 8.5.3

Request Body

{
    "limit": 50,
    "start": 0,
    "page": 1,
    "tcVersionID": 1440260
}

Request Body

{
	"limit": 10,
	"start": 0,
	"page": 1,
	"tcVersionID": 40559,
	"tcID": 39562
}

Response

{
    "data": [
        {
            "tcVersionID": 1440261,
            "tcVersion": 2,
            "isArchived": false,
            "isParameterized": false,
            "isVersionArchived": false,
            "projectID": 26,
            "projectName": "Pet Store",
            "tcID": 821357,
            "entityKey": "SAM-TC-129",
            "isApprovalWorkflowEnabled": false,
            "summary": "Phoenix",
            "latestUnArchivedVersion": 2,
            "latestAvailableVersion": 2,
            "cycleNameDetail": "Sprint 1",
            "releaseNameDetail": "Anaconda,Boa",
            "testingType": 1833,
            "testingTypeAlias": "Manual",
            "testCaseType": 1847,
            "testCaseTypeAlias": "Functional",
            "attachmentCount": 0,
            "createdByAlias": "jane.doe",
            "createdBy": "jane.doe"
        }
    ],
    "total": 1,
    "filter": [],
    "udfFilter": "[]"
}

Response

{
	"data": [{
		"sharedTcVersion": "1",
		"tcVersionID": 40086,
		"tcVersion": 2,
		"isArchived": false,
		"isParameterized": false,
		"isVersionArchived": false,
		"projectID": 289,
		"projectName": "Pet Store",
		"tcID": 39258,
		"entityKey": "SAM-TC-129",
		"isApprovalWorkflowEnabled": false,
		"summary": "Phoenix",
		"latestUnArchivedVersion": 2,
		"latestAvailableVersion": 2,
		"priorityId": 27752,
		"priorityAlias": "High",
		"testCaseState": 27759,
		"testCaseStateAlias": "Approved for Manual Only",
		"testingType": 20764,
		"testingTypeAlias": "Manual",
		"testCaseType": 27747,
		"testCaseTypeAlias": "Functional",
		"attachmentCount": 0,
		"createdByAlias": "jane.doe",
		"createdBy": "jane.doe"
	}],
	"total": 1,
	"filter": [],
	"udfFilter": "[]"
}

Link Platforms to Test Suite

API	/rest/testsuites/link/platforms

API	/rest/testsuites/link/platforms
Method	PUT
Impact of Change	Low
Backward Compatible	Yes
Reason for Change	After linking platform response shows the total number of platforms linked.
Changes	Added platformCount in response

Version 8.5.2.7	Version 8.5.3

Version 8.5.2.7

Version 8.5.3

Response

{
	"COUNT": 1,
	"success": true,
	"code": "TS.LINK_PLATFORM_SUCCESS",
	"message": "Platform(s) linked successfully.",
	"data": [{
		"COUNT": 1
	}]
}

Response

{
	"COUNT": 1,
	"success": true,
	"code": "TS.LINK_PLATFORM_SUCCESS",
	"message": "Platform(s) linked successfully.",
	"data": [{
		"COUNT": 1
	}],
	"platformCount": 3
}

Unlink Platforms to Test Suite

API	/rest/testsuites/unlink/platforms

API	/rest/testsuites/unlink/platforms
Method	PUT
Impact of Change	Low
Backward Compatible	Yes
Reason for Change	Get platform count after unlinking platforms using this API.
Changes	Added platformCount in response

Version 8.5.2.7	Version 8.5.3

Version 8.5.2.7

Version 8.5.3

Response

{
	"COUNT": 1,
	"success": true,
	"code": "TS.UNLINK_PLATFORM_SUCCESS",
	"message": "1 platform(s) unlinked to test suite successfully.",
	"data": [{
		"COUNT": 1
	}]
}

Response

{
	"platformCount": 2,
	"COUNT": 1,
	"success": true,
	"code": "TS.UNLINK_PLATFORM_SUCCESS",
	"message": "1 platform(s) unlinked to test suite successfully.",
	"data": [{
		"platformCount": 2,
		"COUNT": 1
	}]
}

Get Issue list along with Custom Fields

API	/rest/issues/list/viewColumns

API	/rest/issues/list/viewColumns
Method	POST
Impact of Change	Low
Backward Compatible	Yes
Reason for Change	Remaned column on Issues grid view from "Linked Test Case(s) Count" to "Linked Test Execution Runs"
Changes	displayname parameter output changes from Linked Test Case(s) Count to Linked Test Execution Runs

Version 8.5.2.7	Version 8.5.3

Version 8.5.2.7

Version 8.5.3

Response

{
	"data": [{
		"name": "IS 1",
		"entityKey": "PEN-IS-1",
		"stateAlias": "Open",
		"typeAlias": "New Feature",
		"linkedRqCount": 0,
		"linkedTcrCount": 3,
		"createdDate": "04-04-2019 08:57:56",
		"isWatcher": false,
		"id": 311630,
		"createdByAlias": "jane.doe (jane.doe)"
	}],
	"total": 1,
	"viewId": 4553,
	"filter": "[]",
	"sort": null,
	"viewName": "Custom",
	"filterTemplate": [{
		"displayName": "Linked Test Case(s) Count",
		"field": "linkedTcrCount",
		"fieldType": "numeric",
		"isUDF": false
	}, 
	...
	..
	],
	"columns": {
		"visibleColumns": [{
			"displayName": "Entity Key",
			"field": "entityKey",
			"isSysField": true,
			"isUDF": false,
			"order": 1,
			"width": "150",
			"checked": true,
			"filtered": false
		}, 
		...
		..
		.]
	},
	"udfFilter": "[]"
}

Response

{
	"data": [{
		"name": "IS 1",
		"entityKey": "PEN-IS-1",
		"stateAlias": "Open",
		"typeAlias": "New Feature",
		"linkedRqCount": 0,
		"linkedTcrCount": 3,
		"createdDate": "04-04-2019 08:57:56",
		"isWatcher": false,
		"id": 311630,
		"createdByAlias": "jane.doe (jane.doe)"
	}],
	"total": 1,
	"viewId": 4553,
	"filter": "[]",
	"sort": null,
	"viewName": "Custom",
	"filterTemplate": [{
		"displayName": "Linked Test Execution Runs",
		"field": "linkedTcrCount",
		"fieldType": "numeric",
		"isUDF": false
	}, 
	...
	..
	],
	"columns": {
		"visibleColumns": [{
			"displayName": "Entity Key",
			"field": "entityKey",
			"isSysField": true,
			"isUDF": false,
			"order": 1,
			"width": "150",
			"checked": true,
			"filtered": false
		}, 
		...
		..
		.]
	},
	"udfFilter": "[]"
}

List Test Case Executions

API	/rest/testcases/execution

API	/rest/testcases/execution
Method	POST
Impact of Change	Medium
Backward Compatible	No
Reason for Change	Type of “attributes” parameter has been changed from string to array. In case of attribute value itself contained a comma (,) character then it was creating problem. Advanage : Now if attribute value contains comma (,) character, now it will still return the data properly.
Changes	Added attributes and its attributeName, attributeValue parameters in response Added two more new parameters cycleID, releaseID in response

Version 8.5.2.7	Version 8.5.3

Version 8.5.2.7

Version 8.5.3

Response

{
	"data": [{
		"defects": "DIW-IS-1:206022",
		"External_Key_URL_Data": "[{\"key\":\"DIW-IS-1:206022\" , \"baseURL\":\"\"}]",
		"testLogs": 0,
		"testSuiteName": "My TS",
		"description": "",
		"tsEntityKey": "DIW-TS-2",
		"isApprovalWorkflowEnabled": false,
		"testCaseStatus": "iVBO..",
	    "platform": "No Platform",
		"isArchived": false,
		"displayName": "Not Run",
		"statusName": "notrun",
		"testSuiteStatus": "iVBO..",
	    "tcRunID": 14207,
		"lastExecDrop": "None",
		"executedVersion": 1,
		"tsID": 982,
		"attributes": "Air Strike",
		"cycleName": "Default Cycle",
		"isCycleArchived": false,
		"releaseName": "Default Release",
		"isReleaseArchived": false,
		"scope": "341:666:1008",
		"executionStatusIconImage": "#205081|#FFFFFF",
		"tsrunID": 2116,
		"statusID": 2393,
		"state": 1,
		"projectID": 341,
		"isPlatformArchived": false,
		"isTestSuiteArchived": false,
		"totalExecutionTime": 0,
		"RemainingTime": 0
	}],
	"total": 1
}

Response

{
	"data": [{
		"defects": "PEN-IS-1:311630",
		"External_Key_URL_Data": "[{\"key\":\"PEN-IS-1:311630\" , \"baseURL\":\"}]",
		"testLogs": 0,
		"testSuiteName": "My TS",
		"description": "",
		"tsEntityKey": "PEN-TS-1",
		"isApprovalWorkflowEnabled": false,
		"testCaseStatus": "iVBO..",
	    "platform": "No Platform",
		"isArchived": false,
		"displayName": "Not Run",
		"statusName": "notrun",
		"testSuiteStatus": "iVBO..",
	    "tcRunID": 176464,
		"lastExecDrop": "None",
		"executedVersion": 1,
		"tsID": 1016,
		"attributes": [{
			"attributeName": "Air Strike",
			"attributeValue": "F1"
		}],
		"cycleName": "Default Cycle",
		"isCycleArchived": false,
		"releaseName": "Default Release",
		"isReleaseArchived": false,
		"scope": "289:346:404",
		"executionStatusIconImage": "#205081|#FFFFFF",
		"tsrunID": 4618,
		"statusID": 2037,
		"state": 1,
		"projectID": 289,
		"isPlatformArchived": false,
		"isTestSuiteArchived": false,
		"totalExecutionTime": 0,
		"RemainingTime": 0,
		"cycleID": 404,
		"releaseID": 346
	}],
	"total": 1
}

Get Test Suite Run IDs

API	/rest/execution/list/platformHome

API	/rest/execution/list/platformHome
Method	POST
Impact of Change	Low
Backward Compatible	Yes
Reason for Change	Test Suite >> Test Execution details will display the attribute and attribute values added during execution.
Changes	Added attributeValues and its attributeName, attributeValue parameters in response

Version 8.5.2.7	Version 8.5.3

Version 8.5.2.7

Version 8.5.3

Response

{
	"data": [{
		"isAutomatedFlag": false,
		"PlatformId": 592,
		"Platform": "No Platform",
		"TestSuiteName": "My TS",
		"tsRunID": 2116,
		"tsID": 982,
		"isTestRun": true,
		"startTime": "05-02-2018 17:44:47",
		"endTime": "05-02-2018 17:44:49",
		"isPlatformArchived": false,
		"isTestSuiteArchived": false,
		"cycleName": "Default Cycle",
		"releaseName": "Default Release",
		"cycleID": 1008,
		"releaseID": 666,
		"entityKey": "DIW-TS-2",
		"TestSuitePath": "/Sample Suite",
		"totalTCWithExecutionTime": 0,
		"totalExecutionTime": 0,
		"RemainingTime": 0,
		"Total": 2,
		"isCycleArchived": false,
		"isReleaseArchived": false,
		"state": 1,
		"status_2395": 0,
		"status_2393": 1,
		"status_2391": 0,
		"status_2394": 1,
		"status_2390": 0,
		"status_2389": 0,
		"Status": "Blocked",
		"statusID": 2393,
		"Defects": 2,
		"createdDate": "05-02-2018 17:41:15",
		"updatedDate": "05-02-2018 17:46:37",
		"updatedByAlias": "janedoe",
		"createdByAlias": "janedoe"
	}],
	"total": 1
}

Response

{
	"data": [{
		"isAutomatedFlag": false,
		"PlatformId": 392,
		"Platform": "No Platform",
		"TestSuiteName": "My TS",
		"tsRunID": 4618,
		"tsID": 1016,
		"isTestRun": false,
		"startTime": "05-09-2019 12:24:01",
		"isPlatformArchived": false,
		"isTestSuiteArchived": false,
		"cycleName": "Default Cycle",
		"releaseName": "Default Release",
		"cycleID": 404,
		"releaseID": 346,
		"entityKey": "PEN-TS-1",
		"TestSuitePath": "/pencil",
		"totalTCWithExecutionTime": 0,
		"totalExecutionTime": 0,
		"RemainingTime": 0,
		"Total": 1,
		"isCycleArchived": false,
		"isReleaseArchived": false,
		"state": 1,
		"status_2035": 0,
		"status_2032": 0,
		"status_2033": 0,
		"status_2037": 1,
		"status_2038": 0,
		"status_2036": 0,
		"Status": "Not Run",
		"statusID": 2037,
		"Defects": 3,
		"createdDate": "05-09-2019 12:23:55",
		"createdByAlias": "ab",
		"attributeValues": [{
			"attributeName": "Air Strike",
			"attributeValue": "F1"
		}]
	}],
	"total": 1
}

List of Platforms Linked to a Test Suite

API	/rest/testsuites/getplatformwithname

API	/rest/testsuites/getplatformwithname
Method	POST
Impact of Change	Low
Backward Compatible	Yes
Reason for Change	Platform details under test suite now show the platform attribute and attribute values set.
Changes	Added attributeValues and its attributeName, attributeValue parameters

Version 8.5.2.7	Version 8.5.3

Version 8.5.2.7

Version 8.5.3

Response

{
	"data": [{
		"platformID": 592,
		"name": "No Platform",
		"tsID": 982,
		"isArchived": false
	}],
	"total": 1
}

Response

{
	"data": [{
		"platformID": 392,
		"name": "No Platform",
		"tsID": 1016,
		"isArchived": false,
		"attributeValues": [{
			"attributeName": "Air Strike",
			"attributeValue": "F1"
		}]
	}],
	"total": 1
}

Get Test case linked to a TestSuite

API	/rest/testcases/list/forTS

API	/rest/testcases/list/forTS
Method	POST
Impact of Change	Low
Backward Compatible	Yes
Reason for Change	tcversionids added across pages for bulk update
Changes	Added "selectAll" flag to fetch tcVersionIds (Max. 1000) across pages in request

API changes from v8.5.2.7 to v8.5.3

Summarized API Changes

Updated APIs

View Test Suite Details

/rest/testsuites/detail/data

/rest/testsuites/detail/data

Response Body

Response Body

List Test Cases Linked with Shared Test Case

/rest/testcases/list/forSharedTestcase

/rest/testcases/list/forSharedTestcase

Request Body

Request Body

Response

Response

Link Platforms to Test Suite

/rest/testsuites/link/platforms

/rest/testsuites/link/platforms

Response

Response

Unlink Platforms to Test Suite

/rest/testsuites/unlink/platforms

/rest/testsuites/unlink/platforms

Response

Response

Get Issue list along with Custom Fields

/rest/issues/list/viewColumns

/rest/issues/list/viewColumns

Response

Response

List Test Case Executions

/rest/testcases/execution

/rest/testcases/execution

Response

Response

Get Test Suite Run IDs

/rest/execution/list/platformHome

/rest/execution/list/platformHome

Response

Response

List of Platforms Linked to a Test Suite

/rest/testsuites/getplatformwithname

/rest/testsuites/getplatformwithname

Response

Response

Get Test case linked to a TestSuite

/rest/testcases/list/forTS

/rest/testcases/list/forTS