Test Case

Create test case

POST /testcase

Description

Create test case.

Parameters

Type

Name

Description

Required

Schema

Default

BodyParameter

body

Test case object which needs to create.

true

JiraCreateIssueDetails

Responses

HTTP Code

Description

Schema

200

Successful operation.

No Content

400

Returned if the given request data is invalid.

No Content

403

Returned if the currently athenticated user does not have permission to create test case.

No Content

404

Returned if the required request data is not provided.

No Content

500

Returned if there is some problem while creating test case.

No Content

Consumes

application/json

Produces

application/json

Tags

Test Case

Get test cases linked with given test scenario

GET /testcase

Description

Get list of test cases by test scenario issue id.

Parameters

Type

Name

Description

Required

Schema

Default

QueryParameter

testScenarioIssueId

Issue id of test scenario

true

integer (int64)

QueryParameter

expand

Comma-separated list of entities that you want expanded.Possible values are stepunit and metadata

false

string

QueryParameter

maxResults

Maximum number of stepunits to return in each call. Maximum possible value is 200. By default the value mentioned in the Default column will be returned.

false

integer (int32)

50

QueryParameter

offset

Index of the first stepunit to return.Default is 0.

false

integer (int32)

0

QueryParameter

searchText

Serch Test Case within scenario by key or summary

false

string

Responses

HTTP Code

Description

Schema

200

Successful operation.

No Content

400

Returned if the given test scenario issue id or expand is invalid

No Content

403

Returned if the currently athenticated user does not have permission to access given test scenario

No Content

404

Returned if the given test scenario is not found.

No Content

500

Returned if there is some problem in retrieval of test cases.

No Content

Consumes

application/json

Produces

application/json

Tags

Test Case

Link test case in bulk to test scenario

PUT /testcase/link

Description

Link test case in bulk with given test scenario.

Parameters

Type

Name

Description

Required

Schema

Default

QueryParameter

testScenarioIssueId

Issue id of test scenario.

true

integer (int64)

BodyParameter

body

An array of test case issue ids.

true

TestCaseIssueIdsRequest

Responses

HTTP Code

Description

Schema

200

Successful operation

No Content

400

Returned if the given test scenario issue id / test case issue id is invalid.

No Content

403

Returned if the currently authenticated user does not have permission to associate test case.

No Content

404

Returned if the test scenario or test case issue ids are not provided.

No Content

500

Returned if exception occured during linking of test case.

No Content

Consumes

application/json

Produces

application/json

Tags

Test Case

Copy test steps of given test case to another test case

PUT /testcase/{copyFromTestCaseIssueId}/copyteststep

Description

All the test steps from given test case will get copied to another test case.

Parameters

Type

Name

Description

Required

Schema

Default

PathParameter

copyFromTestCaseIssueId

Issue id of test case from which you want to copy test steps

true

integer (int64)

QueryParameter

copyToTestCaseIssueId

Issue id of test case in which you want to test steps.

true

integer (int64)

Responses

HTTP Code

Description

Schema

200

Successful operation.

No Content

400

Returned if given test case issue id is invalid.

No Content

403

Returned if currently authenticated user does not have permission to access given test case.

No Content

404

Returned if test case issue id not provided.

No Content

500

Returned if there is some problem in copying test steps.

No Content

Consumes

application/json

Produces

application/json

Tags

Test Case

Delete a test case

DELETE /testcase/{issueId}/delete

Description

Delete a test case issue.

Parameters

Type

Name

Description

Required

Schema

Default

PathParameter

issueId

Issue id of test case

true

integer (int64)

Responses

HTTP Code

Description

Schema

200

Successful operation.

No Content

400

Returned if given test case issue id is invalid.

No Content

403

Returned if currently authenticated user does not have permission to delete test case.

No Content

500

Returned if there is some problem in deleting test case.

No Content

Consumes

application/json

Produces

application/json

Tags

Test Case

Get a test case details

GET /testcase/{testCaseIssueId}

Description

Get a test case details.

Parameters

Type

Name

Description

Required

Schema

Default

PathParameter

testCaseIssueId

Issue id of test case.

true

integer (int64)

QueryParameter

expand

