API for Requirement

1 Get Requirement list along with Custom Fields
2 Get Details of a Requirement
3 List Requirement version detail
4 List Requirements for Bulk Operation
5 Fetch Requirement List For Issue
6 Get List of Requirements while Linking to a Test suite
7 Fetch Requirement List For Test Case
8 View Requirement Details
9 View Requirement's Version Information
10 Create Requirement
11 Update Requirement
12 Archive Requirement
13 Delete Requirement
14 Delete Requirement Version
15 List Requirement Folders for selected folder
16 Create Requirement Folder
17 Archive Requirement Folder
18 Unarchive Requirement Folder
19 Update Requirement Folder
20 Delete Requirement Folder
21 Get List of Testcase in Requirement
22 Link Test Cases to Requirement
23 Unlink Testcase from Requirement
24 Link Issues to Requirement
25 Unlink Issue from Requirement
26 View Release & Cycle of Requirement
27 Add Release & Cycle Requirement
28 Remove Release & Cycle from Requirement
29 Get List of Users for Project
30 Get BDD Branch List
31 Pull File from Repository
32 Push File to Repository
33 Update Requirements with BDD data
34 Get BDD Folder Tree

Starting March 2026 with QMetry Test Management version 8.25.0, the documentation was migrated from Atlassian to a dedicated, standalone QMetry Test Management documentation site. For the latest updates, refer to API for Requirement.

Get Requirement list along with Custom Fields

POST /rest/requirements/list/viewColumns

Description

Fetch data of Requirements along with custom fields. Returns data from latest version.

Request

Content-Type: application/json

Parameters

Name	Located in	Required	Description	Default	Schema

Name	Located in	Required	Description	Default	Schema
viewId	body	yes	View ID of the user for that particular project and Requirement module. View ID can be fetched from latestViews section of Getinfo API.	-	integer
folderPath	body	yes	Path of folder whose Requirements are to be fetched	-	string
start	body	no	Start index of records	-	integer
limit	body	no	Number of records per page	-	integer
page	body	no	Page number to be displayed	-	integer

Response

Content-Type: application/json

Status Code	Reason	Response Model

Status Code	Reason	Response Model
200	Requirement list fetched successfully	ResponseEntity
400	Invalid json object or mandatory fields missing	-
401	Unauthorised or session expired	-
500	Returned when server connection times out	-

Get Details of a Requirement

POST /rest/requirements/list

Description

Get details of a requirement by providing ID of requirement, requirement version ID or requirement folder.

Request

Content-Type: application/json

Parameters

Name	Located in	Required	Description	Default	Schema

Name	Located in	Required	Description	Default	Schema
start	body	no	Start index of records	-	integer
limit	body	no	Number of records per page	-	integer
page	body	no	Page number to be displayed	-	integer
id	body	yes	Id of Requirement	-	integer
filter	body	no	Filter to be applied	-	string

Response

Content-Type:application/json

Status Code	Reason	Response Model

Status Code	Reason	Response Model
200	Requirement list fetch successfully	ResponseEntityString
400	Invalid json object or mandatory fields missing	-
401	Unauthorised or session expired	-
500	Returned when server connection times out	-

List Requirement version detail

POST /rest/requirements/getVersionDetail

Request

Content-Type: application/json

Parameters

Name	Located in	Required	Description	Default	Schema

Name	Located in	Required	Description	Default	Schema
rqID	body	yes	Id of Requirement	-	integer
start	body	no	Start index of records	-	integer
limit	body	no	Number of records per page	-	integer
page	body	no	Page number to be displayed	-	integer

Response

Content-Type: application/json

Status Code	Reason	Response Model

Status Code	Reason	Response Model
200	Requirement version detail list fetch successfully.	ResponseEntity
400	Invalid json object or mandatory fields missing	-