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

scope

body

yes

"project"

-

string

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.

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

-

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

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

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

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

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 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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

-

List Requirement Folders for selected folder

POST /rest/requirements/tree

Request

Content-Type: application/json

Parameters

Name

Located in

Required

Description

Default

Schema

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

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

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

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

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

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

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

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

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

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