Test Run

Create test run

POST /testrun

Description

Create test run.

Parameters

Type

Name

Description

Required

Schema

Default

BodyParameter

body

Test run object which needs to create.

true

JiraCreateIssueDetails

Responses

HTTP Code

Description

Schema

200

Successful operation.

No Content

400

Returned if the given test run is invalid.

No Content

403

Returned if user does not have permission to create test run.

No Content

404

Returned if the given test run details is invalid.

No Content

500

Returned if there is some problem in creating test run.

No Content

Consumes

application/json

Produces

application/json

Tags

Test Run

Expand test case in execution details

POST /testrun/testexecution/{testRunIssueId}/{testResultId}

Description

expand test case in execution details

Parameters

Type

Name

Description

Required

Schema

Default

PathParameter

testRunIssueId

Issue id of test run

true

integer (int64)

PathParameter

testResultId

Testresult id (testResultIds of Test cases can be retrieved via API - POST /testrun/testexecution/{testRunIssueId})

false

integer (int64)

BodyParameter

body

TestRuprogressnExecutionRequest Object

true

TestRunExecutionRequest

Responses

HTTP Code

Description

Schema

200

Successful operation.

No Content

400

Returned if the given test run issue id is invalid.

No Content

403

Returned if the currently athenticated user does not have permission view test run execution details.

No Content

500

Returned if exception occured while fetching test run execution details.

No Content

Consumes

application/json

Produces

application/json

Tags

Test Run

Copy issues linked with given test run to another test run

PUT /testrun/{copyFromTestRunIssueId}/copytestresult

Description

Copy issues linked with given test run to another test run. Note - You can copy to only blank test run

Parameters

Type

Name

Description

Required

Schema

Default

PathParameter

copyFromTestRunIssueId

Issue id of copy from test run.

true

integer (int64)

BodyParameter

body

Details for cloning Test run.

true

ClonedTestRun

Responses

HTTP Code

Description

Schema

200

Successful operation.

No Content

400

Returned if the given test run issue id is invalid.

No Content

403

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

No Content

404

Returned if the given test run issue id is not provided.

No Content

500

Returned if there is some problem in copying test results.

No Content

Produces

application/json

Tags

Test Run

Move story or test scenario/case with in given test run

PUT /testrun/{issueId}/move

Description

Move story or test scenario/case to given position.

Parameters

Type

Name

Description

Required

Schema

Default

QueryParameter

testRunIssueId

Issue id of story.

true

integer (int64)

QueryParameter

oldPos

The old position of story or test scenario/case.

true

integer (int32)

QueryParameter

newPos

The new position of story or test scenario/case.

true

integer (int32)

PathParameter

issueId

The id of story or test scenario/case to move.

true

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 authenticated user does not have permission to edit given test run.

No Content

404

Returned if the required params are not provided.

No Content

500

Returned if there is some problem in moving story or test scenario/case.

No Content

Produces

application/json

Tags

Test Run

Get test run issue details

GET /testrun/{testRunIssueId}

Description

Get test run issue details.

Parameters

Type

Name

Description

Required

Schema

Default

PathParameter

testRunIssueId

Issue id of test run.

true

integer (int64)

QueryParameter

expand

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

false

string

Responses

HTTP Code

Description

Schema

200

Successful operation.

No Content

400

Returned if the given test run issue id is invalid.

No Content

403

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

No Content

500

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

No Content

Produces

application/json

Tags

Test Run

Update Test run summary and comment

PUT /testrun/{testRunIssueId}

Description

Update Test run summary and comment.

Parameters

Type

Name

Description

Required

Schema

Default

PathParameter

testRunIssueId

Issue id of test run

true

integer (int64)

BodyParameter

body

IssueFieldRequest Object

true

IssueFieldRequest

Responses

HTTP Code

Description

Schema

200

Successful operation.

No Content

400

Returned if the given test run issue id is invalid.

No Content

403

Returned if the currently athenticated user does not have permission view test run details.

No Content

404

Returned if the required data is not present.

No Content

500

Returned if exception occured while saving data.

No Content

Consumes

application/json

Produces

application/json

Tags

Test Run

