API for Test Suites

Get List of Test Suites

POST /rest/testsuites/list

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

tsFolderID

body

yes

FolderId of Test Suites

-

integer

scope

body

yes

Scope of Testsuite, possible values project,release,cycle

-

string

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 Suite List along with Fields

POST /rest/testsuites/list/viewColumns

Description

Fetch specific data of test suites 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 Testsuite module. View ID can be fetched from latestViews section of Getinfo API.

-

integer

folderPath

body

yes

Path of folder whose Testsuites 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

Response

Content-Type: application/json

Status Code

Reason

Response Model

Status Code

Reason

Response Model

200

Testsuite list fetched successfully

ResponseEntity

400

Invalid json object or mandatory fields missing

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

View Test Suite Details

POST /rest/testsuites/detail/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 Testsuite

-

integer

Response

Content-Type: application/json

Status Code

Reason

Response Model

Status Code

Reason

Response Model

200

Test Suites 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 Suite

POST /rest/testsuites

Description

API to create testsuite

Request

Content-Type: application/json

Parameters

Name

Located in

Required

Description

Default

Schema

Name

Located in

Required

Description

Default

Schema

parentFolderId

body

yes

Parent folderId of Test Suites

-

string

isAutomatedFlag

body

no

Default value false

-

boolean

name

body

yes

Summary of Test Suites

-

string

description

body

no

Description of Test Suites

-

string

testsuiteOwner

body

no

Owner of Test Suites

-

integer

testSuiteState

body

no

Status of Test Suites

-

integer

associateRelCyc

body

no

Pass true only when releaseCycleMapping is passed

-

boolean

releaseCycleMapping

body

no

An array of releaseId, buildID(Do not pass tsId)

-

Array[Data]

requirementId

body

no

Id of the requirement from which user wants to create testsuite

-

string

Response

Content-Type: application/json

Status Code

Reason

Response Model

Status Code

Reason

Response Model

200

TestSuite created successfully

ResponseEntity

400

Invalid json object or mandatory fields missing

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

Update Test Suite

PUT /rest/testsuites

Request

Content-Type: application/json

Parameters

Name

Located in

Required

Description

Default

Schema

Name

Located in

Required

Description

Default

Schema

parentFolderId

body

no

Parent folderId of Test Suites

-

string

isAutomatedFlag

body

no

Default value false

-

boolean

name

body

no

Summary of Test Suites

-

string

description

body

no

Description of Test Suites

-

string

owner

body

no

OwnerId of Test Suites

-

integer

ownUser

body

no

An array of ownerId of Test Suites

-

Array[integer]

owneralias

body

no

Owner name of Test Suites

-

string

testSuiteState

body

no

StatusId of Test Suites

-

integer

testSuiteStateAlias

body

no

Status name of Test Suites

-

string

tsState

body

no

An array of statusId of Test Suites

-

Array[integer]

entityKey

body

yes

EntityKey of Test Suites

-

string

folderPath

body

no

Folder path of Test Suites

-

string

TsFolderID

body

yes

Folder Id of Test Suites

-

integer

id

body

yes

Id of Test Suites

-

integer

Response

Content-Type: application/json

Status Code

Reason

Response Model

Status Code

Reason

Response Model

200

Test Suites update successfully

ResponseEntity

400

Invalid json object or mandatory fields missing

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

 

Copy a Test Suite

PUT /rest/testsuites/copy

Description

Copy TestSuite in same folder or another folder

Request

Content-Type: application/json

Parameters

Name

Located in

Required

Description

Default

Schema

Name

Located in

Required

Description

Default

Schema

srcFolderId

body

yes

Source FolderId of Testsuite

-

integer

destFolderId

body

yes

Destination FolderId of Testsuite

-

integer

id

body

yes

Id of Test Suites

-

string

isBulkOperation

body

no

BulkOperation flag

-

boolean

isPlatformCopy

body

no

copy platform(s) if flag is true (default:true)

-

boolean

isReleaseCycleCopy

body

no

copy release(s)/cycle(s) if flag is true (default:true)

