API changes from v8.8 to v8.9

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 updated from v8.9 scheduled to be released on 23rd Oct 2021 for all the cloud and 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.8	Request Change	Response Change
Create test case	/rest/testcases	POST	Yes	Yes	No
Update test case	/rest/testcases	PUT	Yes	Yes	No

Updated APIs

Create test case

API	/rest/testcases
Method	POST
Impact of change	Low
Backward Compatibility	Yes
Reason for change	API updated to carry the test case step user-defined field details.
Changes	Added "UDF" parameter for every step that carries steps user-defined field (UDF) data.

Version 8.8.0

Version 8.9

Request Body

{
	"name": "Test case summary",
	"description": "Test case description data",
	"steps": [
		{
			"orderId": 1,
			"description": "step description data",
			"inputData": "step input data information",
			"expectedOutcome": "step expected outcome information"
		},
	],
	"tcFolderID": "34758"
}

Request Body

{
	"name": "Test case summary",
	"description": "Test case description data",
	"steps": [
		{
			"orderId": 1,
			"description": "step description data",
			"inputData": "step input data information",
			"expectedOutcome": "step expected outcome information"
			},
			"UDF": {
				"StepUDFName_1": "step UDF data",
				"StepUDFName_2": "step UDF data"
			}
		},
	],
	"tcFolderID": "34758"
}

Update test case

API	/rest/testcases
Method	PUT
Impact of change	Low
Backward Compatibility	Yes
Reason for change	Added a new parameter "updateOnlyMetadata" in API request.
Changes	updateOnlyMetadata=true will only update the test case details and skip the step details. updateOnlyMetadata=false (default) will update both the test case and step details.

Version 8.8.0

Version 8.9

Request Body

{
	"tcID": 2105268,
	"tcVersionID": 2742557,
	"updateWithVersion": false,
	"notrunall": false,
	"steps": [],
	"removeSteps": [],
	"testCaseType": 680939
}

Request Body

{
	"tcID": 1303696,
	"tcVersionID": 1276964,
	"updateWithVersion": false,
	"notrunall": false,
	"steps": [],
	"removeSteps": [],
	"updateOnlyMetadata": false,
	"testCaseType": 318199
}