Get automation details for given test scenario or test case

GET /testrun/{testRunIssueId}/automation/{resultId}

Description

Get automation details for given test scenario or test case.

Parameters

Type

Name

Description

Required

Schema

Default

PathParameter

testRunIssueId

Issue Id of Test Run

true

integer (int64)

PathParameter

resultId

Result Id

true

integer (int64)

Responses

HTTP Code

Description

Schema

200

Successful operation.

No Content

400

Returned if the given test run is invalid.

No Content

403

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

No Content

500

Returned if there is some problem while fetching result.

No Content

Consumes

application/json

Produces

application/json

Tags

Test Run

Delete test run

DELETE /testrun/{testRunIssueId}/delete

Description

Delete test run issue.

Parameters

Type

Name

Description

Required

Schema

Default

PathParameter

testRunIssueId

Issue id of test run

true

integer (int64)

Responses

HTTP Code

Description

Schema

200

Successful operation.

No Content

400

Returned if the given test run issue id is invalid.

No Content

403

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

No Content

500

Returned if there is some problem in deleting test run.

No Content

Consumes

application/json

Produces

application/json

Tags

Test Run

Get execution result count

GET /testrun/{testRunIssueId}/executionresultcount

Description

Get execution result for given test run.

Parameters

Type

Name

Description

Required

Schema

Default

PathParameter

testRunIssueId

Issue id of test run.

true

integer (int64)

QueryParameter

resultId

Id of execution result.

false

integer (int32)

QueryParameter

assignee

Possible values are ME, OTHERS and ALL.By default ALL will be returned.

false

string

ALL

Responses

HTTP Code

Description

Schema

200

Successful operation.

No Content

400

Returned if the given test run issue id is invalid.

No Content

403

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

No Content

500

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

No Content

Produces

application/json

Tags

Test Run

Export test run result

POST /testrun/{testRunIssueId}/export

Description

Export test run result data.

Parameters

Type

Name

Description

Required

Schema

Default

PathParameter

testRunIssueId

Issue Id of Test Run

true

integer (int64)

BodyParameter

body

TestRunExecutionRequest Object

true

TestRunExecutionRequest

Responses

HTTP Code

Description

Schema

200

Successful operation export response is xls

No Content

400

Returned if the given test run id is invalid.

No Content

403

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

No Content

404

Returned if given test run id is not found.

No Content

500

Returned if there is some problem in exporting report.

No Content

Consumes

application/json

Tags

Test Run

Get Test Cases/Scenarios and Stories linked with given test run

GET /testrun/{testRunIssueId}/issues

Description

Get Test Cases/Scenarios and Stories linked with given test run along with their summary and status.

Parameters

Type

Name

Description

Required

Schema

Default

PathParameter

testRunIssueId

Issue id of test run

true

integer (int64)

QueryParameter

maxResults

Maximum number of issues 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)

10

QueryParameter

offset

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

false

integer (int32)

0

QueryParameter

searchText

Possible values are test scenarios/stories based on filter

false

string

Responses

HTTP Code

Description

Schema

200

Successful operation.

No Content

400

Returned if the given test run issue id is invalid.

No Content

403

Returned if the currently athenticated user does not have permission view test run details.

No Content

404

Returned if the assignee or test run issue id is not provided.

No Content

500

Returned if exception occured while fetching issues.

No Content

Consumes

application/json

Produces

application/json

Tags

Test Run

Link stories, test cases/scenarios in bulk with test run

PUT /testrun/{testRunIssueId}/link

Description

Link story or test case/scenario in bulk with test run.

Parameters

Type

Name

Description

Required

Schema

Default

PathParameter

testRunIssueId

Issue id of test run

true

integer (int64)

BodyParameter

body

Story or test scenario issue list

true

IssueIdsRequest

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 authenticated user does not have permission to link bulk of issues with test run.

No Content

404

Returned if given testRunIssueId or externalIssueId is not found.

No Content

500

Returned if there is some problem in linking bulk of issues with test run.

No Content

Consumes

application/json

Produces

application/json

Tags

Test Run

Link story or test case/scenario with test run

PUT /testrun/{testRunIssueId}/link/{issueId}