-

boolean

executionStatusIds

body

no

copy only test cases having selected test execution status (Default :null)

-

string

isPlatformCopyWithSelctedStatus

body

no

copy platform(s) with selected test execution status (default:false)

-

boolean

isLatestVersionSync

body

no

sync latest version of test case(s) (default:false)

-

boolean

isResetToNotrun

body

no

To preserve existing test execution status of test case(s) (default:true)

-

boolean

isResetAssignee

body

no

To Reset Assignee of test case(s) (default:false)

-

boolean

Response

Content-Type: application/json

Status Code

Reason

Response Model

Status Code

Reason

Response Model

200

TestSuite copied successfully

ResponseEntity

400

Invalid json object or mandatory fields missing

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

Copy a Test Suite with New Release Cycle

PUT /rest/testsuites/copyWithNewReleaseCycle

Description

Copy Test Suite in same folder or another folder with New Release Cycle

Request

Content-Type: application/json

Parameters

Name

Located in

Required

Description

Default

Schema

Name

Located in

Required

Description

Default

Schema

srcFolderId

body

yes

Source FolderId of Testsuite

-

integer

destFolderId

body

yes

Destination FolderId of Testsuite

-

integer

executionStatusIds

body

no

Copy only test cases having selected test execution status (Default :null)

-

integer

id

body

yes

Id of Test Suites

-

string

build

body

no

Assign Build to Execution

-

integer

isBulkOperation

body

no

BulkOperation flag

-

boolean

isLatestVersionSync

body

no

Sync latest version of test case(s) (default:false)

-

boolean

isOldReleaseCycleSelected

body

no

Reference Release Cycle is Selected Flag

 

boolean

isPlatformCopy

body

no

Copy platform(s) if flag is true (default:true)

-

boolean

isPlatformCopyWithSelctedStatus

body

no

Copy platform(s) with selected test execution status (default:false)

-

boolean

isResetAssignee

body

no

To Reset Assignee of test case(s) (default:false)

-

boolean

isResetToNotrun

body

no

To preserve existing test execution status of test case(s) (default:true)

-

boolean

latestVersionSync

body

no

Sync Latest Testcase Version in new Execution

-

boolean

newreleaseCycleMapping

body

no

An array of releaseId, buildID

-

Array[Data]

oldReleaseCycleMappingId

body

no

Reference Release Cycle Mapping ID

-

integer

oldReleaseCycleSelected

body

no

Reference Release Cycle Executions For Copying

-

boolean

platformCopy

body

no

Copy platform

-

boolean

platformCopyWithSelctedStatus

body

no

Copy Execution of Platform with Selected Status

-

boolean

release

body

no

Copy release

-

integer

resetAssignee

body

no

Reset Assignee in new Execution Flag

-

boolean

resetToNotrun

body

no

Reset Execution Status in New Execution to Not Run Flag

-

boolean

 

Response

Content-Type: application/json

Status Code

Reason

Response Model

Status Code

Reason

Response Model

200

Test Suite copied successfully

-

201

Created

-

400

Invalid json object or mandatory fields missing

-

401

Unauthorised or session expired

-

403

Forbidden

-

404

Not Found

-

500

Returned when server connection times out

-

Delete Test Suite

POST /rest/testsuites/delete

Request

Content-Type: application/json

Parameters

Name

Located in

Required

Description

Default

Schema

Name

Located in

Required

Description

Default

Schema

ids

body

yes

Id of Test Suite

-

integer

Response

Content-Type: application/json

Status Code

Reason

Response Model

Status Code

Reason

Response Model

200

TestSuites deleted successfully

ResponseEntity

400

Invalid json object

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

Delete Test Suites in Bulk

POST /rest/testsuites/deleteEntity

Request

Content-Type: application/json

Parameters

Name

Located in

Required

Description

Default

Schema

Name

Located in

Required

Description

Default

Schema

entityIds

body

yes

Id of Testsuites that have to be deleted

-

Array[integer]

Response

Content-Type: application/json

Status Code

Reason

Response Model

