| 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
...
POST /rest/requirements/list/forIS
Description
Get Requirement list based on particular id of issue.
Request
Content-Type: application/json
...
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] |
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 |
Response
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 |
|---|---|---|---|---|---|
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 |
Response
...
yes | Scope of the Requirement, possible values project, release, cycle, build | - | string | ||
getColumns | body | no | True to get list of all available filters(System + UDF) in 'filterTemplate' field | - | boolean |
|---|---|---|---|---|---|
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 |
Response
Content-Type: application/json
Status Code | Reason | Response Model |
|---|---|---|
200 | Requirement list fetch successfully | |
400 | Invalid json object or mandatory fields missing | - |
401 | Unauthorised or session expired | - |
500 | Returned when server connection times out | - |
...
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 |
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] |
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 |
Response
Content-Type: application/json
...
Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
Archive Folder Request | body | yes | Unarchive Folder Inputs | - |
...
Status Code | Reason | Response Model |
|---|---|---|
200 | successfully get list of users for project | |
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 | |
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.
...