Test Scenario



Create test scenario

POST /testscenario

Description

Create test scenario issue.


Parameters

TypeNameDescriptionRequiredSchemaDefault

BodyParameter

body

Test scenario object which needs to create.

true

JiraCreateIssueDetails



Responses

HTTP CodeDescriptionSchema

200

Successful operation.

No Content

400

Returned if the given test scenario is invalid.

No Content

403

Returned if user does not have permission to create issue in JIRA.

No Content

404

Returned if the required request data is not provided.

No Content

500

Returned if there is some problem in creating test scenario.

No Content


Consumes

  • application/json


Produces

  • application/json


Tags

  • Test Scenario


Copy test cases of given test scenario to another test scenario

PUT /testscenario/{copyFromTestScenarioIssueId}/copytestcase

Description

Copy test cases from one test scenario to another test scenario. Here we will not create new test case issues. Same test cases will get copied to another test scenario.


Parameters

TypeNameDescriptionRequiredSchemaDefault

PathParameter

copyFromTestScenarioIssueId

Issue id of test scenario from which you want to copy test cases.

true

integer (int64)


QueryParameter

copyToTestScenarioIssueId

Issue id of test scenario in which you want to copy test cases.

true

integer (int64)



Responses

HTTP CodeDescriptionSchema

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

No Content


Produces

  • application/json


Tags

  • Test Scenario


Delete test scenario

DELETE /testscenario/{issueId}/delete

Description

Delete test scenario issue.


Parameters

TypeNameDescriptionRequiredSchemaDefault

PathParameter

issueId

Issue id of test scenario

true

integer (int64)



Responses

HTTP CodeDescriptionSchema

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

500

Returned if there is some problem in deleting test scenario.

No Content


Consumes

  • application/json


Produces

  • application/json


Tags

  • Test Scenario


Get test scenario

GET /testscenario/{testScenarioIssueId}

Description

Get test scenario details.


Parameters

TypeNameDescriptionRequiredSchemaDefault

PathParameter

testScenarioIssueId

Issue id of test scenar io.

true

integer (int64)


QueryParameter

expand

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

false

string



Responses

HTTP CodeDescriptionSchema

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

500

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

No Content


Produces

  • application/json


Tags

  • Test Scenario


Get execution summary of given test scenario

GET /testscenario/{testScenarioIssueId}/executionresultsummary

Description

Return count of test scenario executions group by execution result.


Parameters

TypeNameDescriptionRequiredSchemaDefault

PathParameter

testScenarioIssueId

Issue id of test scenario.

true

integer (int64)



Responses

HTTP CodeDescriptionSchema

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

500

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

No Content


Produces

  • application/json


Tags

  • Test Scenario


Get linked test runs

GET /testscenario/{testScenarioIssueId}/linkedTestRun

Description

Get list of test runs by test scenario issue id.


Parameters

TypeNameDescriptionRequiredSchemaDefault

PathParameter

testScenarioIssueId

Issue id of test scenario.

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 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 scenarios to return.Default is 0.

false

integer (int32)

0


Responses

HTTP CodeDescriptionSchema

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

500

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

No Content


Produces

  • application/json


Tags

  • Test Scenario


Get test scenario execution history

GET /testscenario/{testScenarioIssueId}/runs

Description

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


Parameters

TypeNameDescriptionRequiredSchemaDefault

PathParameter

testScenarioIssueId

Issue id of test scenario.

true

integer (int64)


QueryParameter

maxResults

Maximum number of test scenarios 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 scenarios to return.Default is 0.

false

integer (int32)

0


Responses

HTTP CodeDescriptionSchema

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

500

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

No Content


Produces

  • application/json


Tags

  • Test Scenario


Get linked stories

GET /testscenario/{testScenarioIssueId}/story

Description

Get list of story issues by test scenario issue id.


Parameters

TypeNameDescriptionRequiredSchemaDefault

PathParameter

testScenarioIssueId

Issue id of test scenario.

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 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 scenario to return.Default is 0.

false

integer (int32)

0


Responses

HTTP CodeDescriptionSchema

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

500

Returned if there is some problem in retrieval of story issues.

No Content


Produces

  • application/json


Tags

  • Test Scenario

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