API for Test Cases

Get List of Testcases in Folder

POST /rest/testcases/list

Description

Get test case list based on particular ID of test case or folder inside all data or particular version related data.

Request

Content-Type: application/json

Parameters

Table 118. Get List of Test Cases in Folder

Name

Located in

Required

Description

Default

Schema

tcFolderID

body

yes

FolderId of Testcase. Get it from Get List of Testcase Folder/Sub Folders

-

integer

showAllStateEntities

body

yes

value "true"

-

boolean

scope

body

no

Scope of Testcase, possible values project,release,cycle. Default Project

-

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

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 Test Case List along with Custom Fields

POST /rest/testcases/list/viewColumns

Description

Fetch specific data of test cases with custom fields.

Request

Content-Type: application/json

Parameters

Table 119. Get Test Case List along with Custom Fields

Name

Located in

Required

Description

Default

Schema

viewId

body

yes

View ID of the user for that particular project and Testcase module. View ID can be fetched from latestViews section of Getinfo API.

-

integer

folderPath

body

yes

Path of folder whose Testcases are to be fetched

-

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

havingSharedTestcases

body

no

True value will fetch test cases having shared testcases linked with it

-

boolean

isForCopyPasteTestStep

body

no

This will fetch version number list of testcase's in response

-

boolean

isForCopyPaste

body

no

Get version number list of testcase's in response

-

boolean

showRootOnly

body

no

“true” - shows only root folder.

-

boolean

getSubEntities

body

no

“true” - gets entities from sub-folders

-

boolean

hideEmptyFolders

body

no

“false” - to get list of all folders.

“True” - to get list of folders with 0 entries.

-

boolean

folderSortColumn

body

no

-

boolean

folderSortOrder

body

no

-

boolean



Response

Content-Type: application/json

Status Code

Reason

Response Model

200

Testcase 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 Test case Details

POST /rest/testcases/list

Description

Get details of Testcase.

Request

Content-Type: application/json

Parameters

Table 120. Get Test case Details

Name

Located in

Required

Description

Default

Schema

id

body

Yes

Id of Testcase. Get it from "Get Testcase in Folder" API parameter "tcID"

-

integer

version

body

Yes

Version number of Testcase.

-

integer

scope

body

Yes

Scope of Testcase, possible values project,release,cycle

-

integer



Response

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

-

List of Test cases for Bulk Operations

POST /rest/testcases/listForBulkOperation

Request

Content-Type: application/json

Parameters

Table 121. List of Test cases for Bulk Operations

Name

Located in

Required

Description

Default

Schema

folderPath

body

yes

FolderPath of Testcase Folder whose testcases are to be listed

-

string

showAllStateEntities

body

yes

value "true"

-

boolean

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

yes