Status Code

Reason

Response Model

200

Testsuites deleted 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 sub folders of a particular folder

POST /rest/testsuites/tree

Request

Content-Type: application/json

Parameters

Name

Located in

Required

Description

Default

Schema

Name

Located in

Required

Description

Default

Schema

tsFolderID

body

yes

Folder ID of Selected TestSuite 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

TestSuite 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

-

Create Test Suite Folder

POST /rest/testsuites/folders

Request

Content-Type: application/json

Parameters

Name

Located in

Required

Description

Default

Schema

Name

Located in

Required

Description

Default

Schema

name

body

yes

Folder Name

-

string

parentId

body

yes

ID of parent folder

-

integer

Response

Content-Type: application/json

Status Code

Reason

Response Model

Status Code

Reason

Response Model

200

TestSuite Folder created successfully

ResponseEntity

400

Folder already exists

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

Archive Test Suite Folder

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

-

TsFolderArchiveRequestDetail

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

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

Unarchive Test Suite Folder

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

-

TsFolderUnarchiveRequestDetail

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

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

Update Test Suite Folder

PUT /rest/testsuites/folders

Request

Content-Type: application/json

Parameters

Name

Located in

Required

Description

Default

Schema

Name

Located in

Required

Description

Default

Schema

folderId

body

yes

Unique identifier of Testsuite Folder to update

-

integer

name

body

yes

Update Testsuite Folder name

-

string

Response

Content-Type: application/json

Status Code

Reason

Response Model

Status Code

Reason

Response Model

200

Testsuite 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 Suite Folder

POST /rest/testsuites/folders/delete

Request

Content-Type: application/json

Parameters

Name

Located in

Required

Description

Default

Schema

Name

Located in

Required

Description

Default

Schema

tsFolderID

body

yes

FolderId of Test Suites

-

integer

Response

Content-Type: application/json

Status Code

Reason

Response Model

Status Code

Reason

Response Model

200

TestSuite folder successfully deleted.

ResponseEntity

400

Invalid json object or mandatory fields missing.

-

401

Unauthorised or session expired.

-

500

Returned when server connection times out.

-

Get all Releases & Cycles of Test Suite

POST /rest/testsuites/getReleaseCycleForTestSuite

Request

Content-Type: application/json

Parameters

Name

Located in

Required

Description

Default

Schema

Name

Located in

Required

Description

Default

Schema

tsID

body

yes

Id of Testsuite

-

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

Response

Content-Type: application/json

Status Code

Reason

Response Model

Status Code

Reason

Response Model

200

Release & Cycle list 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 & Cycle To Test Suite

POST /rest/testsuites/mapReleaseCycle

Request

Content-Type: application/json

Parameters

Name

Located in

Required

Description

Default

Schema

Name

Located in

Required

Description

Default

Schema

data

body

yes

An array of Data

-

Array[Data]

Response

Content-Type: application/json

Status Code

Reason

Response Model

Status Code

Reason

Response Model

200

Scope successfully added to testsuite

ResponseEntity

400

Invalid json object or mandatory fields missing

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

Remove Release & Cycle from Test Suite

POST /rest/testsuites/unMapReleaseCycle

Request

Content-Type: application/json

Parameters

Name

Located in

Required

Description

Default

Schema

Name

Located in

Required

Description

Default

Schema

tsReleaseCycleMapID

body

yes

Id of Testsuite's Release Cycle mapping

-

integer

Response

Content-Type: application/json

Status Code

Reason

Response Model

Status Code

Reason

Response Model

200

Scope successfully deleted to testsuite

ResponseEntity

400

Invalid json object or mandatory fields missing

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

List Test Cases Linked to Test Suite

POST /rest/testsuites/testcase/list

Request

Content-Type: application/json

Parameters

Name

Located in

Required

Description

Default

Schema

Name

Located in

Required

Description

Default

Schema

filter

body

no

Filter to only show unshared Testcases

-

Array[Filter]

tsID

body

yes

Id of Testsuite whose linked Testcases are to be obtained

-

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