Comma-separated list of entities that you want expanded.Possible values are metadata and stepunit.

false

string

Responses

HTTP Code

Description

Schema

200

Successful operation.

No Content

400

Returned if the given test case issue id is invalid.

No Content

403

Returned if the currently athenticated user does not have permission to access given test case.

No Content

500

Returned if exception occured during retrieval of test case details.

No Content

Produces

application/json

Tags

Test Case

Get execution summary of given test case

GET /testcase/{testCaseIssueId}/executionresultsummary

Description

Return count of given test case executions group by execution result.

Parameters

Type

Name

Description

Required

Schema

Default

PathParameter

testCaseIssueId

Issue id of test case.

true

integer (int64)

Responses

HTTP Code

Description

Schema

200

Successful operation.

No Content

400

Returned if the given test case issue id is invalid.

No Content

403

Returned if the currently authenticated user does not have permission to access given test case.

No Content

500

Returned if there is some problem occured during retrieval of test case.

No Content

Produces

application/json

Tags

Test Case

Get stories linked with given test case

GET /testcase/{testCaseIssueId}/issues

Description

Get list of stories linked with given test case.

Parameters

Type

Name

Description

Required

Schema

Default

PathParameter

testCaseIssueId

Issue id of test case

true

integer (int64)

QueryParameter

expand

Comma-separated list of entities that you want expanded.Possible value is metadata.

false

string

QueryParameter

maxResults

Maximum number of stories to return. Maximum possible value is 200. By default the value mentioned in the Default column will be returned.

false

integer (int32)

50

QueryParameter

offset

Index of the first story to return.Default is 0.

false

integer (int32)

0

Responses

HTTP Code

Description

Schema

200

Successful operation.

No Content

400

Returned if the given test case issue is invalid.

No Content

403

Returned if the currently athenticated user does not have permission to access given test case.

No Content

500

Returned if exception occured during retrieval of stories.

No Content

Produces

application/json

Tags

Test Case

Link test case with test scenario

PUT /testcase/{testCaseIssueId}/link

Description

Link test case with given test scenario.

Parameters

Type

Name

Description

Required

Schema

Default

PathParameter

testCaseIssueId

Issue id of test case.

true

integer (int64)

QueryParameter

testScenarioIssueId

Issue id of test scenario.

true

integer (int64)

Responses

HTTP Code

Description

Schema

200

Successful operation.

No Content

400

Returned if the given test scenario issue id / test case issue id is invalid.

No Content

403

Returned if the currently athenticated user does not have permission to link test case with given test scenario.

No Content

404

Returned if the given test scenario issue id is not found.

No Content

500

Returned if there is some problem in linking test case with test scenario.

No Content

Consumes

application/json

Produces

application/json

Tags

Test Case

Move a test case

PUT /testcase/{testCaseIssueId}/move

Description

Move a test case to given position.

Parameters

Type

Name

Description

Required

Schema

Default

PathParameter

testCaseIssueId

Issue id of test case

true

integer (int64)

QueryParameter

oldPos

Current position of test case. It is required as in one test scenario same test case can be linked twice.

true

integer (int32)

QueryParameter

newPos

New position of test case

true

integer (int32)

QueryParameter

testScenarioIssueId

Issue id of test scenario

true

integer (int64)

Responses

HTTP Code

Description

Schema

200

Successful operation.

No Content

400

Returned if request data is invalid.

No Content

403

Returned if currently authenticated user does not have permission to edit given test case.

No Content

404

Returned if required params are not provided.

No Content

500

Returned if there is some problem in moving test case.

No Content

Produces

application/json

Tags

Test Case

Get test case execution history

GET /testcase/{testCaseIssueId}/runs

Description

Get test case’s execution history along with story,test scenario, platform, execution result, executed by and associated defects.

Parameters

Type

Name

Description

Required

Schema

Default

PathParameter

testCaseIssueId

Issue id of test case.

true

integer (int64)

QueryParameter

maxResults

Maximum number of test cases to return in each call. Maximum possible value is 200. By default the value mentioned in the Default column will be returned.

false

integer (int32)

50

QueryParameter

offset

Index of the first test cases to return.Default is 0.

