Back to QMetry All Products Help Page
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 |
|---|---|---|---|---|---|
| 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 |
| scope | body | yes | "project" | - | string |
Response
Content-Type: application/json
| 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.
Request
Content-Type: application/json
Parameters
| 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 |
|---|---|---|
| 200 | Requirement list fetch successfully | ResponseEntity |
| 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
Parameters
| 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 |
|---|---|---|
| 200 | Requirement version detail list fetch successfully. | ResponseEntity |
| 400 | Invalid json object or mandatory fields missing | - |
| 401 | Unauthorised or session expired | - |
| 500 | Returned when server connection times out | - |
List Requirements for Bulk Operation
POST /rest/requirements/listForBulkOperation
Request
Content-Type: application/json
Parameters
| Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
| folderPath | body | yes | FolderPath of folder whose requirements are to be listed | - | 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 |
| filter | body | no | Filters to apply | - | Array[Filter] |
Response
Content-Type: application/json
| Status Code | Reason | Response Model |
|---|---|---|
| 200 | Requirement list fetch successfully | ResponseEntity |
| 400 | Invalid json object or mandatory fields missing | - |
| 401 | Unauthorised or session expired | - |
| 500 | Returned when server connection times out | - |
Fetch Requirement List For Issue
POST /rest/requirements/list/forIS
Description
Get Requirement list based on particular id of issue.
Request
Content-Type: application/json
Parameters
| Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
| dfID | body | no | Id of issue | - | integer |
| start | body | no | Start index of records | - | integer |
| getLinked | body | no | True to get only those requirements that are linked with this Issue, false to get those requirements which are not linked with this Issue | - | boolean |
| limit | body | no | Number of records per page | - | integer |
| page | body | no | Page number to be displayed | - | integer |
| getColumns | body | no | True to get list of all available filters(System + UDF) in 'filterTemplate' field | - | boolean |
| udfFilter | body | no | Apply filter on user defined fields' values | - | Array[UdfFilter] |
| filter | body | no | System filters to be applied | - | Array[Filter] |
Response
Content-Type: application/json
| Status Code | Reason | Response Model |
|---|---|---|
| 200 | Requirement list fetch successfully | ResponseEntity |
| 400 | Invalid json object or mandatory fields missing | - |
| 401 | Unauthorised or session expired | - |
| 500 | Returned when server connection times out | - |
Get List of Issues for a Requirement
POST /rest/issues/list/ForRQ
Description
Get issue list based on the particular requirement
Request
Content-Type: application/json
Parameters
| 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 |
| getColumns | body | no | True to get list of all available filters(System + UDF) in 'filterTemplate' field | - | boolean |
| udfFilter | body | no | Apply filter on user defined fields' values | - | Array[UdfFilter] |
| getLinked | body | no | True to get only those issues that are linked with this Requirement, false to get those issues which are not linked with this Requirement | - | boolean |
| rqID | body | no | Id of Requirement | - | integer |
| filter | body | no | System filters to be applied | - | Array[Filter] |
Response
Content-Type: application/json
| Status Code | Reason | Response Model |
|---|---|---|
| 200 | List of issues shown successfully | ResponseEntity |
| 400 | Invalid json object or mandatory fields missing | - |
| 401 | Unauthorised or session expired | - |
| 500 | Returned when server connection times out | - |
Get List of Requirements while Linking to a Test suite
POST /rest/requirements/list/forTS
Description
Requirement list for Test Suite.
Request
Content-Type: application/json
Parameters
| 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 |
Response
Content-Type: application/json
| Status Code | Reason | Response Model |
|---|---|---|
| 200 | Requirement list fetch successfully | ResponseEntity |
| 400 | Invalid json object or mandatory fields missing | - |
| 401 | Unauthorised or session expired | - |
| 500 | Returned when server connection times out | - |
Fetch Requirement List For Test Case
POST /rest/requirements/list/forTC
Description
Get Requirement list based on particular id of test case.
Request
Content-Type: application/json
Parameters
| Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
| tcID | body | no | Id of testcase | - | integer |
| start | body | no | Start index of records | - | integer |
| getLinked | body | no | True to get only those requirements that are linked with this Testcase, false to get those requirements which are not linked with this Testcase | - | boolean |
| showEntityWithReleaseCycle | body | no | List only Requirement which have given tcID's release and cycle | - | boolean |
| 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 |
|---|---|---|
| 200 | Requirement list fetch successfully | ResponseEntity |
| 400 | Invalid json object or mandatory fields missing | - |
| 401 | Unauthorised or session expired | - |
| 500 | Returned when server connection times out | - |
View Requirement Details
POST /rest/requirements/detail/data
Description
To view particular requirement's all fields
Request
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
| version | body | yes | Version number of Requirement | - | integer |
| id | body | yes | Id of Requirement | - | integer |
Response
Content-Type: application/json
| Status Code | Reason | Response Model |
|---|---|---|
| 200 | Requirement fetch successfully | ResponseEntity |
| 400 | Invalid json object or mandatory fields missing | - |
| 401 | Unauthorised or session expired | - |
| 500 | Returned when server connection times out | - |
View Requirement's Version Information
POST /rest/requirements/versions/{id}
Request
Parameters
| Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
| entityId | body | yes | Id of Requirement | - | integer |
| filter | body | no | filters to apply | - | Array[Filter] |
| id | path | yes | Id of Requirement | - | integer |
Response
Content-Type: application/json
| Status Code | Reason | Response Model |
|---|---|---|
| 200 | Requirement Version detail fetch successfully | ResponseEntity |
| 400 | Invalid json object or mandatory fields missing | - |
| 401 | Unauthorised or session expired | - |
| 500 | Returned when server connection times out |
Create Requirement
POST /rest/requirements
Request
Content-Type:application/json
Parameters
| Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
| rqFolderId | body | yes | FolderId of Requirement | - | string |
| name | body | yes | Summary of the Requirement | - | string |
| priority | body | no | Priority of Requirement | - | Array[integer] |
| component | body | no | Label of Requirement | - | Array[integer] |
| requirementState | body | no | Status of Requirement | - | Array[integer] |
| description | body | no | Description of Requirement | - | string |
| owner | body | no | Owner of Requirement | - | integer |
| scope | body | yes | Scope of the Requirement, possible values project,release,cycle,build | - | string |
Response
Content-Type: application/json
| Status Code | Reason | Response Model |
|---|---|---|
| 200 | Requirement created successfully | ResponseEntity |
| 400 | Returned in case of- Invalid json/project/client | - |
| 500 | Returned when server connection times out | - |
Update Requirement
PUT /rest/requirements
Request
Content-Type: application/json
Parameters
| Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
| updateVersionFlag | body | no | Version number of Requirement | - | integer |
| updateWithVersion | body | no | Flag for the requirement update with version or not | - | boolean |
| description | body | no | Description of the Requirement | - | string |
| rqId | body | yes | Id of Requirement | - | integer |
| rqVersionId | body | yes | VersionId of Requirement | - | integer |
| requirementState | body | no | Status of Requirement | - | Array[integer] |
| priority | body | no | Priority of Requirement | - | Array[integer] |
| owner | body | no | Owner of Requirement | - | integer |
| name | body | no | Summary of Requirement | - | string |
| component | body | no | Label of Requirement | - | Array[integer] |
Response
Content-Type: application/json
| Status Code | Reason | Response Model |
|---|---|---|
| 200 | Requirement updated successfully | RequirementRepository |
| 400 | Returned in case of- Invalid json object or invalid UDF | - |
| 401 | Unautorised, insufficient privileges or session expired | - |
| 500 | Returned when server connection times out | - |
Archive Requirement
POST /rest/requirements/archiveEntity
Description
API To archive requirement based on specific version or all version
Request
Content-Type: application/json
Parameters
| Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
| entityIds | body | yes | An array of requirementId or requirementVersionId | - | Array[integer] |
| isArchived | body | yes | True for archive, false for unarchive | - | boolean |
| isEntityVersion | body | no | True for archive specific version of Requirement otherwise false | - | boolean |
Response
Content-Type: application/json
| Status Code | Reason | Response Model |
|---|---|---|
| 200 | Requirement archive successfully | ResponseEntity |
| 400 | Invalid json object or mandatory fields missing | - |
| 401 | Unauthorised or session expired | - |
| 500 | Returned when server connection times out | - |
Delete Requirement
POST /rest/requirements/deleteEntity
Description
API To Delete Requirement
Request
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
| entityIds | body | yes | An array of RequirementId | - | Array[integer] |
Response
Content-Type: application/json
| Status Code | Reason | Response Model |
|---|---|---|
| 200 | Requirement deleted successfully | ResponseEntity |
| 400 | Invalid json object or mandatory fields missing | - |
| 401 | Unauthorised or session expired | - |
| 500 | Returned when server connection times out | - |
Delete Requirement Version
POST /rest/requirements/deleteEntityVersion
Description
API To Delete Requirement Version
Request
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
| entityId | body | yes | Id of Requirement | - | integer |
| entityVersions | body | yes | An array of version number of the Requirement | - | Array[integer] |
Response
Content-Type: application/json
| Status Code | Reason | Response Model |
|---|---|---|
| 200 | Requirement version deleted successfully | ResponseEntity |
| 400 | Invalid json object or mandatory fields missing | - |
| 401 | Unauthorised or session expired | - |
| 500 | Returned when server connection times out | - |
Get Requirement Folder/Sub Folder List (Deprecated)
GET /rest/requirements/tree
Description
Get folder/subfolder data based on folder id or list of folder with requirement
Request
Content-Type: application/json
Parameters
| Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
| rqActiveScope | query | no | Scope of Requirement, possible values are btnRqScopeToolCycle,btnRqScopeToolRelease,btnRqScopeToolProject | - | string |
| rqSortTreeColumn | query | no | Sort criteria based on which Requirement folders list will be obtained | - | string |
| rqSortTreeDir | query | no | Direction of sorting, possible values ASC or DESC | - | string |
| node | query | yes | Id of parent folder whose sub folders are to be fetched | - | integer |
| hideFolders | query | no | Send to true to hide empty folders | - | boolean |
| showEntity | query | no | True for fetch folder data with list of requirement inside folder, false for only folder data | - | boolean |
| scope | query | yes | Scope of Requirement, possible value likes project,cycle,release | - | string |
Response
Content-Type: application/json
| Status Code | Reason | Response Model |
|---|---|---|
| 200 | Successfully get requirement list | ResponseEntity |
| 400 | Mandatory field(s) is missing. | - |
| 401 | Unauthorised or session expired | - |
| 500 | Returned if there is an error in server | - |
List Requirement Folders for selected folder
POST /rest/requirements/tree
Request
Content-Type: application/json
Parameters
| Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
| rqFolderID | body | yes | Folder ID of Selected Requirement Folder | - | integer |
| hideFolders | body | no | Flag to Hide empty Folders | - | boolean |
| sort | body | no | Sort Folders by date or name | - | string |
Response
Content-Type: application/json
| Status Code | Reason | Response Model |
|---|---|---|
| 200 | Requirement folders detail list fetch successfully. | ResponseEntity |
| 400 | Invalid json object or mandatory fields missing | - |
| 401 | Unauthorised or session expired | - |
| 500 | Returned when server connection times out | - |
Create Requirement Folder
POST /rest/requirements/folders
Request
Content-Type: application/json
Parameters
| Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
| parentId | body | yes | Id of parent folder | - | integer |
| name | body | yes | Folder Name | - | string |
Response
Content-Type: application/json
| Status Code | Reason | Response Model |
|---|---|---|
| 200 | Successful creation of requirement folder | ResponseEntity |
| 400 | Mandatory field(s) is missing. | - |
| 401 | Unauthorised or session expired | - |
| 500 | Returned if there is an error in server | - |
Archive Requirement Folder
POST /rest/requirements/folder/archive
Request
Content-Type: application/json
Parameters
| Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
| Archive Folder Request | body | yes | Archive Folder Inputs | - | RqFolderArchiveRequestDetail |
Response
Content-Type: application/json
| Status Code | Reason | Response Model |
|---|---|---|
| 200 | Folder archived successfully | ResponseEntity |
| 400 | Following fields are missing:rqFolderIDs | - |
| 401 | Unauthorised or session expired | - |
| 500 | Returned when server connection times out | - |
Unarchive Requirement Folder
POST /rest/requirements/folder/unarchive
Request
Content-Type: application/json
Parameters
| Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
| Unarchive Folder Request | body | yes | Unarchive Folder Inputs | - | RqFolderUnarchiveRequestDetail |
Response
Content-Type: application/json
| Status Code | Reason | Response Model |
|---|---|---|
| 200 | Folder unarchived successfully | ResponseEntity |
| 400 | Following fields are missing:rqFolderIDs | - |
| 401 | Unauthorised or session expired | - |
| 500 | Returned when server connection times out | - |
Update Requirement Folder
PUT /rest/requirements/folders
Request
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
| name | body | yes | Updated Folder Name | - | string |
| folderId | body | yes | Unique identifier of Requirement Folder to update | - | integer |
Response
Content-Type: application/json
| Status Code | Reason | Response Model |
|---|---|---|
| 200 | Successful updation of requirement folder | ResponseEntity |
| 400 | Mandatory field(s) is missing. | - |
| 401 | Unauthorised or session expired | - |
| 500 | Returned if there is an error in server | - |
Delete Requirement Folder
POST /rest/requirements/folders/delete
Request
Content-Type: application/json
Parameters
| Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
| folderId | body | yes | FolderId of Requirement | - | integer |
Response
Content-Type: application/json
| Status Code | Reason | Response Model |
|---|---|---|
| 200 | Requirement folder deleted successfully. | ResponseEntity |
| 400 | Invalid json object or tried to delete root folder | - |
| 500 | Returned when server connection times out | - |
Get List of Testcase in Requirement [Deprecated]
POST /rest/requirements/testcase/list
Request
Content-Type: application/json
Parameters
| Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
| rqID | body | yes | Id of Requirement | - | integer |
| limit | body | yes | Number of record per page | - | integer |
| page | body | yes | Page number to be displayed | - | integer |
| start | body | yes | Start index of records | - | integer |
Response
Content-Type: application/json
| Status Code | Reason | Response Model |
|---|---|---|
| 200 | Testcase list fetch successfully | ResponseEntity |
| 400 | Invalid json object or mandatory fields missing | - |
| 401 | Unauthorised or session expired | - |
| 500 | Returned when server connection times out | - |
Get Testcase List for Requirement
POST /rest/testcases/list/forRQ
Getting test case list based on particular id of requirement.
Request
Content-Type: application/json
Parameters
| Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
| rqID | body | no | Id of Requirement | - | integer |
| start | body | no | Start index of records | - | integer |
| getLinked | body | no | True to get only those testcases that are linked with this Requirement, false to get those testcases which are not linked with this Requirement | - | boolean |
| showEntityWithReleaseCycle | body | no | List only Testcase which have given rqID's release and cycle | - | boolean |
| limit | body | no | Number of records per page | - | integer |
| page | body | no | Page number to be displayed | - | integer |
| getColumns | body | no | True to get list of all available filters(System + UDF) in 'filterTemplate' field | - | boolean |
| udfFilter | body | no | Apply filter on user defined fields' values | - | Array[UdfFilter] |
| filter | body | no | System filters to be applied | - | Array[Filter] |
Response
Content-Type: application/json
| Status Code | Reason | Response Model |
|---|---|---|
| 200 | Testcase list fetch successfully | ResponseEntity |
| 400 | Invalid json object or mandatory fields missing | - |
| 401 | Unauthorised or session expired | - |
| 500 | Returned when server connection times out | - |
Link Test Cases to Requirement
PUT /rest/requirements/link/testcases
Request
Content-Type: application/json
Parameters
| Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
| rqID | body | yes | Entitykey of the Requirement | - | string |
| rqVersionId | body | yes | Comma-separated list of versionId to the Requirement | - | string |
| tcVersionIds | body | yes | VersionId of Test Case | - | integer |
| rqEntitykeys | body | no | Comma-separated list of EntityKey to the Requirement | - | string |
Response
Content-Type: application/json
| Status Code | Reason | Response Model |
|---|---|---|
| 200 | Testcase(s) linked successfully | ResponseEntity |
| 400 | Returned in case of- Invalid rqVersionId/tcVersionIds or failed operation | - |
| 500 | Returned when server connection times out | - |
Unlink Testcase from Requirement
PUT /rest/requirements/unlink/testcases
Description
API to unlink testcase(s) from requirement
Request
Content-Type: application/json
Parameters
| Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
| rqID | body | yes | Entitykey of the Requirement | - | string |
| rqVersionId | body | yes | VersionId of Requirement | - | integer |
| tcVersionIds | body | yes | An array of testcase version's Id | - | Array[integer] |
Response
Content-Type: application/json
| Status Code | Reason | Response Model |
|---|---|---|
| 200 | Testcase unlink successfully | ResponseEntity |
| 400 | Invalid json object or mandatory fields missing | - |
| 401 | Unauthorised or session expired | - |
| 500 | Returned when server connection times out | - |
Link Issues to Requirement
PUT /rest/requirements/link/issues
Request
Content-Type: application/json
Parameters
| Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
| rqID | body | yes | EntityKey of Requirement | - | string |
| dfIDs | body | yes | IDs of Issues to be linked with Requirement | - | Array[integer] |
Response
Content-Type: application/json
| Status Code | Reason | Response Model |
|---|---|---|
| 200 | Issues successfully linked to requirement | ResponseEntity |
| 400 | Invalid json object or mandatory fields missing | - |
| 401 | Unauthorised or session expired | - |
| 500 | Returned when server connection times out | - |
Unlink Issue from Requirement
PUT /rest/requirements/unlink/issues
Description
API to unlink issue from requirement
Request
Content-Type: application/json
Parameters
| Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
| dfIDs | body | yes | An array of issue Id | - | Array[integer] |
| rqID | body | yes | EntityKey of Requirement | - | string |
Response
Content-Type: application/json
| Status Code | Reason | Response Model |
|---|---|---|
| 200 | unlink issue successfully | ResponseEntity |
| 400 | Invalid json object or mandatory fields missing | - |
| 401 | Unauthorised or session expired | - |
| 500 | Returned when server connection times out | - |
View Release & Cycle of Requirement
PUT /rest/requirements/scope/list
Description
To view list of scope(Release/Cycle) for requirement
Request
Content-Type: application/json
Parameters
| Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
| entityID | body | yes | Id of Requirement | - | integer |
| limit | body | yes | Number of record per page | - | integer |
| page | body | yes | Page number to be displayed | - | integer |
| start | body | yes | Start index of records | - | integer |
Response
Content-Type: application/json
| Status Code | Reason | Response Model |
|---|---|---|
| 200 | Scope(Release/Cycle) fetch successfully | ResponseEntity |
| 400 | Invalid json object or mandatory fields missing | - |
| 401 | Unauthorised or session expired | - |
| 500 | Returned when server connection times out | - |
Add Release & Cycle Requirement
POST /rest/requirements/scope/add
Request
Content-Type: application/json
Parameters
| Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
| entityId | body | yes | Id of Requirement | - | integer |
| sourceBuildId | body | yes | BuildId of the Cycle associated with Release | - | integer |
| sourceProjectId | body | yes | ProjectId of the Requirement | - | integer |
| sourceReleaseId | body | yes | ReleaseId of the Project | - | integer |
| sourceScope | body | yes | Scope for the requirement likes to project, release, build, cycle | - | string |
| entityType | body | yes | Entity type for the requirement, the default value is RQ | - | string |
| releaseCycleMapping | body | yes | An array of release, cycle & version mapping | - | Array[ReleaseCycleMapping] |
| opType | body | yes | Operation types possible value likes otherscope or current | - | string |
| withVersion | body | no | Scope added with the version or not | - | boolean |
| updateFlag | body | no | This flag for the scope update or not | - | boolean |
| destinationProjectId | body | yes | ProjectId based on operation type, possible value likes current project or another project of the id | - | integer |
| entityData | body | yes | An array of entityId & version for the Requirement | - | Array[EntityData] |
Response
Content-Type: application/json
| Status Code | Reason | Response Model |
|---|---|---|
| 200 | Add to scope successfully | ResponseEntity |
| 400 | Invalid json object or mandatory fields missing | - |
| 401 | Unauthorised or session expired | - |
| 500 | Returned when server connection times out | - |
Remove Release & Cycle from Requirement
POST /rest/requirements/scope/remove
Description
API to remove scope(release/cycle) from requirement
Request
Content-Type: application/json
Parameters
| Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
| entityId | body | yes | Id of Requirement | - | integer |
| sourceBuildId | body | yes | BuildId of the Cycle associated with Release | - | integer |
| sourceProjectId | body | yes | ProjectId of Requirement | - | integer |
| sourceReleaseId | body | yes | ReleaseId of the Project | - | integer |
| entityType | body | yes | Entity type for the requirement, the default value is RQ | - | string |
| opType | body | yes | Operation types possible value likes currentBuild,allBuildsInRelease,allReleases | - | string |
Response
Content-Type: application/json
| Status Code | Reason | Response Model |
|---|---|---|
| 200 | Remove scope successfully | ResponseEntity |
| 400 | Invalid json object or mandatory fields missing | - |
| 401 | Unauthorised or session expired | - |
| 500 | Returned when server connection times out | - |
Get List of Users for Project
POST /rest/requirements/list/projectUsers
Request
Content-Type: application/json
Parameters
| Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
| projectId | body | yes | ProjectId | - | integer |
| rqId | body | yes | Id of Requirement | - | integer |
Response
Content-Type: application/json
| Status Code | Reason | Response Model |
|---|---|---|
| 200 | successfully get list of users for project | ResponseEntity |
| 400 | Invalid json object or mandatory fields missing | - |
| 500 | Returned when server connection times out | - |
Get BDD Branch List
POST /rest/requirements/getBranchList
Description
Get the branch of repository.
Request
Content-Type: application/json
Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
| bddConfigID | body | yes | ID of BDD repository for particular project from DB. | - | integer |
Response
Content-Type: application/json
| Status Code | Reason | Response Model |
|---|---|---|
| 200 | Branch list fetched successfully. | ResponseEntity |
| 400 | Missing mandatory fields. | - |
| 401 | Unauthorised or session expired | - |
| 500 | Returned when server connection times out | - |
Pull File from Repository
POST /rest/requirements/pullFile
Request
Content-Type: application/json
Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
| bddConfigrationID | body | yes | ID of BDD repository for particular project from DB. | integer | |
| fileName | body | yes | Name of the file which needs to get data from the repository. | string | |
| bddFolderPath | body | yes | Folder path of the repository where the file is located. If it is on root level, then there will be empty data. | string | |
| rqVersionID | body | yes | ID of rqversion from DB. | integer | |
| bddBranch | body | yes | Branch name of the repository from where the data will be pulled. | string |
Response
Content-Type: application/json
| Status Code | Reason | Response Model |
|---|---|---|
| 200 | File data pulled successfully. | ResponseEntity |
| 400 | Missing mandatory fields. | - |
| 401 | Unauthorised or session expired | - |
| 500 | Returned when server connection times out | - |
Push File to Repository
POST /rest/requirements/pushFile
Request
Content-Type: application/json
Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
| bddData | body | yes | Content that needs to be pushed to the repository. | string | |
| bddConfigrationID | body | yes | ID of BDD repository for particular project from DB. | integer | |
| fileName | body | yes | Name of the file to push the data to repository. | string | |
| bddFolderPath | body | yes | Folder path of repository where the file is located. If it is on root level, then there will be empty data. | string | |
| comments | body | yes | Push comments for file. | string | |
| rqVersionID | body | yes | Requirement Version ID. | integer | |
| bddBranch | body | yes | Branch name of repository from where data will get pushed. | string | |
| notifyUser | body | no | Whether to notify user (in "userList" parameter) or not. | boolean | |
| userList | body | *no *(needed if notifyUser is set "true") | List of QMetry users to whom the mail intimating the file push needs to be sent. | string |
Response
Content-Type: application/json
| Status Code | Reason | Response Model |
|---|---|---|
| 200 | Data pushed successfully. | ResponseEntity |
| 400 | Missing mandatory fields. | - |
| 401 | Unauthorised or session expired | - |
| 500 | Returned when server connection times out | - |
Update Requirements with BDD data
PUT /rest/requirements
Request
Content-Type: application/json
| Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
| updateVersionFlag | body | no | Version number of Requirement(value = 3) | - | integer |
| updateWithVersion | body | no | Flag for the requirement update with version or not | - | boolean |
| description | body | no | Description of the Requirement | - | string |
| rqId | body | yes | Id of Requirement | - | integer |
| rqVersionId | body | yes | VersionId of Requirement | - | integer |
| requirementState | body | no | Status of Requirement | - | Array[integer] |
| priority | body | no | Priority of Requirement | - | Array[integer] |
| owner | body | no | Owner of Requirement | - | integer |
| name | body | no | Summary of Requirement | - | string |
| component | body | no | Label of Requirement | - | Array[integer] |
| versionComment | body | no | Comment about new version while creating it | - | string |
| bddData | body | no | Content which needs to save to QMetry. | - | string |
| fileName | body | no | Name of file from repository. | - | string |
| bddConfigrationID | body | no | BDD Configuration ID | - | integer |
| bddBranch | body | no | Branch name of repository. | - | string |
| bddFolderPath | body | no | Folder path of repository where file located. | - | string |
Response
Content-Type: application/json
| Status Code | Reason | Response Model |
|---|---|---|
| 200 | Requirement updated successfully | RequirementRepository |
| 400 | Returned in case of- Invalid json object or invalid UDF | - |
| 401 | Unautorised, insufficient privileges or session expired | - |
| 500 | Returned when server connection times out | - |
Get BDD Folder Tree
POST /rest/requirements/getBDDFolderTree
Description
Get list of associated folders
Request
Content-Type: application/json
Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
| bddConfigID | body | yes | ID of BDD repository for particular project from DB. | - | integer |
| bddBranch | body | yes | Branch name of repository. | - | string |
| folderPath | body | no | Path of the folder for which user wants to get the child folders in case of BitBucket repository. | - | string |
Note: In case of Bitbucket repository, the API request returns first level of directory structure. To drill down to child folders, call the API again with the "folderPath" parameter that contains "fullPath" from the previous API response.
Response
Content-Type: application/json
| Status Code | Reason | Response Model |
|---|---|---|
| 200 | List of folders fetched successfully | ResponseEntity |
| 400 | Missing mandatory fields. | - |
| 401 | Unauthorised or session expired | - |
| 500 | Returned when server connection times out | - |
Definitions
CriteriaBuilder
| name | type | required | description | example |
|---|
EntityManager
| name | type | required | description | example |
|---|---|---|---|---|
| properties | object | optional | - | |
| open | boolean | optional | - | |
| delegate | object | optional | - | |
| entityManagerFactory | EntityManagerFactory | optional | - | |
| joinedToTransaction | boolean | optional | - | |
| criteriaBuilder | CriteriaBuilder | optional | - | |
| transaction | EntityTransaction | optional | - | |
| flushMode | string | optional | - | |
| metamodel | Metamodel | optional | - |
EntityManagerFactory
| name | type | required | description | example |
|---|---|---|---|---|
| properties | object | optional | - | |
| cache | Cache | optional | - | |
| open | boolean | optional | - | |
| criteriaBuilder | CriteriaBuilder | optional | - | |
| persistenceUnitUtil | PersistenceUnitUtil | optional | - | |
| metamodel | Metamodel | optional | - |
EntityTransaction
| name | type | required | description | example |
|---|---|---|---|---|
| active | boolean | optional | - | |
| rollbackOnly | boolean | optional | - |
Metamodel
| name | type | required | description | example |
|---|---|---|---|---|
| entities | array[EntityTypeObject] | optional | - | |
| managedTypes | array[ManagedTypeObject] | optional | - | |
| embeddables | array[EmbeddableTypeObject] | optional | - |
ResponseEntity
| name | type | required | description | example |
|---|---|---|---|---|
| headers | object | optional | - | |
| body | object | optional | - | |
| statusCode | string | optional | - |
RequirementRepository
| name | type | required | description | example |
|---|---|---|---|---|
| manager | EntityManager | optional | - | |
| fieldMapForViewColumns | object | optional | - | |
| joinExistsListForTS | array[string] | optional | - |
ReleaseCycleMapping
| name | type | required | description | example |
|---|---|---|---|---|
| release | integer | required | Id of Release | |
| cycle | array[integer] | required | An array of cycle's Id | |
| version | integer | required | Number of the version |
EntityTypeObject
| name | type | required | description | example |
|---|---|---|---|---|
| name | string | optional | - | |
| supertype | IdentifiableTypeObject | optional | - | |
| idClassAttributes | array[SingularAttributeObjectObject] | optional | - | |
| idType | TypeObject | optional | - | |
| attributes | array[AttributeObjectObject] | optional | - | |
| declaredAttributes | array[AttributeObjectObject] | optional | - | |
| pluralAttributes | array[PluralAttributeObjectObjectObject] | optional | - | |
| singularAttributes | array[SingularAttributeObjectObject] | optional | - | |
| declaredPluralAttributes | array[PluralAttributeObjectObjectObject] | optional | - | |
| declaredSingularAttributes | array[SingularAttributeObjectObject] | optional | - | |
| persistenceType | string | optional | - | |
| bindableType | string | optional | - |
EmbeddableTypeObject
| name | type | required | description | example |
|---|---|---|---|---|
| attributes | array[AttributeObjectObject] | optional | - | |
| declaredAttributes | array[AttributeObjectObject] | optional | - | |
| pluralAttributes | array[PluralAttributeObjectObjectObject] | optional | - | |
| singularAttributes | array[SingularAttributeObjectObject] | optional | - | |
| declaredPluralAttributes | array[PluralAttributeObjectObjectObject] | optional | - | |
| declaredSingularAttributes | array[SingularAttributeObjectObject] | optional | - | |
| persistenceType | string | optional | - |
ManagedTypeObject
| name | type | required | description | example |
|---|---|---|---|---|
| attributes | array[AttributeObjectObject] | optional | - | |
| declaredAttributes | array[AttributeObjectObject] | optional | - | |
| pluralAttributes | array[PluralAttributeObjectObjectObject] | optional | - | |
| singularAttributes | array[SingularAttributeObjectObject] | optional | - | |
| declaredPluralAttributes | array[PluralAttributeObjectObjectObject] | optional | - | |
| declaredSingularAttributes | array[SingularAttributeObjectObject] | optional | - | |
| persistenceType | string | optional | - |
IdentifiableTypeObject
| name | type | required | description | example |
|---|---|---|---|---|
| supertype | IdentifiableTypeObject | optional | - | |
| idClassAttributes | array[SingularAttributeObjectObject] | optional | - | |
| idType | TypeObject | optional | - | |
| attributes | array[AttributeObjectObject] | optional | - | |
| declaredAttributes | array[AttributeObjectObject] | optional | - | |
| pluralAttributes | array[PluralAttributeObjectObjectObject] | optional | - | |
| singularAttributes | array[SingularAttributeObjectObject] | optional | - | |
| declaredPluralAttributes | array[PluralAttributeObjectObjectObject] | optional | - | |
| declaredSingularAttributes | array[SingularAttributeObjectObject] | optional | - | |
| persistenceType | string |
AttributeObjectObject
| name | type | required | description | example |
|---|---|---|---|---|
| name | string | optional | - | |
| declaringType | ManagedTypeObject | optional | - | |
| collection | boolean | optional | - | |
| persistentAttributeType | string | optional | - | |
| javaMember | Member | optional | - | |
| association | boolean | optional | - |
SingularAttributeObjectObject
| name | type | required | description | example |
|---|---|---|---|---|
| type | TypeObject | optional | - | |
| version | boolean | optional | - | |
| optional | boolean | optional | - | |
| id | boolean | optional | - | |
| name | string | optional | - | |
| declaringType | ManagedTypeObject | optional | - | |
| collection | boolean | optional | - | |
| persistentAttributeType | string | optional | - | |
| javaMember | Member | optional | - | |
| association | boolean | optional | - | |
| bindableType | string | optional | - |
PluralAttributeObjectObjectObject
| name | type | required | description | example |
|---|---|---|---|---|
| elementType | TypeObject | optional | - | |
| collectionType | string | optional | - | |
| name | string | optional | - | |
| declaringType | ManagedTypeObject | optional | - | |
| collection | boolean | optional | - | |
| persistentAttributeType | string | optional | - | |
| javaMember | Member | optional | - | |
| association | boolean | optional | - | |
| bindableType | string | optional | - |
Member
| name | type | required | description | example |
|---|---|---|---|---|
| modifiers | integer | optional | - | |
| name | string | optional | - | |
| synthetic | boolean | optional | - |
TypeObject
| name | type | required | description | example |
|---|---|---|---|---|
| persistenceType |
Filter
| name | type | required | description | example |
|---|---|---|---|---|
| value | object | required | Value to search based on type of filter | |
| comparison | string | required | The comparison operator 'lt' or 'gt' for Date type filter | |
| type | string | required | Type of Filter | |
| field | string | required | Field name on which filter is to be applied |
EntityData
| name | type | required | description | example |
|---|---|---|---|---|
| entityId | integer | required | Id of Entity | |
| version | integer | required | VersionId of Entity |
RqFolderArchiveRequestDetail
| name | type | required | description | example |
|---|---|---|---|---|
| rqFolderIDs | array[integer] | required | Array of Requirement Folder Ids | |
| isBulkOperation | boolean | optional | Is from BulkOperation flag | |
| isSingleOperation | boolean | optional | Is single operation | |
| includeRootFolderEntities | boolean | optional | Required to include Root Folder Entities |
RqFolderUnarchiveRequestDetail
| name | type | required | description | example |
|---|---|---|---|---|
| rqFolderIDs | array[integer] | required | Array of Requirement Folder Ids | |
| isBulkOperation | boolean | optional | Is from BulkOperation flag | |
| isSingleOperation | boolean | optional | Is single operation | |
| includeRootFolderEntities | boolean | optional | Required to include Root Folder Entities |
UdfFilter
| name | type | required | description | example |
|---|---|---|---|---|
| type | string | required | Type of Filter | |
| value | string | required | Value to search based on type of UDF | |
| udfmID | integer | required | Unique Identifier based on project-module-udf-user | |
| field | string | required | Name of User Defined Field |
Back to QMetry All Products Help Page