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.

Summarized API Changes

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
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

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
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

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
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

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
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

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
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

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
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

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
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

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
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

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
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

Version 8.5.2.7

Version 8.5.3

Request Body

{
	"limit": 1000,
	"start": 0,
	"page": 1,
	"tsID": 182339,
	"getLinked": true
}

Request Body

{
	"scope": "project",
	"limit": 1000,
	"start": 0,
	"page": 1,
	"tsID": 1,
	"getLinked": false,
	"selectAll": true,
	"getColumns": true,
	"filter": "[{\"value\":[\"0\"],\"type\":\"list\",\"field\":\"isShared\"}]",
	"showAllStateEntities": true
}

Response

{
	"data": [{
		"tcVersionID": 106080,
		"tcVersion": 1,
		"isArchived": false,
		"isParameterized": false,
		"tctsID": 1748100,
		"isVersionArchived": false,
		"projectID": 581,
		"projectName": "Rachit Jenkins testing",
		"tcID": 72759,
		"entityKey": "RJT-TC-16",
		"isApprovalWorkflowEnabled": false,
		"summary": "Login as Admin",
		"latestUnArchivedVersion": 1,
		"latestAvailableVersion": 1,
		"priorityId": 60844,
		"priorityAlias": "Blocker",
		"cycleNameDetail": "Default Cycle",
		"releaseNameDetail": "Default Release",
		"buildName": "Default Cycle",
		"testCaseState": 71445,
		"testCaseStateAlias": "None",
		"testingType": 71447,
		"testingTypeAlias": "BVT",
		"testCaseType": 71446,
		"testCaseTypeAlias": "None",
		"attachmentCount": 0,
		"componentAlias": ["None"],
		"createdByAlias": "rachit",
		"createdBy": "rachit",
		"orderId": 1
	},
    ...
    ..
    .
}

Response

{
	"data": [1, 2],
	"total": 2,
	"filter": [],
	"udfFilter": "[]",
	"tcFolderPath": "",
	"showUnlinked": false,
	"showUnlinkedForReleaseCycle": false,
	"showEntityWithReleaseCycle": false
}

Link Test Cases to Test Suite

API	/rest/testsuites/dolink/TCs
Method	PUT
Impact of Change	Low
Backward Compatible	Yes
Reason for Change	API Response modfied to cater the improvement for pushing the process of linking test cases to test suite into background if it is identified as a long running process.
Changes	If product of ( testcase * platform *cycle ) exceeds 100, the response code and message changes as seen in below example, along with addition of parameter : "isBackgroundProcess": true due to the request being processed in background.

Version 8.5.2.7

Version 8.5.3

Response

{
    "COUNT": ,
    "success": true,
    "code": "CO.LINK_ENTITY_SUCCESS",
    "message": "Selected entities linked successfully.",
    "data": []
}

Response

{
	"success": true,
	"code": "TS.LINK_TC_SCHEDULED",
	"message": "Link Testcase(s) has been scheduled to run in background. Go to \"Scheduled Task\" to track the progress.",
	"isBackgroundProcess": true
}

Create Requirement

API	/rest/requirements
Method	POST
Impact of Change	Low
Backward Compatible	Yes
Reason for Change	Check enabled to know if Associated Release(s)/Cycle(s) field is mandatory
Changes	The two services : rest/requirements and rest/requirements/scope/add have been combined while creating requirement to check if Associated Release(s)/Cycle(s) field is mandatory or not. Two attributes are new to the request : "associateRelCyc":true, "releaseCycleMapping":[{"release":6,"cycle":[6],"version":1}]

Version 8.5.2.7

Version 8.5.3

Request

{
	"rqFolderId":"1",
	"updateWithVersion":false,
	"updateVersionFlag":0,
	"versions":[],
	"scope":"project",
	"UDFField":[{
		"key":"FLD.str",
		"name":"str",
		"type":"STRING",
        "fldProp":{
			"allowBlank":true,
			"fieldLabel":"str"
		},
		"listModal":[],
		"fieldID":1,
		"required":false,
		"maxLength":30
	}],
	"name":"Authentication Types",
	"priority":[110],
	"description":"",
		"UDF":{
		"str":	{
			"fieldID":1,
			"value":""
			}
		}
}

Request

{
	"rqFolderId": "1",
	"updateWithVersion": false,
	"updateVersionFlag": 0,
	"scope": "project",
	"UDFField": [{
		"key": "FLD.str",
		"name": "str",
		"type": "STRING",
		"fldProp": {
			"allowBlank": true,
			"fieldLabel": "str"
		},
		"listModal": [],
		"fieldID": 1,
		"required": false,
		"maxLength": 30
	}],
	"name": "Authentication Types",
	"priority": [110],
	"UDF": {
		"str": {
			"fieldID": 1,
			"value": ""
		}
	},
	"description": "",
	"associateRelCyc": true,
	"releaseCycleMapping": [{
		"release": 1,
		"cycle": [1],
		"version": 1
	}]
}

Create Test Suite

API	/rest/testsuites
Method	POST
Impact of Change	Low
Backward Compatible	Yes
Reason for Change	Check enabled to know if Associated Release(s)/Cycle(s) field is mandatory
Changes	The two services : rest/testsuites and rest/testsuites/mapReleaseCycle have been combined while creating testsuite to check if Associated Release(s)/Cycle(s) field is mandatory. Two attributes are new to the request : "associateRelCyc":true, "releaseCycleMapping":[{"buildID":1,"releaseId":1}]

Version 8.5.2.7

Version 8.5.3

Request

{
	"parentFolderId":"1",
	"id":0,
	"isAutomatedFlag":false,
	"UDFField":[{
		"key":"FLD.str",
		"name":"str",
		"type":"STRING",
		"fldProp":{
			"allowBlank":true,
			"fieldLabel":"str"
		},
		"listModal":[],
		"fieldID":2,
		"required":false,
		"maxLength":30
	}],
	"name":"TEST SUITE",
	"description":"",
	"owner":1,
	"testSuiteState":0,
	"UDF":{
		"str":{
			"fieldID":2,
			"value":""
			}
		},
	"str":""
}

Request

{
	"parentFolderId": "1",
	"id": 0,
	"isAutomatedFlag": false,
	"UDFField": [{
		"key": "FLD.str",
		"name": "str",
		"type": "STRING",
		"fldProp": {
			"allowBlank": true,
			"fieldLabel": "str"
		},
		"listModal": [],
		"fieldID": 2,
		"required": false,
		"maxLength": 30
	}],
	"name": "ts",
	"description": "",
	"owner": 1,
	"testSuiteState": 0,
	"UDF": {
		"str": {
			"fieldID": 2,
			"value": ""
		}
	},
	"associateRelCyc": true,
	"releaseCycleMapping": [{
		"buildID": 1,
		"releaseId": 1
	}]
}

Create Test case(s)

API	/rest/testcases
Method	POST
Impact of Change	Low
Backward Compatible	Yes
Reason for Change	To check whether Associated Release(s)/Cycle(s) field is mandatory or not.
Changes	The two services : rest/testcases and rest/testcases/scope/add while creating test case to check if Associated Release(s)/Cycle(s) field is mandatory or not. Two attributes are new to the request : "associateRelCyc":true, "releaseCycleMapping":[{"release":6,"cycle":[6],"version":1}]

Version 8.5.2.7

Version 8.5.3

Request

{
	"tcFolderID":"1",
	"scope":"project",
	"steps":[],
	"removeSteps":[],
	"state":1,
	"UDFField":[{
		"key":"FLD.str",
		"name":"str",
		"type":"STRING",
		"fldProp":{
			"allowBlank":true,
			"fieldLabel":"str"
		},
		"listModal":[],
		"fieldID":4,
		"required":false,
		"maxLength":30
	}],
	"name":"Test Case to verify authentication",
	"owner":1,
	"executionMinutes":20,
	"description":"",
	"testingType":12,
	"UDF":{},
	"str":""
}

Request

{
	"tcFolderID": "1",
	"scope": "project",
	"steps": [],
	"removeSteps": [],
	"state": 1,
	"UDFField": [{
		"key": "FLD.str",
		"name": "str",
		"type": "STRING",
		"fldProp": {
			"allowBlank": true,
			"fieldLabel": "str"
		},
		"listModal": [],
		"fieldID": 4,
		"required": false,
		"maxLength": 30
	}],
	"name": "Test Case to verify authentication",
	"testingType": 12,
	"UDF": {},
	"description": "",
	"associateRelCyc": true,
	"releaseCycleMapping": [{
		"release": 1,
		"cycle": [1],
		"version": 1
	}]
}

Get List of all Automation Agents

API	/rest/admin/agent/read
Method	POST
Impact of Change	Low
Backward Compatible	Yes
Reason for Change	Improvements in QMetry Agent. If a user tries to register a QMetry Agent with a previously created and registered agent, he will get an error along with the name of the user who registered it.
Changes	Added createdBy parameter in response to indicate the user who created the agent with same name before.

Version 8.5.2.7

Version 8.5.3

Response Body

{
	"total": 10,
	"data": [{
		"pluginAgentId": 183,
		"alias": "Windows 7 Agent",
		"os": "Windows 10",
		"macAdd": "E4-B9-7A-03-81-F5",
		"status": "Inactive",
		"creationDate": "2019-05-16T07:58:35",
		"agentType": "QMetry",
		"schedules": "0 Scheduled/<br/> 0 In progress",
		"history": "History"
	},
...
..
]
}

Response Body

{
	"total": 10,
	"data": [{
		"pluginAgentId": 281,
			"alias": "Windows 7 Agent",
			"os": "Windows 10",
			"macAdd": "E4-B9-7A-11-96-E4",
			"status": "Inactive",
			"creationDate": "2019-07-09T05:57:46",
			"agentType": "QMetry",
			"createdBy": "Jane Doe",
			"schedules": "0 Scheduled/<br/> 0 In progress",
			"history": "History"
	},
...
..
]
}

Get Test Case List along with Custom Fields

API	/rest/testcases/list/viewColumns
Method	POST
Impact of Change	Low
Backward Compatible	No
Reason for Change	“tcVersionList” parameter is removed from response as it was not required. It unnecessarily retrieved archive/unarchive details of all versions of test cases on list screen. Advantage : When there are 70k + test cases in system, load performance is improved from 140+ seconds to 3 seconds.
Changes	tcVersionList parameter is removed from response.

Version 8.5.2.7

Version 8.5.3

Response Body

{
	"data": [{
		"entityKey": "RJT-TC-137",
		"tcFolderId": 4407,
		"associatedVersion": 1,
		"name": "Zoom Service",
		"tcVersionList": "[{\"\"isArchived\"\":0,\"\"tcVersion\"\":1,\"\"tcVersionId\"\":1457167,\"\"tcVersionName\"\":\"\"Version-1\"\"}]",
		"isWatcher": true,
		"isArchived": false,
		"folderPath": "/Jenkins testing/Sample 1",
		"id": 848251,
		"isShared": false,
		"versionId": 1457167,
		"linkedDfCount": 0,
		"linkedRqCount": 0,
		"linkedTsCount": 0,
		"approvalStatus": 1
	},
 ....
 ..
"columns": {}
}

Response Body

{
	"data": [{
		"entityKey": "RJT-TC-137",
		"tcFolderId": 3543,
		"associatedVersion": 1,
		"name": "Zoom Service",
		"createdByAlias": "(Jane_Doe) (Jane_Doe)",
		"updatedByAlias": "(Jane_Doe) (Jane_Doe)",
		"createdDate": "29-Nov-2018 10:09:50 AM",
		"testingTypeAlias": "Manual",
		"isWatcher": false,
		"isArchived": false,
		"folderPath": "/Jenkins testing/Sample 1",
		"id": 293054,
		"isShared": false,
		"versionId": 678807,
		"attachmentCount": 0,
		"linkedDfCount": 0,
		"linkedRqCount": 0,
		"linkedTsCount": 1,
		"approvalStatus": 1,
	},
...
..
"columns": {}
}

List Platform

API	/rest/admin/platform/list
Method	POST
Impact of Change	Low
Backward Compatible	No
Reason for Change	To improve the performance.
Changes	platformScope, isProjectLevel and isReleaseLevel have been removed

Version 8.5.2.7

Version 8.5.3

Response Body

{
  "data": [
    {
      "platformID": 11821,
      "createdDate": "2019-07-10T05:15:08",
      "name": "Chrome",
      "isPlatformArchived": false,
      "Case": "",
      "projectID": 2985,
      "platformScope": 1,
      "isProjectLevel": 1,
      "isReleaseLevel": 1
    }
}

Response Body

{
  "data": [
    {
      "platformID": 14295,
      "createdDate": "2019-06-07T06:40:35",
      "name": "Pf-Name-XPLDE",
      "isPlatformArchived": false,
      "projectID": 6753
    }

Clone Project

API	/rest/admin/project/clone
Method	POST
Impact of Change	Low
Backward Compatible	Yes
Reason for change	To show the cloned project's name.
Changes	Added project_name field in the response.

Version 8.5.2

Version 8.5.3

Response Body

{
  "success": true,
  "code": "CO.PROJECT_CLONE_IN_PROGRESS",
  "message": "This project cloning is scheduled to run in the background. Go to \"Scheduled Task\" to track its progress.",
  "data": [
    {
      "filterName": " clone {PROJECT}"
    }
  ]
}

Response Body

{
  "success": true,
  "code": "CO.PROJECT_CLONE_IN_PROGRESS",
  "message": "This project (project_name) cloning is scheduled to run in the background. Go to \"Scheduled Task\" to track its progress.",
  "data": [
    {
      "filterName": " clone {PROJECT}",
      "Project_name": "project_name"
    }
  ]
}

Summarized API Changes

Updated APIs

View Test Suite Details

/rest/testsuites/detail/data

List Test Cases Linked with Shared Test Case

/rest/testcases/list/forSharedTestcase

Link Platforms to Test Suite

/rest/testsuites/link/platforms

Unlink Platforms to Test Suite

/rest/testsuites/unlink/platforms

Get Issue list along with Custom Fields

/rest/issues/list/viewColumns

List Test Case Executions

/rest/testcases/execution

Get Test Suite Run IDs

/rest/execution/list/platformHome

List of Platforms Linked to a Test Suite

/rest/testsuites/getplatformwithname

Get Test case linked to a TestSuite

/rest/testcases/list/forTS

Link Test Cases to Test Suite

/rest/testsuites/dolink/TCs

Create Requirement

/rest/requirements

Create Test Suite

/rest/testsuites

Create Test case(s)

/rest/testcases

Get List of all Automation Agents

/rest/admin/agent/read

Get Test Case List along with Custom Fields

/rest/testcases/list/viewColumns

List Platform

Clone Project