false

integer (int32)

0

Responses

HTTP Code

Description

Schema

200

Successful operation.

No Content

400

Returned if the given test case issue id is invalid.

No Content

403

Returned if the currently authenticated user does not have permission to access given test case.

No Content

500

Returned if there is some problem in retrieval of test case issues.

No Content

Produces

application/json

Tags

Test Case

Get test scenarios linked with given test case

GET /testcase/{testCaseIssueId}/testscenario

Description

Get list of test scenarios linked with given test case.

Parameters

Type

Name

Description

Required

Schema

Default

PathParameter

testCaseIssueId

Issue id of test case

true

integer (int64)

QueryParameter

expand

Comma-separated list of entities that you want expanded.Possible value is metadata.

false

string

QueryParameter

maxResults

Maximum number of test scenarios to return. Maximum possible value is 200. By default the value mentioned in the Default column will be returned.

false

integer (int32)

50

QueryParameter

offset

Index of the first test scenario to return.Default is 0.

false

integer (int32)

0

Responses

HTTP Code

Description

Schema

200

Successful operation.

No Content

400

Returned if the given test case issue is invalid.

No Content

403

Returned if the currently athenticated user does not have permission to access given test case.

No Content

500

Returned if exception occured during retrieval of test scenarios.

No Content

Produces

application/json

Tags

Test Case

Un-link test case from given test scenario

DELETE /testcase/{testCaseIssueId}/unlink

Description

Un-link test case from given test scenario. You need to provide either map id or issue ids of both test case and test scenario along with test case seq no.

Parameters

Type

Name

Description

Required

Schema

Default

PathParameter

testCaseIssueId

Issue id of test case.

true

integer (int64)

QueryParameter

mapId

Map id of test scenario with test case.

false

integer (int64)

QueryParameter

testScenarioIssueId

Issue id of test scenario.

false

integer (int64)

QueryParameter

seqNo

Sequence number of test case.

false

integer (int64)

Responses

HTTP Code

Description

Schema

200

Successful operation.

No Content

400

Returned if the given request data is invalid.

No Content

403

Returned if the currently athenticated user does not have permission to unlink given test case.

No Content

404

Returned if the given test scenario is not found.

No Content

500

Returned if there is some problem in unlinking test case.

No Content

Consumes

application/json

Produces

application/json

Tags

Test Case

Copy a folder

POST /folder/copy

Description

Copy a folder.

Parameters

Type

Name

Description

Required

Schema

Default

BodyParameter

body

Source folder Id, destination folder id, project id, name of folder.

true

FolderCopyRequest

Responses

HTTP Code

Description

Schema

200

Successful operation.

No Content

500

Returned if there is some problem in copying a folder.

No Content

Consumes

application/json

Produces

application/json

Tags

Test Case

Create a New Folder

POST /folder/create

Description

Create a new folder.

Parameters

Type

Name

Description

Required

Schema

Default

BodyParameter

body

Folder data object that needs to create.

true

FolderCreateRequest

Responses

HTTP Code

Description

Schema

200

Successful operation.

No Content

500

Returned if there is some problem in creating a folder.

No Content

Consumes

application/json

Produces

application/json

Tags

Test Case

Move a Folder

POST /folder/cut

Description

Move a folder.

Parameters

Type

Name

Description

Required

Schema

Default

BodyParameter

body

Folder id, destination (new parent) folder id, project id.

true

FolderMoveRequest

Responses

HTTP Code

Description

Schema

200

Successful operation.

No Content

500

Returned if there is some problem in moving a folder.

No Content

Consumes

application/json

Produces

application/json

Tags

Test Case

Delete a Folder

DELETE /folder/delete/{projectId}/{folderId}/{destinationFolderId}

Description

Delete a folder.

Parameters

Type

Name

Description

Required

Schema

Default

PathParameter

folderId

Folder id to be delete

true

integer (int64)

PathParameter

projectId

Current project id

true

integer (int64)

PathParameter

destinationFolderId

Destination folder id to move current folder data

true

integer (int64)

Responses

HTTP Code

Description

Schema

200

Successful operation.

No Content

500

Returned if there is some problem in moving a folder.

No Content