Filter test cases for respective bulk operations. The following is explanation of filters:

  • ownerAlias: Owner

  • createdByAlias: Created By

  • releaseIDs: comma separated values in case of multiple releases

  • cycleIDs: comma separated values in case of multiple cycles

  • testingTypeAlias: Testing Type (Manual/Automated)

  • testCaseStateAlias: Status

  • componentAlias: Labels

  • priorityAlias: Priorities

    Example: {\"type\":\"list\",\"value\":[\"Critical\"],\"field\":\"priorityAlias\"}

  • entityKeyId: ID

    Example: {\"type\":\"string\",\"comparison\":\"eq\",\"value\":\"JQ-TC-11\",\"field\":\"entityKeyId\"}

  • name: Summary

    Example: {\"type\":\"string\",\"value\":\"Verify Login\",\"field\":\"name\"}

  • IsShared: Represents that displayed testcases should be sharable testcases or not. Default value is“0”

    0 Does not display sharable testcases

    1 Displays sharable testcases

  • approvalStatus: Represents Approval workflow settings.

    1 Displays test cases with “In Review” status

    2 Displays test cases with “Approved” status

*Note

string



Note

  • IsShared: Default value is "0"

  • approvalStatus:

    • If approval workflow is enabled, the default value is "1".

    • If approval workflow is disabled, the default values is "2"

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 Test case Linked to a Requirement

POST /rest/testcases/list/forRQ

Description

Get test case list based on particular id of requirement.

Request

Content-Type: application/json

Parameters

Table 122. Get Test case linked to a Requirement

Name

Located in

Required

Description

Default

Schema

rqID

body

no

ID of requirement

-

integer

tsID

body

no

Id of test suite

-

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]

viewId

body

yes

View ID of the user for that particular project and Testcase module. View ID can be fetched from latestViews section of Getinfo API.

-

integer

tcFolderPath

body

no

The folder path where test case is saved.

-

string

getSubEntities

body

no

“true” to get sub-folder entities.

“false” to exclude entries from sub-folders

-

boolean



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 List of Issues for a Testcase

POST /rest/issues/getIssuesForTestCase

Description

Get issue list based on particular id of test case.

Request

Content-Type: application/json

Parameters

Table 123. Get List of Issues for a Test Case

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

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 Test Case Linked to a TestSuite

POST /rest/testcases/list/forTS

Description

Test Case list for Test Suite.

Request

Content-Type: application/json

Parameters

Table 124. Get Test case linked to a TestSuite

Name

Located in

Required

Description

Default

Schema

start

body

no

Start index of records

-

integer

showAllStateEntities

body

no

True to get testcases of approved state only, false to get testcases of any state

-

boolean

getLinked

body

no

'true' to get testcases linked with this requirement, 'false' to get all testcases

-

boolean

tsID

body

no

Id of testSuite

"tsID" parameter is mandatory when "getLinked" is True.

-

integer

showEntityWithReleaseCycle

body

no

List only those Testcases which have the same associated releases and cycles as the Testsuite

-

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 Testcase module. View ID can be fetched from latestViews section of Getinfo API.

-

integer

showUnlinked

body

no

True to get testcases which are not linked with currently selected testsuite(which means it will Hide already linked test cases)

-

boolean

showUnlinkedForReleaseCycle

body

no

True to get testcases linked with selected release and cycle but not linked with testsuites present in selected release and cycle

-

boolean

tcFolderPath

body

no

The folder path where test case is saved.

-

string

getSubEntities

body

no

Filter of Get Sub-entities for TC

-

boolean



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 Information of Parameters Associated with the Testcase Linked to a Testsuite

POST /rest/testcases/getParamDetails

Request

Content-Type: application/json

Parameters

Table 125. Get information of parameters associated with the Testcase linked to a Testsuite

Name

Located in

Required

Description

Default

Schema

tctsID

body

yes

tctsID for fetching linked paramIDs

-

integer



Response

Content-Type: application/json

Status Code

Reason

Response Model

200

Param Details 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 Version Details of Test case

POST /rest/testcases/getVersionDetail

Request

Content-Type: application/json

Parameters

Table 126. List Version Details of Test Case

Name

Located in

Required

Description

Default

Schema

tcID

body

yes

Id of Testcase

-

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

TestCase Version detail listed successfully

ResponseEntity

400

Invalid json object or mandatory fields missing

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

View Test Case Details

POST /rest/testcases/versions/{id}

Request

Parameters

Table 127. View Test Case Details

Name

Located in

Required

Description

Default

Schema

id

path

yes

Id of Testcase

-

integer

entityId

body

yes

Id of Testcase

-

string



Response

Content-Type: application/json

Status Code

Reason

Response Model

200

Testcase detail fetch successfully

ResponseEntity

400

Invalid json object or mandatory fields missing

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

List Test Case Steps

POST /rest/testcases/steps/list

Request

Content-Type: application/json

Parameters

Table 128. List Test Case Steps

Name

Located in

Required

Description

Default

Schema

id

body

yes

Id of Testcase

-

integer

start

body

yes

Start index of records

-

integer

limit

body

yes

Number of records per page

-

integer

page

body

yes

Page number to be displayed

-

integer

version

body

yes

Version number of Testcase

-

integer



Response

Content-Type: application/json

Status Code

Reason

Response Model

200

Test case steps shown successfully

ResponseEntity

500

Returned when server connection times out

-

Get All Versions of Testcase

POST /rest/testcases/listmanageversions

Request

Content-Type: application/json

Parameters

Table 129. Get All Versions of Testcase

Name

Located in

Required

Description

Default

Schema

entityId

body

yes

Id of Testcase

-

integer



Response

Content-Type: application/json

Status Code

Reason

Response Model

200

Successfully get all versions of a Testcase

ResponseEntity

400

Entity not found

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

Create Testcase

POST /rest/testcases

Request

Content-Type: application/json

Parameters

Table 130. Create Testcase

Name

Located in

Required

Description

Default

Schema

tcFolderID

body

yes

FolderId of Testcase

-

string

steps

body

no

An array of Steps

-

Array[Steps]

name

body

yes

Summary of Testcase

-

string

priority

body

no

PriorityID of Testcase

-

integer

component

body

no

Component(Label) Id of Testcase

-

integer

owner

body

no

OwnerId of Testcase

-

integer

testCaseState

body

no

StatusId of Testcase

-

integer

testCaseType

body

no

Id of Test Category

-

integer

estimatedTime

body

no

Estimated Time (In Minute/s) for Execution

-

integer

testingType

body

no

Id of TestingType

-

integer

description

body

no

Description of Testcase

-

string

sourceTcStepId

body

no

To copy the copied step attachment's source to destination

-

integer

copiedStepsData

body

no

For audit log purpose.

-

Array[Steps]



Response

Content-Type: application/json

Status Code

Reason

Response Model

200

Testcase added successfully

ResponseEntity

400

Invalid json object

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

Update Test case(s)

PUT /rest/testcases

Request

Content-Type: application/json

Parameters

Table 131. Update Testcases

Name

Located in

Required

Description

Default

Schema

tcID

body

yes

Id of Testcase

-

string

tcVersionID

body

yes

VersionID of Testcase

-

integer

tcVersion

body

yes

Version number of Testcase

-

integer

name

body

yes

Summary of Testcase

-

string

description

body

no

Value of Description

-

string

testCaseType

body

no

Id of TestingType

-

integer

executionMinutes

body

no

Estimated Time (In Minutes) for Execution

-

integer

priority

body

no

PriorityID of Testcase

-

integer

component

body

no

Component(Label) Id of Testcase

-

integer

owner

body

no

OwnerId of Testcase

-

integer

testCaseState

body

no

StatusId of Testcase

-

integer

withVersion

body

no

Pass 'true' if update test case with a newer version

-

boolean



Response

Content-Type: application/json

Status Code

Reason

Response Model

200

Test case(s) updated successfully

ResponseEntity

400

Invalid json object

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

Archive Testcase

/rest/testcases/archiveEntity

Description

API to archive test case based on a specific version or all versions.

Request

Content-Type: application/json

Parameters

Table 132. Archive Testcase

Name

Located in

Required

Description

Default

Schema

entityIds

body

yes

An array of testcaseId or testcaseVersionId

-

Array[integer]

isArchived

body

yes

True for archive, false for unarchive

-

boolean

isEntityVersion

body

no

True for archive specific version of Testcase otherwise false

-

boolean

destinationFolderIds

body

no

Specify destination folder to move the test cases before moving the test cases.

-

integer



Response

Content-Type: application/json

Status Code

Reason

Response Model

200

Testcase archive successfully

ResponseEntity

400

Invalid json object or mandatory fields missing

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

Delete Testcase

POST /rest/testcases/deleteEntity

Request

Content-Type: application/json

Parameters

Table 133. Delete Testcase

Name

Located in

Required

Description

Default

Schema

entityIds

body

yes

An array of TestcaseId

-

Array[integer]



Response

Content-Type: application/json

Status Code

Reason

Response Model

200

Testcase deleted successfully

ResponseEntity

400

Invalid json object or mandatory fields missing

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

Delete a Testcase Version

POST /rest/testcases/deleteEntityVersion

Request

Content-Type: application/json

Parameters

Table 134. Delete a Testcase Version

Name

Located in

Required

Description

Default

Schema

entityId

body

yes

An array of TestcaseId

-

integer

entityVersions

body

yes

An array of version number of the Testcase

-

Array[integer]



Response

Content-Type: application/json

Status Code

Reason

Response Model

200

Testcase 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 Sub Folder Information of a Particular Folder

POST /rest/testcases/tree

Request

Content-Type: application/json

Parameters

Table 137. Get sub folder information of a particular folder

Name

Located in

Required

Description

Default

Schema

tcFolderID

body

yes

FolderID for selected folder

-

integer

hideFolders

body

no

Flag for hide empty folders

-

boolean

sort

body

no

Sort Folders by date or name. E.g.

sort: "[{"property":"name","direction":"ASC"}]"

sort: "[{"property":"createdDate","direction":"DESC"}]"

-

string



Response

Content-Type: application/json

Status Code

Reason

Response Model

200

TestCase Folder Tree listed 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 Test Case Folder

POST /rest/testcases/tree/data

Request

Content-Type: application/json

Parameters

Table 138. Get Details of Test Case Folder

Name

Located in

Required

Description

Default

Schema

tcFolderID

body

yes

FolderId of Testcase

-

integer

isInheritFromParent

body

yes

Possible value is true or false

-

boolean



Response

Content-Type: application/json

Status Code

Reason

Response Model

200

Testcase folder 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 Test Case Folder

/folders

Request

Content-Type: application/json

Parameters

Table 139. Create Test Case Folder

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

Testcase folder created successfully

ResponseEntity

400

Invalid json object or mandatory fields missing

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

Archive Testcase Folder

POST /rest/testcases/folder/archive

Request

Content-Type: application/json

Parameters

Table 140. Archive Testcase Folder

Name

Located in

Required

Description

Default

Schema

Archive Folder Request

body

yes

Archive Folder Inputs

-

TcFolderArchiveRequestDetail

destinationFolderId

body

yes

Destination FolderID to move existing TC to another selected folder

-

integer



Response

Content-Type: application/json

Status Code

Reason

Response Model

200

Folder archived successfully

ResponseEntity

400

Following fields are missing:tcFolderIDs

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

Unarchive Testcase Folder

POST /rest/testcases/folder/unarchive

Request

Content-Type: application/json

Parameters

Table 141. Unarchive Testcase Folder

Name

Located in

Required

Description

Default

Schema

Unarchive Folder Request

body

yes

Unarchive Folder Inputs

-

TcFolderUnarchiveRequestDetail



Response

Content-Type: application/json

Status Code

Reason

Response Model

200

Folder unarchived successfully

ResponseEntity

400

Following fields are missing:tcFolderIDs

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

Update Test Case Folder

PUT /rest/testcases/folders

Request

Content-Type: application/json

Parameters

Table 142. Update Test Case Folder

Name

Located in

Required

Description

Default

Schema

name

body

yes

Updated Folder name

-

string

tcFolderID

body

yes

Unique Identifier of Testcase Folder to update

-

integer



Response

Content-Type: application/json

Status Code

Reason

Response Model

200

Testcase Folder updated successfully

ResponseEntity

400

Invalid json object or mandatory fields missing

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

Delete Test Case folder

POST /rest/testcases/folders/delete

Request

Content-Type: application/json

Parameters

Table 143. Delete Test Case folder

Name

Located in

Required

Description

Default

Schema

tcFolderID

body

yes

FolderId of Testcase

-

integer



Response

Content-Type: application/json

Status Code

Reason

Response Model

200

Testcase folder deleted successfully.

ResponseEntity

400

Invalid json object

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

Get Release & Cycle of Test Case

PUT /rest/testcases/scope/list

Description

To view list of scope (Release/Cycle) of testcase

Request

Content-Type: application/json

Parameters

Table 144. Get Release & Cycle of Test Case

Name

Located in

Required

Description

Default

Schema

entityID

body

yes

Id of Testcase

-

integer

start

body

yes

Start index of records

-

integer

limit

body

yes

Number of records per page

-

integer

page

body

yes

Page number to be displayed

-

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 and Cycle to Test Case

/scope/add

Request

Content-Type: application/json

Parameters

Table 145. Add Release & Cycle to Test Case

Name

Located in

Required

Description

Default

Schema

entityId

body

yes

Id of Testcase

-

integer

sourceBuildId

body

yes

BuildId of the Cycle associated with Release

-

integer

sourceProjectId

body

yes

ProjectId of the Testcase

-

integer

sourceReleaseId

body

yes

ReleaseId of the Project

-

integer

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 Testcase

-

Array[EntityData]

entityType

body

yes

Abbreviated entityType of Testcase - 'TC'

-

string

sourceScope

body

yes

scope('project'/'release'/'cycle')

-

string



Response

Content-Type: application/json

Status Code

Reason

Response Model

200

Scope added to testcase successfully

ResponseEntity

400

Invalid json object or mandatory fields missing

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

Remove Release and Cycle from Test Case

POST /rest/testcases/scope/remove

Description

API to remove scope(release/cycle) from testcase

Request

Content-Type: application/json

Parameters

Table 146. Remove Release and Cycle from Test Case

Name

Located in

Required

Description

Default

Schema

entityID

body

yes

Id of Testcase

-

integer

sourceBuildId

body

yes

BuildId of the Cycle associated with Release

-

integer

sourceProjectId

body

yes

ProjectId of the Testcase

-

integer

sourceReleaseId

body

yes

ReleaseId of the Project

-

integer

entityType

body

yes

Abbreviated entityType of Testcase - 'TC'

-

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

-

Add Testcase Comments

POST /rest/testcases/comments

Request

Content-Type: application/json

Parameters

Table 147. Add Testcase Comments

Name

Located in

Required

Description

Default

Schema

comments

body

yes

Comments of Testcase

-

string

entityId

body

yes

Id of Testcase

-

integer

entityType

body

yes

Entity Type of Testcase, default value is TC

-

string



Response

Content-Type: application/json

Status Code

Reason

Response Model

200

Comments added successfully

ResponseEntity

400

Invalid json object or mandatory fields missing

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

Update Testcase Comments

POST /rest/testcases/comments/update

Request

Content-Type: application/json

Parameters

Table 148. Update Testcase Comments

Name

Located in

Required

Description

Default

Schema

comments

body

yes

Comments of Testcase

-

string

entityId

body

yes

Id of Testcase

-

integer

entityType

body

yes

Entity Type of Testcase, default value is TC

-

string

commentId

body

yes

CommentId of Testcase

-

integer



Response

Content-Type: application/json

Status Code

Reason

Response Model

200

Comments updated successfully

ResponseEntity

400

Invalid json object or mandatory fields missing

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

Get Testcase Comments

/getCommentsData

Request

Content-Type: application/json

Parameters

Table 149. Get Testcase Comments

Name

Located in

Required

Description

Default

Schema

entityID

body

yes

Id of Testcase

-

integer

entityType

body

yes

Entity Type of Testcase, default value is TC

-

string

start

body

yes

Start index of records

-

integer

limit

body

yes

Number of records per page

-

integer

page

body

yes

Page number to be displayed

-

integer



Response

Content-Type: application/json

Status Code

Reason

Response Model

200

Comments get successfully

ResponseEntity

400

Invalid json object or mandatory fields missing

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

Delete Testcase Comments

/comments/delete

Request

Content-Type: application/json

Parameters

Table 150. Delete Testcase Comments

Name

Located in

Required

Description

Default

Schema

entityID

body

yes

Id of Testcase

-

integer

entityType

body

yes

Entity Type of Testcase, default value is TC

-

string

commentId

body

yes

CommentId of Testcase

-

integer



Response

Content-Type: application/json

Status Code

Reason

Response Model

200

Comments deleted 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 in Test Case

POST /rest/testcases/requirements/list

Request

Content-Type: application/json

Parameters

Table 151. Get List of Requirements in Test Case

Name

Located in

Required

Description

Default

Schema

tcID

body

yes

Id of Testcase

-

integer

start

body

yes

Start index of records

-

integer

limit

body

yes

Number of records per page

-

integer

page

body

yes

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

-

List Test Case Executions

POST /rest/testcases/execution

Request

Content-Type: application/json

Parameters

Table 155. List Test Case Executions

Name

Located in

Required

Description

Default

Schema

tcid

body

yes

Id of Testcase

-

integer

limit

body

yes

Number of record per page

-

integer

page

body

no

Page number to be displayed

-

integer

start

body

yes

Start index of records

-

integer

tcversion

body

no

Version Number of Test case

-

integer



Response

Content-Type: application/json

Status Code

Reason

Response Model

200

Successfully fetch Executions of particular testcase

ResponseEntityString

400

Invalid json object or mandatory fields missing

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

List Test Cases Linked with Shared Test Case

POST /rest/testcases/list/forSharedTestcase

Request

Content-Type: application/json

Parameters

Table 156. List Test Cases Linked with Shared Test Case

Name

Located in

Required

Description

Default

Schema

tcVersionID

body

yes

VersionID of Testcase

-

integer

limit

body

no

Number of record per page

-

integer

page

body

no

Page number to be displayed

-

integer

start

body

no

Start index of records

-

integer

getColumns

body

no

True to get list of all available filters(System + UDF) in 'filterTemplate' field

-

boolean

filter

body

no

System filters to be applied

-

Array[Filter]



Response

Content-Type: application/json

Status Code

Reason

Response Model

200

Testcase list fetched successfully

ResponseEntity

400

Invalid json object or mandatory fields missing

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

Reordering Test Cases

POST /rest/testcases/reorder

Request

Content-Type: application/json

Parameters

Table 157. Reordering Test Cases 

Name

Located in

Required

Description

Default

Schema

tcid

body

yes

Testcase ID

-

integer

tcFolderId

body

no

Test Case Folder ID

-

integer

sequenceNo

body

no

Order Number of the Test Case

-

integer



Reusing Test Cases

POST /rest/testcases/reuse

Request

Content-Type: application/json

Parameters

Table 158. Reusing Test Cases 

Name

Located in

Required

Description

Default

Schema

tcId

body

yes

Testcase ID

-

integer

newFolderIds

body

no

ID of New Folders

-

integer



Definition

ResponseEntity

name

type

required

description

example

headers

object

optional

-

body

object

optional

-

statusCode

string

optional

-

Steps

name

type

required

description

example

orderId

integer

required

Number of Order

description

string

required

Value of Description

inputData

string

required

Value of InputData

expectedOutcome

string

required

Value of ExpectedOutcome

tcRunID

string

optional

Id of Test Run

UDF

object

optional

Test Step UDFs

RequirementRepository

name

type

required

description

example

manager

Entity Manager

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

EntityData

name

type

required

description

example

entityId

integer

required

Id of Entity

version

integer

required

VersionId of Entity

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

-

CriteriaBuilder

name

type

required

description

example

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

-

Cache

name

type

required

description

example

PersistenceUnitUtil

name

type

required

description

example

EntityTypeObject

name

type

required

description

example

name

string

optional

-

supertype

IdentifiableTypeObject

optional

-

idClassAttributes

array[SingularAttibuteObjectObject]

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

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

string

optional

-

TcFolderArchiveRequestDetail

name

type

required

description

example

tcFolderIDs

array[integer]

required

Array of Test Case Folder Ids

isBulkOperation

boolean

optional

Is from BulkOperation flag

includeRootFolderEntities

boolean

optional

Required to include Root Folder Entities

TcFolderUnarchiveRequestDetail

name

type

required

description

example

tcFolderIDs

array[integer]

required

Array of Test Case Folder Ids

isBulkOperation

boolean

optional

Is from BulkOperation flag

includeRootFolderEntities

boolean

optional

Required to include Root Folder Entities

Filter

name

type

required

description

example

value

object

required

Value to search based on type of filter

comparison

string

required

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

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

In this section:
© 2025
Publication date: