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

Name

Located in

Required

Description

Default

Schema

Name

Located in

Required

Description

Default

Schema

id

body

yes

Id of Testcase

-

integer

version

body

yes

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

tcFolderID

body

no

FolderId of Testcase

-

integer

scope

body

yes

Scope of Testcase, possible values project,release,cycle

-

integer

Response

Content-Type: application/json

Status Code

Reason

Response Model

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

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

-

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

havingSharedTestcases

body

no

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

-

boolean

Response

Content-Type: application/json

Status Code

Reason

Response Model

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

Name

Located in

Required

Description

Default

Schema

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

Content-Type: application/json

Status Code

Reason

Response Model

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 case(s) for Bulk Operations

POST /rest/testcases/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 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

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

Name

Located in

Required

Description

Default

Schema

Name

Located in

Required

Description

Default

Schema

rqID

body

no

Id of Requirement

-

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]

Response

Content-Type: application/json

Status Code

Reason

Response Model

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 Test suites for a Testcase

POST /rest/testsuites/list/forTC

Description

Get list of test suites for a 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

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

Testsuite 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

Name

Located in

Required

Description

Default

Schema

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]

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

Response

Content-Type: application/json

Status Code

Reason

Response Model

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

Name

Located in

Required

Description

Default

Schema

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

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

Name

Located in

Required

Description

Default

Schema

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

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

Name

Located in

Required

Description

Default

Schema

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

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

Name

Located in

Required

Description

Default

Schema

Name

Located in

Required

Description

Default

Schema

id

body

yes

Id of Testcase

-

integer

limit

body

yes

Number of record per page

-

integer

page

body

yes

Page number to be displayed

-

integer

start

body

yes

Start index of records

-

integer

version

body

yes

Version number of Testcase

-

integer

Response

Content-Type: application/json

Status Code

Reason

Response Model

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

Name

Located in

Required

Description

Default

Schema

Name

Located in

Required

Description

Default

Schema

entityId

body

yes

Id of Testcase

-

integer

Response

Content-Type: application/json

Status Code

Reason

Response Model

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

Name

Located in

Required

Description

Default

Schema

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

associateRelCyc

body

no

Pass true only when releaseCycleMapping is passed

-

boolean

releaseCycleMapping

body

no

An array of release, cycle & version mapping (pass version as 1)

-

Array

Response

Content-Type: application/json

Status Code

Reason

Response Model

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

Name

Located in

Required

Description

Default

Schema

Name

Located in

Required

Description

Default

Schema

tcID

body

yes

ID of Testcase

-

string

tcFolderID

body

yes

FolderId of Testcase

-

integer

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 Minute/s) for Execution

-

integer

priority

body

no

PriorityID of Testcase

-

integer

owner

body

no

OwnerId of Testcase

-

integer

testCaseState

body

no

StatusId of Testcase

-

integer

component

body

no

Component(Label) Id of Testcase

-

integer

Response

Content-Type: application/json

Status Code

Reason

Response Model

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

POST /rest/testcases/archiveEntity

Description

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

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

Response

Content-Type: application/json

Status Code

Reason

Response Model

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

Name

Located in

Required

Description

Default

Schema

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

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

Name

Located in

Required

Description

Default

Schema

Name

Located in

Required

Description

Default

Schema

entityId

body

yes

Id of Testcase

-

integer

entityVersions

body

yes

An array of version number of the Testcase

-

Array[integer]

Response

Content-Type: application/json

Status Code

Reason

Response Model

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

Name

Located in

Required

Description

Default

Schema

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

-

string

Response

Content-Type: application/json

Status Code

Reason

Response Model

Status Code