| Table of Contents | ||
|---|---|---|
|
...
POST /rest/requirements/list/viewColumns
Description
Fetch data of Requirements along with custom fields. Returns data from latest version.
Request
Content-Type: application/json
...
| 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
...
POST /rest/requirements/list/forIS
Description
Get Requirement list based on particular id of issue.
Request
Content-Type: application/json
...
POST /rest/issues/list/ForRQ
Description
Get issue list based on the particular requirement
Request
Content-Type: application/json
...
POST /rest/requirements/list/forTS
Description
Requirement list for Test Suite.
Request
Content-Type: application/json
...
| Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
| Unarchive Folder Request | body | yes | Unarchive Folder Inputs | - | RqFolderUnarchiveRequestDetail |
...
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
...
| 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 | 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
...
Pull File from Repository
POST /rest/requirements/pullFile
Request
Content-Type: application/json
...
Push File to Repository
POST /rest/requirements/pushFile
Request
Content-Type: application/json
...
Update Requirements with BDD data
PUT /rest/requirements
Request
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.
...
| name | type | required | description | example |
|---|---|---|---|---|
| headers | object | optional | - | |
| body | object | optional | - | |
| statusCode | string | optional | - |
RequirementRepository
| Anchor | ||||
|---|---|---|---|---|
|
| 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 |
...
| 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
| Anchor | ||||
|---|---|---|---|---|
|
| 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 |
...