API for Test Cases

Get List of Testcases in Folder

POST /rest/testcases/list

Description

Get list of test cases in folder.

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

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

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