Description

Link story or test case/scenario with test run.

Parameters

Type

Name

Description

Required

Schema

Default

PathParameter

testRunIssueId

Issue id of test run

true

integer (int64)

PathParameter

issueId

Issue id of story or test scenario

true

integer (int64)

Responses

HTTP Code

Description

Schema

200

Successful operation.

No Content

403

Returned if the currently authenticated user does not have permission to link issue with test run.

No Content

404

Returned if given testRunIssueId or issueId is not found.

No Content

500

Returned if there is some problem in linking issue with test run.

No Content

Consumes

application/json

Produces

application/json

Tags

Test Run

Update platform of test run

PUT /testrun/{testRunIssueId}/platform

Description

Update platform of given test run.

Parameters

Type

Name

Description

Required

Schema

Default

PathParameter

testRunIssueId

Issue id of test run.

true

integer (int64)

QueryParameter

platformId

Id of platform.

true

integer (int64)

Responses

HTTP Code

Description

Schema

200

Successful operation.

No Content

400

Returned if platform id is invalid.

No Content

403

Returned if the currently authenticated user does not have permission to access given test run or platform.

No Content

404

Returned if the given test run or platform is not found.

No Content

500

Returned if there is some problem in updating of platform of test run.

No Content

Consumes

application/json

Produces

application/json

Tags

Test Run

Rebuild test run

POST /testrun/{testRunIssueId}/rebuild

Description

Refresh the given test run linkage with test scenarios, test cases and test steps based on the current state.

Parameters

Type

Name

Description

Required

Schema

Default

PathParameter

testRunIssueId

Issue id of test run.

true

integer (int64)

BodyParameter

body

List of testResultIds.

false

integer (int64) array

Responses

HTTP Code

Description

Schema

200

Successful operation.

No Content

400

Returned if the given test run issue id is invalid.

No Content

403

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

No Content

500

Returned if there is some problem occured during rebuild of test run.

No Content

Produces

application/json

Tags

Test Run

Get Test Steps which are linked with Test Case

GET /testrun/{testRunIssueId}/testcase/{testCaseIssueId}/teststep

Description

Get Test Steps which are linked with Test Case.

Parameters

Type

Name

Description

Required

Schema

Default

PathParameter

testRunIssueId

Issue id of test run

true

integer (int64)

QueryParameter

testScenarioIssueId

Issue id of test scenario. This parameter is true if a Test case is linked to Test Scenario.

false

integer (int64)

PathParameter

testCaseIssueId

Issue id of test case

true

integer (int64)

QueryParameter

testCaseSeqNo

Sequence number of test case within test scenario or Story or Test Run (whichever it is directly linked with).

true

integer (int32)

QueryParameter

storyIssueId

Issue id of test story. This parameter is true if a Test case is linked to Story. or Test cases is linked to Test Scenario which then linked to Story.

false

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 case details needed to be fetched.

false

integer (int32)

0

QueryParameter

resultId

Id of execution result.

false

integer (int32)

QueryParameter

expand

Possible values are metadata, teststep and defect

false

string

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 authenticated user does not have permission to get data.

No Content

404

Returned if required request data is missing.

No Content

500

Returned if there is some problem in fetching data.

No Content

Consumes

application/json

Produces

application/json

Tags

Test Run

Get Test Cases which are linked with Test Scenario

GET /testrun/{testRunIssueId}/testscenario/{testScenarioIssueId}/testcase

Description

Get Test Cases which are linked with Test Scenario.

Parameters

Type

Name

Description

Required

Schema

Default

PathParameter

testRunIssueId

Issue id of test run

true

integer (int64)

PathParameter

testScenarioIssueId

Issue id of test scenario. It mandatory if Test case is linked to Test scenario on Test Run.

false

integer (int64)

QueryParameter

storyIssueId

Issue id of test story. It mandatory if Test case is linked to a Story, or Test scenario and then Test scenario to Story on Test Run.

false

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 case details needed to be fetched.

false

integer (int32)

0

QueryParameter

resultId

Id of execution result.

false

integer (int32)

QueryParameter

expand

Possible values are metadata, teststep and defect

false

