Test Run

Create test run

POST /testrun

Description

Create test run.

Parameters

Type	Name	Description	Schema	Default
Body	body required	Test run object which needs to create.	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

Copy test run linkage.

PUT /testrun/{copyFromTestRunIssueId}/copytestresult

Description

Copy all the linkage of one test run to another test run.

Parameters

Type	Name	Description	Schema
Path	copyFromTestRunIssueId required	Issue id of copy from test run.	integer(int64)
Path	platformId required	Id of platform.	integer(int64)
Query	copyToTestRunIssueId required	Issue id of copy to test run.	integer(int64)

Responses

HTTP Code	Description	Schema
200	Successful operation.	No Content
400	Returned if the given test scenario 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 scenario 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

Get test run details

GET /testrun/{testRunIssueId}

Description

Get test run details.

Parameters

Type	Name	Description	Schema	Default
Path	testRunIssueId required	Issue id of test run.	integer(int64)
Query	expand optional	Comma-separated list of entities that you want expanded.Possible values are testScenario and metadata.	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

Assign Test Scenario to given user

PUT /testrun/{testRunIssueId}/assigntestscenario

Description

Assign test scenarios to given users.

Parameters

Type	Name	Description	Schema	Default
Path	testRunIssueId required	Issue id of test run.	integer(int64)
Body	body optional	List of objects	< UserScenarioAssociation > array

Responses

HTTP Code	Description	Schema
200	Successful operation	No Content
400	Returned if the given issue details is invalid.	No Content
403	Returned if the currently authenticated user does not have permission.	No Content
500	Returned if any problem occured during this process.	No Content

Consumes

application/json

Produces

application/json

Tags

Test Run

Update test run details

PUT /testrun/{testRunIssueId}/bulkupdate

Description

Update either comment, actual result or/and execution result of test run in bulk.

Parameters

Type	Name	Description	Schema	Default
Path	testRunIssueId required	Issue id of test run.	integer(int64)
Body	body required	Update test run result details.	UpdateBulkTestRunRequest

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

Delete test run

DELETE /testrun/{testRunIssueId}/delete

Description

Delete test run issue.

Parameters

Type	Name	Description	Schema	Default
Path	testRunIssueId required	Issue id of test run	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

Clean up test run

DELETE /testrun/{testRunIssueId}/discard

Description

Remove action step or test scenario from given test run which is either removed or unlinked.

Parameters

Type	Name	Description	Schema	Default
Path	testRunIssueId required	Issue Id of Test Run	integer(int64)

Responses

HTTP Code	Description	Schema
200	Successful operation	No Content
403	Returned if user does not have permission to do clean up.	No Content
500	Returned if exception occured while clean up.	No Content

Consumes

application/json

Produces

application/json

Tags

Test Run

Group by test scenario by execution result

GET /testrun/{testRunIssueId}/executionresultcount

Description

Group by test scenario by execution status. You can futher filter this by assignee or/and execution result.

Parameters

Type	Name	Description	Schema	Default
Path	testRunIssueId required	Issue id of test run.	integer(int64)
Query	assignee optional	Possible values are ME, OTHERS and ALL.By default ALL will be returned.	string	`"ALL"`
Query	resultId optional	Id of execution result.	integer(int32)

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

Link issues in bulk with test run

PUT /testrun/{testRunIssueId}/link

Description

Link story or test scenario in bulk with test run.

Parameters

Type	Name	Description	Schema	Default
Path	testRunIssueId required	Issue id of test run	integer(int64)
Body	body required	Story or test scenario issue list	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 scenario with test run

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

Description

Link story or test scenario with test run.

Parameters

Type	Name	Description	Schema	Default
Path	issueId required	Issue id of story or test scenario	integer(int64)
Path	testRunIssueId required	Issue id of test run	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	Schema	Default
Path	testRunIssueId required	Issue id of test run.	integer(int64)
Query	platformId required	Id of platform.	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, action steps and step units based on the current state.

Parameters

Type	Name	Description	Schema	Default
Path	testRunIssueId required	Issue id of test run.	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 occured during rebuild of test run.	No Content

Produces

application/json

Tags

Test Run

Get test scenario execution details

GET /testrun/{testRunIssueId}/testscenario

Description

Get test scenario execution details by given test run. You can further filter your results by execution result or/and assignee.

Parameters

