Versions Compared

Key

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

...

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

-

...

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

...

Status Code

Reason

Response Model

200

Testsuite list fetched successfully

API for Test Suites#ResponseEntityResponseEntity

400

Invalid json object or mandatory fields missing

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

...

Status Code

Reason

Response Model

200

Test Suites detail fetch successfullyAPI for Test Suites#ResponseEntity

ResponseEntity

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

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

owner

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[API for Test Suites#DataData]

requirementId

body

no

Id of the requirement from which user wants to create testsuite

-

string

...

Status Code

Reason

Response Model

200

TestSuite created successfully

API for Test Suites#ResponseEntityResponseEntity

400

Invalid json object or mandatory fields missing

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

...

Status Code

Reason

Response Model

200

Test Suites update successfullyAPI for Test Suites#ResponseEntity

ResponseEntity

400

Invalid json object or mandatory fields missing

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

...

Status Code

Reason

Response Model

200

TestSuite copied successfully

API for Test Suites#ResponseEntityResponseEntity

400

Invalid json object or mandatory fields missing

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

...

Status Code

Reason

Response Model

200

TestSuites deleted successfully

API for Test Suites#ResponseEntityResponseEntity

400

Invalid json object

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

...

Status Code

Reason

Response Model

200

Testsuites deleted successfully

API for Test Suites#ResponseEntityResponseEntity

400

Invalid json object or mandatory fields missing

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

...

Status Code

Reason

Response Model

200

TestSuite folder tree listed successfully.

API for Test Suites#ResponseEntityResponseEntity

400

Invalid json object or mandatory fields missing

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

...

Status Code

Reason

Response Model

200

TestSuite Folder created successfully

API for Test Suites#ResponseEntityResponseEntity

400

Folder already exists

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

...

Name

Located in

Required

Description

Default

Schema

Archive Folder Request

body

yes

Archive Folder Inputs

-

API for Test Suites#TsFolderArchiveRequestDetailTsFolderArchiveRequestDetail

Response

Content-Type: application/json

...

Name

Located in

Required

Description

Default

Schema

Unarchive Folder Request

body

yes

Unarchive Folder Inputs

-

API for Test Suites#TsFolderUnarchiveRequestDetailTsFolderUnarchiveRequestDetail

Response

Content-Type: application/json

...

Status Code

Reason

Response Model

200

Testsuite Folder updated successfully

API for Test Suites#ResponseEntityResponseEntity

400

Invalid json object or mandatory fields missing

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

...

Status Code

Reason

Response Model

200

TestSuite folder successfully deleted.

API for Test Suites#ResponseEntityResponseEntity

400

Invalid json object or mandatory fields missing.

-

401

Unauthorised or session expired.

-

500

Returned when server connection times out.

-

...

Status Code

Reason

Response Model

200

Release & Cycle list fetch successfully

API for Test Suites#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

data

body

yes

An array of Data

-

Array[API for Test Suites#DataData]

Response

Content-Type: application/json

Status Code

Reason

Response Model

200

Scope successfully added to testsuite

API for Test Suites#ResponseEntityResponseEntity

400

Invalid json object or mandatory fields missing

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

...

Status Code

Reason

Response Model

200

Scope successfully deleted to testsuite

API for Test Suites#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

filter

body

no

Filter to only show unshared Testcases

-

Array[API for Test Suites#FilterFilter]

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

...

Status Code

Reason

Response Model

200

Testcases linked with the Testsuite shown successfully

API for Test Suites#ResponseEntityResponseEntity

400

Invalid json object or mandatory fields missing

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

...

Status Code

Reason

Response Model

200

TestCases successfully linked to TestSuite

API for Test Suites#ResponseEntityResponseEntity

400

Invalid json object or mandatory fields missing

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

...

Status Code

Reason

Response Model

200

TestCases successfully linked to TestSuite

API for Test Suites#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

tcRunID

body

yes

Unique identifier of Testcase Run

-

Array[integer]

syncAll

body

no

Flag to Sync all Testcase Run

-

boolean

tsRunID

body

yes

Unique identifier of Testsuite Run

-

integer

username

body

no

Username of the user who is being authenticated

-

string

password

body

no

Password of the user who being authenticated

-

string

...

Status Code

Reason

Response Model

200

Linked Testcase of the Testsuite successfully updated to latest available version

API for Test Suites#ResponseEntityResponseEntity

400

Invalid json object or mandatory fields missing

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

...

Status Code

Reason

Response Model

200

Testcase successfully unlinked to testsuite

API for Test Suites#ResponseEntityResponseEntity

400

Invalid json object or mandatory fields missing

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

...

Status Code

Reason

Response Model

200

Testcase successfully unlinked to testsuite

API for Test Suites#ResponseEntityResponseEntity

400

Invalid json object or mandatory fields missing

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

...

Status Code

Reason

Response Model

200

Successfully get linked platforms from testsuite

API for Test Suites#ResponseEntityResponseEntity

400

Invalid json object or mandatory fields missing

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

...

Status Code

Reason

Response Model

200

Selected platforms successfully linked to testsuite

API for Test Suites#ResponseEntityResponseEntity

400

Invalid json object or mandatory fields missing

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

...

Status Code

Reason

Response Model

200

Platforms successfully unlinked to testsuite

API for Test Suites#ResponseEntityResponseEntity

400

Invalid json object or mandatory fields missing

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

...

Status Code

Reason

Response Model

200

Successfully assigned owner of platform from testsuites

API for Test Suites#ResponseEntityResponseEntity

400

Invalid json object or mandatory fields missing

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

...

Status Code

Reason

Response Model

200

Tester assigned successfully

API for Test Suites#ResponseEntityResponseEntity

400

Invalid json object or mandatory fields missing

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

...

Status Code

Reason

Response Model

200

Run Status updated successfully

API for Test Suites#ResponseEntityResponseEntity

400

Invalid json object or mandatory fields missing

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

...

POST /rest/testcases/list/forTS

Description

Testcase list for testsuite.

Request

Content-Type: application/json

...

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 only those testcases that are linked with this defect, false to get all testcases. While using True "tsID" is mandatory

-

boolean

tsID

body

no

Id of Test Suite

-

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[API for Test Suites#UdfFilterUdfFilter]

filter

body

no

System filters to be applied

-

Array[API for Test Suites#FilterFilter]

Response

Content-Type: application/json

Status Code

Reason

Response Model

200

Testcase list fetch successfully

API for Test Suites#ResponseEntityResponseEntity

400

Invalid json object or mandatory fields missing

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

...

Status Code

Reason

Response Model

200

Issues of particular execution shown successfully

API for Test Suites#ResponseEntityResponseEntity

400

Invalid json object or mandatory fields missing

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

...

Status Code

Reason

Response Model

200

Issues of particular execution shown successfully

API for Test Suites#ResponseEntityResponseEntity

400

Invalid json object or mandatory fields missing

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

...

Status Code

Reason

Response Model

200

List of Testcase Step Runs fetched successfully

API for Test Suites#ResponseEntityResponseEntity

400

Invalid json object or mandatory fields missing

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

...

Status Code

Reason

Response Model

200

Issues successfully linked to execution

API for Test Suites#ResponseEntityResponseEntity

400

Invalid json object or mandatory fields missing

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

...

Status Code

Reason

Response Model

200

Issues successfully unlinked from Testcase Run

API for Test Suites#ResponseEntityResponseEntity

400

Invalid json object or mandatory fields missing

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

...

Status Code

Reason

Response Model

200

Issues successfully linked to execution

API for Test Suites#ResponseEntityResponseEntity

400

Invalid json object or mandatory fields missing

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

...

Status Code

Reason

Response Model

200

Issues successfully unlinked from execution

API for Test Suites#ResponseEntityResponseEntity

400

Invalid json object or mandatory fields missing

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

...

Status Code

Reason

Response Model

200

List of issues shown successfully

API for Test Suites#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

runStatusID

body

yes

Id of the execution status to set(Id can be obtained from getInfo service response)

-

integer

dropID

body

no

Unique identifier of drop on which execution is to be performed

-

integer

qmTsRunId

body

yes

Id of Testsuite Run to execute

-

string

entityIDs

body

yes

Ids of Testcase Runs to execute

-

string

entityType

body

yes

Type of Entity('TCR'/'TCSR') to Execute

-

string

isAutoExecuted

body

no

0Manual

1Automated

0

boolean

username

body

no

Username of the user who is being authenticated

-

string

password

body

no

Password of the user who is being authenticated

-

string

...

Name

Located in

Required

Description

Default

Schema

agentParam

body

yes

provide agentParam

-

API for Test Suites#AgentParamAgentParam

Response

Content-Type: application/json

Status Code

Reason

Response Model

200

Agent scheduled successfully.

API for Test Suites#ResponseEntityResponseEntity

400

Invalid json object or mandatory fields missing

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

...

Get List of Test Run under execution.

POST /rest/execution/list/viewColumns

Request

Content-Type: application/json

...