string

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 authenticated user does not have permission to get data.

No Content

404

Returned if required request data is missing.

No Content

500

Returned if there is some problem in fetching data.

No Content

Consumes

application/json

Produces

application/json

Tags

Test Run

Unlink story or test scenario/case from test run

DELETE /testrun/{testRunIssueId}/unlink/{issueId}

Description

Unlink story or test scenario/case from test run.

Parameters

Type

Name

Description

Required

Schema

Default

PathParameter

testRunIssueId

Issue id of test run

true

integer (int64)

PathParameter

issueId

Issue id of story or test scenario/case

true

integer (int64)

Responses

HTTP Code

Description

Schema

200

Successful operation.

No Content

403

Returned if the currently authenticated user does not have permission to unlink issue from test run.

No Content

404

Returned if given testRunIssueId or issueId is not found.

No Content

500

Returned if there is some problem in Unlinking issue from test run.

No Content

Consumes

application/json

Produces

application/json

Tags

Test Run

Update comment, execution result or actual result

PUT /testrun/{testRunIssueId}/update

Description

You can update either comment, actual result, execution result or all of them together.Here you can directly pass test result id or multiple issue ids.

Parameters

Type

Name

Description

Required

Schema

Default

PathParameter

testRunIssueId

Issue id of test run.

true

integer (int64)

BodyParameter

body

Update test run result details.

true

UpdateTestRunRequest

Responses

HTTP Code

Description

Schema

200

Successful operation.

No Content

400

Returned if request data is invalid.

No Content

403

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

No Content

404

Returned if the given test run or platform is not found.

No Content

500

Returned if there is some problem in updating of result of test run.

No Content

Consumes

application/json

Produces

application/json

Tags

Test Run

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

IssueFieldRequest

Name

Description

Required

Schema

Default

comment

false

string

summary

false

string

platform

false

integer (int64)

TestRunExecutionRequest

Name

Description

Required

Schema

Default

projectId

project id of test run

true

integer (int64)

offset

true

integer (int32)

maxResults

max no of result you want

false

integer (int32)

whereClause

for filtering test execution

true

KeyValue array

assignedToUsers

array of user key for filtering test execution

true

string array

assignedToUsersName

array of user name for filtering test execution

false

string array

executionResult

array of execution result id for filtering test execution

true

integer (int32) array

testScenarioWithDefectRequired

issues with defect for filtering test execution

true

boolean

false

paginationCountUpdateRequired

false

boolean

false

sortByTestCase

1 for sort by test case and 0 for unsorted

false

integer (int32)

automationRun

false

boolean

false

IssueIdsRequest

Name	Description	Required	Schema	Default
issueIds	Array of issue ids	true	integer (int64) array

TestRunRequest

Name	Required	Schema
filter	false	KeyValue array
testRunIssueId	true	integer (int64)
resultId	false	integer (int32)
storyIssueId	false	integer (int32)
maxResults	false	integer (int32)
offset	false	integer (int32)
assignee	false	string
expand	false	string
searchText	false	string

KeyValue

Name	Description	Required	Schema	Default
key		false	string
value		false	string array

UpdateTestRunRequest

Name

Description

Required

Schema

Default

testResultId

Id of test result

false

integer (int64)

result

false

integer (int64)

actualResult

Actual result

false

string

comment

Comment

false

string

assignedUser

Assigned User

false

string

storyIssueId

Issue id of story.

false

integer (int64)

testScenarioIssueId

Issue id of test scenario.

false

integer (int64)

actionStepIssueId

Issue id of test case.

false

integer (int64)

stepUnitId

Id of step unit.

false

integer (int64)

ClonedTestRun

Name

Description

Required

Schema

Default

issueData

false

string

platform

false

string

name

false

string

clonedIssueId

false

string

clonedIssueKey

false

string

defect

false

boolean

false

copyComments

false

boolean

false

copyActualResult

false

boolean

false

status

false

ClonedTestRunStatus

projectId

false

string

additionalProperties

false

object

ClonedTestRunStatus

Name

Description

Required

Schema

Default

status

false

string

idList

false

integer (int32) array

statusToBeAssigned

false

string