Consumes

application/json

Produces

application/json

Tags

Test Case

Get List of Folders based on Project ID

POST /folder/getFolderTree

Description

Get List of folders based on project id

Parameters

Type

Name

Description

Required

Schema

Default

BodyParameter

body

project id to get list of folders for particular project

true

FolderPathRequest

Responses

HTTP Code

Description

Schema

200

Successful operation.

No Content

500

Returned if there is some problem in fetching a list of folder.

No Content

Consumes

application/json

Produces

application/json

Tags

Test Case

Get List of Projects

GET /folder/getProjects

Description

Get List of folders based on project id

Parameters

Responses

HTTP Code

Description

Schema

200

Successful operation.

No Content

500

Returned if there is some problem in fetching a list of project.

No Content

Consumes

application/json

Produces

application/json

Tags

Test Case

Update a folder

PUT /folder/rename

Description

Current folder id to rename.

Parameters

Type

Name

Description

Required

Schema

Default

BodyParameter

body

Current folder id to rename.

true

FolderUpdateRequest

Responses

HTTP Code

Description

Schema

200

Successful operation.

No Content

500

Returned if there is some problem in updating a folder.

No Content

Consumes

application/json

Produces

application/json

Tags

Test Case

Get Folder Data

POST /folder/testcases

Description

Get folder data.

Parameters

Type

Name

Description

Required

Schema

Default

BodyParameter

body

Folder data to get list of testcases based on filter/jql.

true

FolderGetFolderDataRequest

Responses

HTTP Code

Description

Schema

200

Successful operation.

No Content

500

Returned if there is some problem in getting a folder data.

No Content

Consumes

application/json

Produces

application/json

Tags

Test Case

Create New Test Cases in Folder

POST /folder/testcases/add

Description

Create new test case in specific folder.

Parameters

Type

Name

Description

Required

Schema

Default

BodyParameter

body

Folder id and issue id of newly created testcase.

true

FolderDataRequest

Responses

HTTP Code

Description

Schema

200

Successful operation.

No Content

500

Returned if there is some problem in getting a folder data.

No Content

Consumes

application/json

Produces

application/json

Tags

Test Case

Add Selected Test Cases to Specified Story

PUT /folder/testcases/addToStory

Description

Add selected test cases to specified story.

Parameters

Type

Name

Description

Required

Schema

Default

BodyParameter

body

Story issue id, list of test case id,folder id, filter by.

true

FolderDataRequest

Responses

HTTP Code

Description

Schema

200

Successful operation.

No Content

500

Returned if there is some problem in add test case to story.

No Content

Consumes

application/json

Produces

application/json

Tags

Test Case

Add selected test cases to specified test run

PUT /folder/testcases/addToTestRun

Description

Add selected test cases to specified test run.

Parameters

Type

Name

Description

Required

Schema

Default

BodyParameter

body

Test run id, list of test case id.

true

FolderDataRequest

Responses

HTTP Code

Description

Schema

200

Successful operation.

No Content

500

Returned if there is some problem in add test case to story.

No Content

Consumes

application/json

Produces

application/json

Tags

Test Case

Move selected testcases in specific folder

PUT /folder/testcases/move

Description

Move selected testcases in specific folder.

Parameters

Type

Name

Description

Required

Schema

Default

BodyParameter

body

Folder id, destination folder id and selected list of testcase id.

true

FolderCopyMoveTestCaseRequest

Responses

HTTP Code

Description

Schema

200

Successful operation.

No Content

500

Returned if there is some problem in copying test cases to folder.

No Content

Consumes

application/json

Produces

application/json

Tags

Test Case

Copy/Reuse selected testcases in specific folder

PUT /folder/testcases/reuse

Description

Move selected testcases in specific folder.

Parameters

Type

Name

Description

Required

Schema

Default

BodyParameter

body

Folder id, destination folder id and selected list of testcase id.

true

FolderCopyMoveTestCaseRequest

Responses

HTTP Code

Description

Schema

200

Successful operation.

No Content

500

Returned if there is some problem in copying test cases to folder.

No Content

Consumes

application/json

Produces

application/json

Tags

Test Case

JiraCreateIssueDetails