Type	Name	Description	Schema	Default
Path	testRunIssueId required	Issue id of test run	integer(int64)
Query	assignee optional	Possible values are ME, OTHERS and ALL.By default ALL will be returned.	string	`"ALL"`
Query	expand optional	Possible values are metadata and defect	string
Query	maxResults optional	Number of scenarios upto which data should be fetched	integer(int32)
Query	offset optional	offset from which test scenario details needed to be fetched.	integer(int32)
Query	resultId optional	offset from which test scenario details needed to be fetched.	integer(int32)

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 test scenarios.	No Content

Consumes

application/json

Produces

application/json

Tags

Test Run

Get action step execution details

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

Description

Get action step execution details by given test run issue id. You can further filter your results by execution result or/and assignee.

Parameters

Type	Name	Description	Schema
Path	testRunIssueId required	Issue id of test run	integer(int64)
Path	testScenarioIssueId required	Issue id of test scenario	integer(int64)
Query	expand optional	Possible values are metadata, stepunit and defect	string
Query	maxResults optional	Number of action steps upto which data should be fetched	integer(int32)
Query	offset optional	offset from which action step details needed to be fetched.	integer(int32)
Query	resultId optional	Id of execution result.	integer(int32)
Query	storyIssueId optional	Issue id of test story	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 view actionstep results.	No Content
404	Returned if the test scenario and test run issue id are not provided.	No Content
500	Returned if exception occured while fetching action steps.	No Content

Consumes

application/json

Produces

application/json

Tags

Test Run

Get step unit execution details

GET /testrun/{testRunIssueId}/testscenario/{testScenarioIssueId}/actionstep/{actionStepIssueId}/stepunit

Description

Get step unit execution details by given action step, test scenario, test run and story. You can further filter your results by execution result or/and assignee.

Parameters

Type	Name	Description	Schema
Path	actionStepIssueId required	Issue id of action steo	integer(int64)
Path	testRunIssueId required	Issue id of test run	integer(int64)
Path	testScenarioIssueId required	Issue id of test scenario	integer(int64)
Query	actionStepSeqNo required	Sequence number of action step with in test scenario	integer(int32)
Query	expand optional	Possible values are metadata, stepunit and defect	string
Query	maxResults optional	Number of action steps upto which data should be fetched	integer(int32)
Query	offset optional	offset from which action step details needed to be fetched.	integer(int32)
Query	resultId optional	Id of execution result.	integer(int32)
Query	storyIssueId optional	Issue id of test story	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 view stepunit results.	No Content
404	Returned if the required request data is not provided.	No Content
500	Returned if exception occured while fetching step units.	No Content

Consumes

application/json

Produces

application/json

Tags

Test Run

Update result of test run

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	Schema	Default
Path	testRunIssueId required	Issue id of test run.	integer(int64)
Body	body required	Update test run result details.	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

Definition

JiraCreateIssueDetails

Name	Description	Schema
assignee optional	Assignee of Issue	string
components optional	An array of component ids.	< string > array
description optional	Issue description	string
duedate optional	Due Date associated to issue	string
labels optional	An array of labels associated to issue	< string > array
priority optional	Issue priority	string
projectId required	Project Id	string
reporter optional	Reporter of issue	string
summary required	Issue summary	string
versions optional	An array of version ids.	< string > array

UserScenarioAssociation

Name	Description	Schema
storyIssueId required	Issue id of story	integer(int64)
testResultId optional	Id of test result	integer(int32)
testScenarioIssueId optional	Issue id of test scenario	integer(int64)
username optional	User key of Assignee	string

UpdateBulkTestRunRequest

Name	Description	Schema
testDetails required	Array of test result objects	< UpdateTestRunRequest > array

IssueIdsRequest

Name	Description	Schema
issueIds required	Array of issue ids	< integer(int64) > array

UpdateTestRunRequest

Name	Description	Schema
actionStepIssueId optional	Issue id of action step.	integer(int64)
actualResult optional	Actual result	string
comment optional	Comment	string
result optional	result	integer(int64)
stepUnitId optional	Id of step unit.	integer(int64)
storyIssueId optional	Issue id of story.	integer(int64)
testResultId optional	Id of test result	integer(int64)
testScenarioIssueId optional	Issue id of test scenario.	integer(int64)

JiraCreateIssueDetails

Name	Description	Schema
assignee optional	Assignee of Issue	string
components optional	An array of component ids.	< string > array
description optional	Issue description	string
duedate optional	Due Date associated to issue	string
labels optional	An array of labels associated to issue	< string > array
priority optional	Issue priority	string
projectId required	Project Id	string
reporter optional	Reporter of issue	string
summary required	Issue summary	string
versions optional	An array of version ids.	< string > array