Back to QMetry All Products Help Page
API changes from v8.4.4 to v8.5
Updated APIs:
Get List of Requirement Folder and Sub Folders
Get folder/subfolder data based on folder id or list of folder with requirement
Method: GET
/rest/requirements/tree
Changes: The Request structure has been modified to provide filtering details to show/hide archived folders.
The below parameters are new in the request.
- "filter" : Object. To filter Test assets and the folder.
- Use "value":[0,1] to show archived and unarchived folder list.
- Use "value":[0] to show only unarchived folder list.
The below parameters are new in the response.
- "isArchived" : Boolean
| Version 8.4.4 | Version 8.5 |
|---|---|
Request : Request Body {
"rqFolderID": 1872,
"sort": "[{\"property\":\"name\",\"direction\":\"ASC\"}]",
"hideFolders": false
}
| Request : Request Body {
"rqFolderID": 1872,
"sort": "[{\"property\":\"name\",\"direction\":\"ASC\"}]",
"hideFolders": true,
"filter": "[{\"type\":\"list\",\"value\":[0,1],\"field\":\"isArchived\"}]"
}
|
Response : Response {
"data": [{
"id": 13664,
"name": "Folder1",
"hasChildren": 0
}],
"total": 1
}
| Response : Response {
"data": [{
"id": 49,
"name": "Folder1",
"hasChildren": 1,
"isArchived": false
}],
"total": 1
}
|
Get List of Testcase Folder and Sub Folders
Get folder/subfolder data based on folder id or list of folder with Testcase
Method: GET
/rest/testcase/tree
Changes: The Request structure has been modified to provide filtering details to show/hide archived folders.
The below parameters are new in the request.
- "filter" : Object. To filter Test assets and the folder.
- Use "value":[0,1] to show archived and unarchived folder list.
- Use "value":[0] to show only unarchived folder list.
The below parameters are new in the response.
- "isArchived" : Boolean
| Version 8.4.4 | Version 8.5 |
|---|---|
Request : Request Body {
"tcFolderID": 18333,
"sort": "[{\"property\":\"name\",\"direction\":\"ASC\"}]",
"hideFolders": false
}
| Request : Request Body {
"tcFolderID": 18712,
"sort": "[{\"property\":\"name\",\"direction\":\"ASC\"}]",
"hideFolders": true,
"filter": "[{\"type\":\"list\",\"value\":[0,1],\"field\":\"isArchived\"}]"
}
|
Response : Response {
"data": [{
"id": 13665,
"name": "Folder1",
"hasChildren": 1
}],
"total": 1
}
| Response : Response {
"data": [{
"id": 35,
"name": "Folder1",
"hasChildren": 1,
"isArchived": false
}],
"total": 1
}
|
Get List of Test suite Folder and Sub Folders
Get folder/subfolder data based on folder id or list of folder with Test Suite
Method: GET
/rest/testsuites/tree
Changes: The Request structure has been modified to provide filtering details to show/hide archived folders.
The below parameters are new in the request.
- "filter" : Object. To filter Test assets and the folder.
- Use "value":[0,1] to show archived and unarchived folder list.
- Use "value":[0] to show only unarchived folder list.
The below parameters are new in the response.
- "isArchived" : Boolean
| Version 8.4.4 | Version 8.5 |
|---|---|
Request : Request Body {
"tsFolderID": 18333,
"sort": "[{\"property\":\"name\",\"direction\":\"ASC\"}]",
"hideFolders": false
}
| Request : Request Body {
"tsFolderID": 112,
"sort": "[{\"property\":\"name\",\"direction\":\"ASC\"}]",
"hideFolders": true,
"filter": "[{\"type\":\"list\",\"value\":[0,1],\"field\":\"isArchived\"}]"
}
|
Response : Response {
"data": [{
"id": 84093,
"name": "Folder1",
"hasChildren": 0
}],
"total": 1
}
| Response : Response {
"data": [{
"id": 167,
"name": "Folder1",
"hasChildren": 1,
"isArchived": false
}],
"total": 1
}
|
Get List of Requirements for a Testcase
API to Update Test case
Method: POST
API : /rest/requirements/list/forTC
Changes: The Request structure has been modified to provide filtering data based on Custom Fields in Request.
The below parameters are new in the request.
- "udfFilter" : Object. To filter Test assets based on custom fields.
- "getColumns": Boolean
The below parameters are new in the response.
- "filterTemplate" : Object
| Version 8.4.4 | Version 8.5 |
|---|---|
Request : Request Body {
"scope": "project",
"limit": 10,
"start": 0,
"page": 1,
"getLinked": false,
"tcID": 658310
}
| Request : Request Body {
"scope": "project",
"limit": 50,
"start": 0,
"page": 1,
"getLinked": false,
"getColumns": true,
"udfFilter": "[{\"type\":\"string\",\"value\":\"111\",\"udfmID\":7,\"field\":\"UDF_udf1\"}]",
"tcID": 28
}
|
Response : Response {
"data": [{
"projectID": 1745,
"rqID": 153321,
"entityKey": "PRJ-RQ-3",
"latestUnarchivedVersion": 1,
"latestVersion": 1,
"rqVersionID": 251375,
"rqVersion": 1,
"name": "rq3",
"description": "",
"attachmentCount": 0,
"isArchived": false,
"isVersionArchived": 0,
"projectName": "Project-1",
"createdByAlias": "admin"
}],
"total": 1
}
| Response : Response {
"data": [{
"priority": 267,
"priorityAlias": "Blocker",
"componentAlias": ["Not Available"],
"projectID": 4,
"rqID": 26,
"entityKey": "PRJ-RQ-12",
"latestUnarchivedVersion": 1,
"latestVersion": 1,
"rqVersionID": 26,
"rqVersion": 1,
"cycleNameList": "Default Cycle",
"releaseNameList": "Default Release",
"name": "1",
"description": "1",
"attachmentCount": 0,
"ownerId": 1,
"updatedBy": 1,
"isArchived": false,
"isVersionArchived": false,
"projectName": "Project-1",
"requirementStateAlias": "New",
"createdByAlias": "admin",
"UDF_udf1": "111"
}],
"total": 1,
"filterTemplate": [{
"displayName": "Priority",
"field": "priorityAlias",
"fieldType": "list",
"isUDF": false
}, {
"displayName": "Created By",
"field": "createdByAlias",
"fieldType": "list",
"isUDF": false
}, {
"displayName": "Created Date",
"field": "createdDate",
"fieldType": "date",
"isUDF": false
}, {
"displayName": "Entity Key",
"field": "entityKeyId",
"fieldType": "string",
"isUDF": false
}, {
"displayName": "Updated By",
"field": "updatedByAlias",
"fieldType": "list",
"isUDF": false
}, {
"displayName": "Updated Date",
"field": "updatedDate",
"fieldType": "date",
"isUDF": false
}, {
"displayName": "External Key",
"field": "externalKey",
"fieldType": "string",
"isUDF": false
}, {
"displayName": "Created System",
"field": "createdSystem",
"fieldType": "list",
"isUDF": false
}, {
"displayName": "Status",
"field": "requirementStateAlias",
"fieldType": "list",
"isUDF": false
}, {
"displayName": "Linked Attachment(s) Count",
"field": "attachmentCount",
"fieldType": "numeric",
"isUDF": false
}, {
"displayName": "Linked Test Case(s) Count",
"field": "linkedTcCount",
"fieldType": "numeric",
"isUDF": false
}, {
"displayName": "Linked Issue(s) Count",
"field": "linkedDfCount",
"fieldType": "numeric",
"isUDF": false
}, {
"displayName": "Label(s)",
"field": "componentAlias",
"fieldType": "list",
"isUDF": false
}, {
"displayName": "Owner",
"field": "owner",
"fieldType": "list",
"isUDF": false
}, {
"displayName": "udf1",
"field": "UDF_udf1",
"fieldType": "string",
"isUDF": true,
"udfmID": 7
}]
}
|
Get List of Testcases for a Requirement
API to update test suites
Method: POST
API : /rest/testcases/list/forRQ
Changes: The Request structure has been modified to provide filtering data based on Custom Fields in Request.
- "udfFilter" : Object. To filter Test assets based on custom fields.
- "getColumns": Boolean
The below parameters are new in the response.
- "filterTemplate" : Object
| Version 8.4.4 | Version 8.5 |
|---|---|
Request : Request Body {
"limit": 10,
"start": 0,
"page": 1,
"getLinked": false,
"rqID": 153321,
"sort": "[{\"property\":\"priorityAlias\",\"direction\":\"ASC\"}]"
}
| Request : Request Body {
"limit": 50,
"start": 0,
"page": 1,
"getColumns": true,
"filter": "[{\"type\":\"list\",\"value\":[267],\"field\":\"priorityAlias\"}]",
"udfFilter": "[{\"type\":\"string\",\"value\":\"1\",\"udfmID\":8,\"field\":\"UDF_udf1\"}]",
"getLinked": false,
"rqID": 26
}
|
Response : Response {
"data": [{
"tcVersionID": 1121273,
"tcVersion": 2,
"isArchived": false,
"isParameterized": false,
"isVersionArchived": 0,
"projectID": 1745,
"projectName": "Project-1",
"tcID": 641312,
"entityKey": "PRJ-TC-1",
"isApprovalWorkflowEnabled": false,
"summary": "First v2",
"latestUnArchivedVersion": 2,
"latestAvailableVersion": 2,
"testingType": 227447,
"testingTypeAlias": "Manual",
"attachmentCount": 0,
"createdByAlias": "admin",
"createdBy": "admin"
}],
"total": 1
}
| Response : Response {
"data": [{
"tcVersionID": 58,
"tcVersion": 1,
"isArchived": false,
"isParameterized": false,
"isVersionArchived": false,
"projectID": 4,
"projectName": "Project-1",
"tcID": 28,
"entityKey": "PRJ-TC-12",
"isApprovalWorkflowEnabled": false,
"summary": "2",
"latestUnArchivedVersion": 1,
"latestAvailableVersion": 1,
"priorityId": 267,
"priorityAlias": "Blocker",
"cycleNameDetail": "Default Cycle",
"releaseNameDetail": "Default Release",
"buildName": "Default Cycle",
"testCaseState": 270,
"testCaseStateAlias": "New",
"testingType": 274,
"testingTypeAlias": "Manual",
"testCaseType": 278,
"testCaseTypeAlias": "BVT",
"attachmentCount": 0,
"componentAlias": ["Not Available"],
"createdByAlias": "admin",
"createdBy": "admin",
"UDF_udf1": "111"
}],
"total": 1,
"filterTemplate": [{
"displayName": "Priority",
"field": "priorityAlias",
"fieldType": "list",
"isUDF": false
}, {
"displayName": "Created By",
"field": "createdByAlias",
"fieldType": "list",
"isUDF": false
}, {
"displayName": "Created Date",
"field": "createdDate",
"fieldType": "date",
"isUDF": false
}, {
"displayName": "Entity Key",
"field": "entityKeyId",
"fieldType": "string",
"isUDF": false
}, {
"displayName": "Updated Date",
"field": "updatedDate",
"fieldType": "date",
"isUDF": false
}, {
"displayName": "Updated By",
"field": "updatedByAlias",
"fieldType": "list",
"isUDF": false
}, {
"displayName": "Owner",
"field": "owner",
"fieldType": "list",
"isUDF": false
}, {
"displayName": "Estimated Time",
"field": "executionMinutes",
"fieldType": "numeric",
"isUDF": false
}, {
"displayName": "Status",
"field": "testCaseStateAlias",
"fieldType": "list",
"isUDF": false
}, {
"displayName": "Testing Type",
"field": "testingTypeAlias",
"fieldType": "list",
"isUDF": false
}, {
"displayName": "Test Category",
"field": "testCaseTypeAlias",
"fieldType": "list",
"isUDF": false
}, {
"displayName": "Label(s)",
"field": "componentAlias",
"fieldType": "list",
"isUDF": false
}, {
"displayName": "Linked Attachment(s) Count",
"field": "attachmentCount",
"fieldType": "numeric",
"isUDF": false
}, {
"displayName": "Linked Issue(s) Count",
"field": "linkedDfCount",
"fieldType": "numeric",
"isUDF": false
}, {
"displayName": "Linked Requirement(s) Count",
"field": "linkedRqCount",
"fieldType": "numeric",
"isUDF": false
}, {
"displayName": "Linked Testsuite(s) Count",
"field": "linkedTsCount",
"fieldType": "numeric",
"isUDF": false
}, {
"displayName": "Approved By",
"field": "approvedByAlias",
"fieldType": "list",
"isUDF": false
}, {
"displayName": "udf1",
"field": "UDF_udf1",
"fieldType": "string",
"isUDF": true,
"udfmID": 8
}, {
"displayName": "Summary",
"field": "summary",
"fieldType": "string",
"isUDF": false
}, {
"displayName": "isParameterized",
"field": "isParameterized",
"fieldType": "list",
"isUDF": false
}]
}
|
Get List of Requirements while Linking to a Test suite
API to get Requirement list for Test Suite.
Method: POST
API : /rest/requirements/list/forTS
Changes: The request body is modified to include option to filter data based on Custom Fields in Request
- "udfFilter" : object
| Version 8.4.4 | Version 8.5 |
|---|---|
Request :Request Body {
"start": 0,
"limit": 10,
"page": 1,
"scope": "project",
"filter": "[{ "
value ":[ "
Major "], "
type ": "
list ", "
field ": "
priorityAlias "}]"
}
| Request :Request Body {
"start": 0,
"limit": 10,
"page": 1,
"scope": "project",
"getColumns": true,
"filter": "[{ "
type ": "
list ", "
value ":[1457,1458], "
field ": "
priorityAlias "}]",
"udfFilter": "[{ "
type ": "
string ", "
value ": "
test ", "
udfmID ":3294, "
field ": "
UDF_String "}]"
}
|
Response : Response {
"data": [{
"projectID": 1745,
"rqID": 153321,
"entityKey": "TPP-RQ-3",
"latestUnarchivedVersion": 1,
"latestVersion": 1,
"rqVersionID": 251375,
"rqVersion": 1,
"summary": "rq3",
"description": "",
"attachmentCount": 0,
"isArchived": false,
"isVersionArchived": 0,
"projectName": "testParam",
"createdByAlias": "rahul",
"priority": 328,
"priorityAlias": "Major"
}],
"total": 1
}
| Response : Response {
"data": [{
"projectID": 1745,
"rqID": 153321,
"entityKey": "TPP-RQ-3",
"latestUnarchivedVersion": 1,
"latestVersion": 1,
"rqVersionID": 251375,
"rqVersion": 1,
"summary": "rq3",
"description": "",
"attachmentCount": 0,
"isArchived": false,
"isVersionArchived": 0,
"projectName": "testParam",
"createdByAlias": "rahul",
"UDF_String": "test",
"priority": 328,
"priorityAlias": "Major"
}],
"filterTemplate": [{
"displayName": "Priority",
"field": "priorityAlias",
"fieldType": "list",
"isUDF": false
}, {
"displayName": "Created By",
"field": "createdByAlias",
"fieldType": "list",
"isUDF": false
}, {
"displayName": "Created Date",
"field": "createdDate",
"fieldType": "date",
"isUDF": false
}, {
"displayName": "Entity Key",
"field": "entityKeyId",
"fieldType": "string",
"isUDF": false
}, {
"displayName": "Updated By",
"field": "updatedByAlias",
"fieldType": "list",
"isUDF": false
}, {
"displayName": "Updated Date",
"field": "updatedDate",
"fieldType": "date",
"isUDF": false
}, {
"displayName": "External Key",
"field": "externalKey",
"fieldType": "string",
"isUDF": false
}, {
"displayName": "Created System",
"field": "createdSystem",
"fieldType": "list",
"isUDF": false
}, {
"displayName": "Status",
"field": "requirementStateAlias",
"fieldType": "list",
"isUDF": false
}, {
"displayName": "Linked Attachment(s) Count",
"field": "attachmentCount",
"fieldType": "numeric",
"isUDF": false
}, {
"displayName": "Linked Test Case(s) Count",
"field": "linkedTcCount",
"fieldType": "numeric",
"isUDF": false
}, {
"displayName": "Linked Issue(s) Count",
"field": "linkedDfCount",
"fieldType": "numeric",
"isUDF": false
}, {
"displayName": "Label(s)",
"field": "componentAlias",
"fieldType": "list",
"isUDF": false
}, {
"displayName": "Owner",
"field": "owner",
"fieldType": "list",
"isUDF": false
}, {
"displayName": "str",
"field": "UDF_String ",
"fieldType": "string",
"isUDF": true,
"udfmID": 3294
}],
"total": 1
}
|
Get List of Testcases while Linking to a Test suite
API to update parameter and its values
Method: POST
API : /rest/testcases/list/forTS
Changes: The request body is modified to include option to filter data based on Custom Fields in Request
- "udfFilter" : object
| Version 8.4.4 | Version 8.5 |
|---|---|
Request :Request Body {
"limit": 50,
"start": 0,
"page": 1,
"getColumns": true,
"udfFilter": "[{"
type ":"
string ","
value ":"
111 ","
udfmID ":8,"
field ":"
UDF_udf1 "}]",
"showAllStateEntities": true,
"getLinked": false
}
| Request :Request Body {
"data": [{
"tsID": 45,
"projectID": 4,
"entityKey": "PRJ-TS-2",
"tsFolderID": 79,
"name": "2",
"linkedTcCount": 1,
"linkedPlatform": 1,
"platform": "No Platform",
"attachmentCount": 0,
"releaseNameList": "Default Release",
"cycleNameList": "Default Cycle",
"createdDate": "12-20-2018 12:22:17 AM",
"updatedDate": "12-26-2018 04:49:12 AM",
"createdBy": "admin",
"createdByAlias": "admin",
"ownerAlias": "admin",
"testSuiteState": 287,
"testSuiteStateAlias": "New",
"isCycleArchived": false,
"isReleaseArchived": false,
"isPlatformArchived": false,
"isArchived": false,
"UDF_udf1": "111"
}],
"total": 1,
"filterTemplate": [{
"displayName": "Status",
"field": "testsuiteStatus",
"fieldType": "list",
"isUDF": false
}, {
"displayName": "Created By",
"field": "createdByAlias",
"fieldType": "list",
"isUDF": false
}, {
"displayName": "Created Date",
"field": "createdDate",
"fieldType": "date",
"isUDF": false
}, {
"displayName": "Entity Key",
"field": "entityKeyId",
"fieldType": "string",
"isUDF": false
}, {
"displayName": "Linked Attachment(s) Count",
"field": "attachmentCount",
"fieldType": "numeric",
"isUDF": false
}, {
"displayName": "Linked Platform(s) Count",
"field": "linkedPlatformCount",
"fieldType": "numeric",
"isUDF": false
}, {
"displayName": "Linked Test Case(s) Count",
"field": "linkedTcCount",
"fieldType": "numeric",
"isUDF": false
}, {
"displayName": "Updated By",
"field": "updatedByAlias",
"fieldType": "list",
"isUDF": false
}, {
"displayName": "Updated Date",
"field": "updatedDate",
"fieldType": "date",
"isUDF": false
}, {
"displayName": "Owner",
"field": "owner",
"fieldType": "list",
"isUDF": false
}, {
"displayName": "Remaining Execution Time",
"field": "remExecutionTime",
"fieldType": "numeric",
"isUDF": false
}, {
"displayName": "Total Execution Time",
"field": "totalExecutionTime",
"fieldType": "numeric",
"isUDF": false
}, {
"displayName": "udf1",
"field": "UDF_udf1",
"fieldType": "string",
"isUDF": true,
"udfmID": 10
}],
"UDFTypeData": {
"UDF_udf1": "STRING"
}
}
|
Response : Response {
"data": [{
"tcVersionID": 1154522,
"tcVersion": 1,
"isArchived": false,
"isParameterized": false,
"isVersionArchived": 0,
"projectID": 1745,
"projectName": "Project-1",
"tcID": 658310,
"entityKey": "PRJ-TC-13",
"isApprovalWorkflowEnabled": false,
"summary": "Add two numbers 4 & 1",
"latestUnArchivedVersion": 1,
"latestAvailableVersion": 1,
"testingType": 227448,
"testingTypeAlias": "Automated",
"attachmentCount": 0,
"createdByAlias": "admin",
"createdBy": "admin"
}],
"total": 1
}
| Response : Response {
"data": [{
"tcVersionID": 58,
"tcVersion": 1,
"isArchived": false,
"isParameterized": false,
"isVersionArchived": false,
"projectID": 4,
"projectName": "Project-1",
"tcID": 28,
"entityKey": "PRJ-TC-12",
"isApprovalWorkflowEnabled": false,
"summary": "2",
"latestUnArchivedVersion": 1,
"latestAvailableVersion": 1,
"priorityId": 267,
"priorityAlias": "Blocker",
"cycleNameDetail": "Default Cycle",
"releaseNameDetail": "Default Release",
"buildName": "Default Cycle",
"testCaseState": 270,
"testCaseStateAlias": "New",
"testingType": 274,
"testingTypeAlias": "Manual",
"testCaseType": 278,
"testCaseTypeAlias": "BVT",
"attachmentCount": 0,
"componentAlias": ["Not Available"],
"createdByAlias": "admin",
"createdBy": "admin",
"UDF_udf1": "111"
}],
"total": 1,
"filterTemplate": [{
"displayName": "Priority",
"field": "priorityAlias",
"fieldType": "list",
"isUDF": false
},
{
"displayName": "Created By",
"field": "createdByAlias",
"fieldType": "list",
"isUDF": false
},
{
"displayName": "Created Date",
"field": "createdDate",
"fieldType": "date",
"isUDF": false
},
{
"displayName": "Entity Key",
"field": "entityKeyId",
"fieldType": "string",
"isUDF": false
},
{
"displayName": "Updated Date",
"field": "updatedDate",
"fieldType": "date",
"isUDF": false
},
{
"displayName": "Updated By",
"field": "updatedByAlias",
"fieldType": "list",
"isUDF": false
},
{
"displayName": "Owner",
"field": "owner",
"fieldType": "list",
"isUDF": false
},
{
"displayName": "Estimated Time",
"field": "executionMinutes",
"fieldType": "numeric",
"isUDF": false
},
{
"displayName": "Status",
"field": "testCaseStateAlias",
"fieldType": "list",
"isUDF": false
},
{
"displayName": "Testing Type",
"field": "testingTypeAlias",
"fieldType": "list",
"isUDF": false
},
{
"displayName": "Test Category",
"field": "testCaseTypeAlias",
"fieldType": "list",
"isUDF": false
},
{
"displayName": "Label(s)",
"field": "componentAlias",
"fieldType": "list",
"isUDF": false
},
{
"displayName": "Linked Attachment(s) Count",
"field": "attachmentCount",
"fieldType": "numeric",
"isUDF": false
},
{
"displayName": "Linked Issue(s) Count",
"field": "linkedDfCount",
"fieldType": "numeric",
"isUDF": false
},
{
"displayName": "Linked Requirement(s) Count",
"field": "linkedRqCount",
"fieldType": "numeric",
"isUDF": false
},
{
"displayName": "Linked Testsuite(s) Count",
"field": "linkedTsCount",
"fieldType": "numeric",
"isUDF": false
}, {
"displayName": "udf1",
"field": "UDF_udf1",
"fieldType": "string",
"isUDF": true,
"udfmID": 8
}, {
"displayName": "Summary",
"field": "summary",
"fieldType": "string",
"isUDF": false
}, {
"displayName": "isParameterized",
"field": "isParameterized",
"fieldType": "list",
"isUDF": false
}
]
}
|
Deprecated APIs:
Below APIs will be deprecated in March,2019.
Get list of Issue linked to Test case Run
Get list of issue linked to Test case Step Run
Get list of Testcase Step Run for a Test Case execution
Back to QMetry All Products Help Page