Name

Description

Required

Schema

Default

summary

Issue summary

true

string

projectId

Project Id

true

string

reporter

Reporter of issue

false

string

duedate

Due Date associated to issue

false

string

description

Issue description

false

string

assignee

Assignee of Issue

false

string

priority

Issue priority

false

string

versions

An array of version ids.

false

string array

labels

An array of labels associated to issue

false

string array

components

An array of component ids.

false

string array

TestCaseIssueIdsRequest

Name

Description

Required

Schema

Default

testCaseIds

Array of testCaseIds

true

integer (int64) array

jql

false

string

FolderCopyRequest

Name	Description	Required	Schema
folderId	Source Folder ID	true	integer (int32)
newParentFolderId	Destination Folder ID	true	integer (int32)
projectId	Project ID	true	integer (int32)
name	Name of the folder You want to create	true	string

FolderCreateRequest

Name	Description	Required	Schema
name	Name of the folder you want to create	true	string
projectId	Project Name to create folder	true	integer (int32)
parentFolderId	ParentFolder ID for Sub Folder	true	integer (int32)

FolderMoveRequest

Name	Description	Required	Schema
folderId	Source Folder ID	true	integer (int32)
newParentFolderId	Destination Folder ID	true	integer (int32)
projectId	Project ID	true	integer (int32)

FolderPathRequest

Name	Description	Required	Schema
projectId	Project Id to Get List of Folders	true	integer (int32)
folderPreference	Save Folder Sorting Preference	false	string
savePreference	Save Preference Flag to preserve the folder preferences	false	boolean
folderId	Current folder id to skip its child folder as well current folder	false	integer (int32)

FolderUpdateRequest

Name	Description	Required	Schema	Default
folderId	Id of the Folder you want to update	true	integer (int32)
name	Updated Name of the Folder	true	string

FolderGetFolderDataRequest

Name	Description	Required	Schema	Example
folderId	ID of the folder to Get Data	true	integer (int32)
filterBy	Filder TestCase	false	array[KeyValue]	[{key: "searchText", value: ["Test case1"]}]
jql	Filter TestCase by JQL	false	string
maxResults	MaxResult to Show	false	integer (int32)
offset	Offset for Result	false	integer (int32)
projectId	Offset for Result	false	integer (int32)
sortColumn	name of the Column to Sort ex.key,summary,createdby	false	string
sortOrder	Order of the sorting Column ex.asc,desc	false	string
savePreference	Save Folder Filter Preference	false	boolean

FolderDataRequest

Name	Description	Required	Schema
folderId	-	false	integer (int32)
destinationFolderId	-	false	integer (int32)
parentFolderId	-	false	integer (int32)
newParentFolderId	-	false	integer (int32)
folderFilterId	-	false	integer (int32)
name	-	false	string
projectId	-	false	integer (int32)
maxResults	-	false	integer (int32)
offset	-	false	integer (int32)
filterBy	-	false	array[KeyValue]
folderPreference	-	false	string
jql	-	false	string
testcaseId	-	false	integer (int32)
testcaseIdList	-	false	array[integer]
uncheckTestCases	-	false	array[integer]
isAllSelected	-	false	boolean
searchText	-	false	string
createdBy	-	false	string
createdOn	-	false	string (date-time)
lastUpdatedBy	-	false	string
lastUpdatedOn	-	false	string (date-time)
subFolderCount	-	false	integer (int32)
testRunIdToLink	-	false	string
storyIdToLink	-	false	integer (int32)
sortColumn	-	false	string
sortOrder	-	false	string

FolderCopyMoveTestCaseRequest

Name	Description	Required	Schema	Example
folderId	Source Folder ID	true	integer (int32)
destinationFolderId	Destination folder ID	true	integer (int32)
testcaseIdList	List of TestCase Ids to Copy	true	array[integer]
isAllSelected	All TestCase Selected Within Folder	false	boolean
jql	JQL to filter the TestCase	false	string
filterBy	Filder TestCase	false	array[KeyValue]	[{key: "searchText", value: ["Test case1"]}]

KeyValue

Name	Description	Required	Schema	Default
key	-	false	string
value	-	false	array[string]