Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
maxLevel3

...

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/requirements/list/forTS

Description

Requirement list for Test Suite.

Request

Content-Type: application/json

...

Name

Located in

Required

Description

Default

Schema

Archive Folder Request

body

yes

Archive Folder Inputs

-

API for Requirement#RqFolderArchiveRequestDetailRqFolderArchiveRequestDetail

Response

Content-Type: application/json

...

Name

Located in

Required

Description

Default

Schema

Unarchive Folder Request

body

yes

Unarchive Folder Inputs

-

API for Requirement#RqFolderUnarchiveRequestDetailRqFolderUnarchiveRequestDetail

Response

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

unlink issue successfully

API for Requirement#ResponseEntityResponseEntity

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

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[API for Requirement#ReleaseCycleMappingReleaseCycleMapping]

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[API for Requirement#EntityDataEntityData]

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

API for Requirement#RequirementRepositoryRequirementRepository

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

properties

object

optional

-


open

boolean

optional

-


delegate

object

optional

-


entityManagerFactory

API for Requirement#EntityManagerFactoryEntityManagerFactory

optional

-


joinedToTransaction

boolean

optional

-


criteriaBuilder

API for Requirement#CriteriaBuilderCriteriaBuilder

optional

-


transaction

API for Requirement#EntityTransactionEntityTransaction

optional

-


flushMode

string

optional

-


metamodel

API for Requirement#MetamodelMetamodel

optional

-


EntityManagerFactory

name

type

required

description

example

properties

object

optional

-


cache

API for Requirement#CacheCache

optional

-


open

boolean

optional

-


criteriaBuilder

API for Requirement#CriteriaBuilderCriteriaBuilder

optional

-


persistenceUnitUtil

API for Requirement#PersistenceUnitUtilPersistenceUnitUtil

optional

-


metamodel

API for Requirement#MetamodelMetamodel

optional

-


EntityTransaction

...

name

type

required

description

example

entities

array[API for Requirement#EntityTypeObjectEntityTypeObject]

optional

-


managedTypes

array[API for Requirement#ManagedTypeObjectManagedTypeObject]

optional

-


embeddables

array[API for Requirement#EmbeddableTypeObjectEmbeddableTypeObject]

optional

-


ResponseEntity

name

type

required

description

example

headers

object

optional

-


body

object

optional

-


statusCode

string

optional

-


...

name

type

required

description

example

manager

API for Requirement#EntityManagerEntityManager

optional

-


fieldMapForViewColumns

object

optional

-


joinExistsListForTS

array[string]

optional

-


...

name

type

required

description

example

name

string

optional

-


supertype

API for Requirement#IdentifiableTypeObjectIdentifiableTypeObject

optional

-


idClassAttributes

array[API for Requirement#SingularAttributeObjectObjectSingularAttributeObjectObject]

optional

-


idType

API for Requirement#TypeObjectTypeObject

optional

-


attributes

array[API for Requirement#AttributeObjectObjectAttributeObjectObject]

optional

-


declaredAttributes

array[API for Requirement#AttributeObjectObjectAttributeObjectObject]

optional

-


pluralAttributes

array[API for Requirement#PluralAttributeObjectObjectObjectPluralAttributeObjectObjectObject]

optional

-


singularAttributes

array[API for Requirement#SingularAttributeObjectObjectSingularAttributeObjectObject]

optional

-


declaredPluralAttributes

array[API for Requirement#PluralAttributeObjectObjectObjectPluralAttributeObjectObjectObject]

optional

-


declaredSingularAttributes

array[API for Requirement#SingularAttributeObjectObjectSingularAttributeObjectObject]

optional

-


persistenceType

string

optional

-


bindableType

string

optional

-

...

name

type

required

description

example

attributes

array[API for Requirement#AttributeObjectObjectAttributeObjectObject]

optional

-


declaredAttributes

array[API for Requirement#AttributeObjectObjectAttributeObjectObject]

optional

-


pluralAttributes

array[API for Requirement#PluralAttributeObjectObjectObjectPluralAttributeObjectObjectObject]

optional

-


singularAttributes

array[API for Requirement#SingularAttributeObjectObjectSingularAttributeObjectObject]

optional

-


declaredPluralAttributes

array[API for Requirement#PluralAttributeObjectObjectObjectPluralAttributeObjectObjectObject]

optional

-


declaredSingularAttributes

array[API for Requirement#SingularAttributeObjectObjectSingularAttributeObjectObject]

optional

-


persistenceType

string

optional

-

...

...

...

name

type

required

description

example

name

string

optional

-


declaringType

API for Requirement#ManagedTypeObjectManagedTypeObject

optional

-


collection

boolean

optional

-


persistentAttributeType

string

optional

-


javaMember

API for Requirement#MemberMember

optional

-


association

boolean

optional

-

...

name

type

required

description

example

type

API for Requirement#TypeObjectTypeObject

optional

-


version

boolean

optional

-


optional

boolean

optional

-


id

boolean

optional

-


name

string

optional

-


declaringType

API for Requirement#ManagedTypeObjectManagedTypeObject

optional

-


collection

boolean

optional

-


persistentAttributeType

string

optional

-


javaMember

API for Requirement#MemberMember

optional

-


association

boolean

optional

-


bindableType

string

optional

-

...

name

type

required

description

example

elementType

API for Requirement#TypeObjectTypeObject

optional

-


collectionType

string

optional

-


name

string

optional

-


declaringType

API for Requirement#ManagedTypeObjectManagedTypeObject

optional

-


collection

boolean

optional

-


persistentAttributeType

string

optional

-


javaMember

API for Requirement#MemberMember

optional

-


association

boolean

optional

-


bindableType

string

optional

-

...

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

...