Back to QMetry All Products Help Page
Story
Get test cases/scenarios linked with story
GET /story
Description
Get list of test cases/scenarios linked with given story.
Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | storyIssueId | Issue id of story. | 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 case/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) | 10 |
QueryParameter | offset | Index of the first test case/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 external issue id or expand is invalid. | No Content |
403 | Returned if the currently authenticated user does not have permission to access given story. | No Content |
404 | Returned if the given story is not found. | No Content |
500 | Returned if there is some problem in retrieval of test cases/scenarios. | No Content |
Produces
application/json
Tags
Story, Epic, Bug, Any other JIRA issue types.
Link test cases/scenarios in bulk with story
PUT /story/link
Description
Link given test case/scenarios in bulk with story.
Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | storyIssueId | Issue id of story | true | integer (int32) | |
BodyParameter | body | Details related to the test case/scenarios to be associated | true |
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 test case/scenarios to story. | No Content |
404 | Returned if the given story issue id is not found. | No Content |
500 | Returned if there is some problem in linking bulk of test case/scenario with story. | No Content |
Consumes
application/json
Produces
application/json
Tags
Story, Epic, Bug, Any other JIRA issue types.
Get test cases/scenarios which are not linked with any story so far
GET /story/unlinked
Description
Get list of test cases/scenarios which are not linked with any of story.
Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | projectId | Project id. | true | integer (int64) | |
QueryParameter | expand | Comma-separated list of entities that you want expanded.Possible values are testcase,teststep,metadata. | false | string | |
QueryParameter | maxResults | Maximum number of test case/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 case/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 project id or expand is invalid. | No Content |
403 | Returned if the currently authenticated user does not have permission to access given project. | No Content |
404 | Returned if the given project is not found. | No Content |
500 | Returned if there is some problem in fetching unlinked test cases/scenarios from given project. | No Content |
Produces
application/json
Tags
Story, Epic, Bug, Any other JIRA issue types.
Move test case/scenario with in story
PUT /story/{issueId}/move
Description
Move test case/scenario to given position in story.
Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | storyIssueId | Issue id of story. | true | integer (int64) | |
QueryParameter | oldPos | The old position of test case/scenario. | true | integer (int32) | |
QueryParameter | newPos | The new position of test case/scenario. | true | integer (int32) | |
PathParameter | issueId | The id of test case/scenario 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 story. | No Content |
404 | Returned if the required params are not provided. | No Content |
500 | Returned if there is some problem in moving test case/scenario. | No Content |
Produces
application/json
Tags
Story, Epic, Bug, Any other JIRA issue types.
Un-link test case/scenario
DELETE /story/{issueId}/unlink
Description
Un-link test case/scenario from given story.
Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
PathParameter | issueId | Issue id of test case/scenario. | true | integer (int64) | |
QueryParameter | storyIssueId | Issue id of story. | true | integer (int64) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 | Successful operation. | No Content |
400 | Returned if the given story issue id is invalid. | No Content |
403 | Returned if the currently authenticated user does not have permission to unlink given test case/scenario. | No Content |
404 | Returned if the given story issue id is not found. | No Content |
500 | Returned if there is some problem in unlinking test case/scenario. | No Content |
Produces
application/json
Tags
Story, Epic, Bug, Any other JIRA issue types.
Get story execution result for given run
GET /story/{storyIssueId}/executionresults
Description
Get story(s) execution result for given run along with platform, executed by and associated defects.
Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
PathParameter | storyIssueId | Issue id of story. | true | integer (int64) | |
QueryParameter | testRunIssueId | Issue id of test run. | true | integer (int64) | |
QueryParameter | maxResults | Maximum number of execution result 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 execution result to return.Default is 0. | false | integer (int32) | 0 |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 | Successful operation. | No Content |
400 | Returned if the given story issue id is invalid. | No Content |
403 | Returned if the currently authenticated user does not have permission to access given story. | No Content |
500 | Returned if there is some problem in retrieval of story issue. | No Content |
Produces
application/json
Tags
Story, Epic, Bug, Any other JIRA issue types.
Get story execution history
GET /story/{storyIssueId}/runs
Description
Get story(s) execution history along with platform, execution result, executed by.
Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
PathParameter | storyIssueId | Issue id of story. | true | integer (int64) | |
QueryParameter | maxResults | Maximum number of story history 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 story history to return.Default is 0. | false | integer (int32) | 0 |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 | Successful operation. | No Content |
400 | Returned if the given story issue id is invalid. | No Content |
403 | Returned if the currently authenticated user does not have permission to access given story. | No Content |
500 | Returned if there is some problem in retrieval of story issue. | No Content |
Produces
application/json
Tags
Story, Epic, Bug, Any other JIRA issue types.
Link test case/scenario with story
PUT /story/{testCaseIssueId}/link
Description
Link given test case/scenario with story.(We use term Story for all the issue types)
Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
PathParameter | testCaseIssueId | Issue id of test case/scenario. | true | integer (int64) | |
QueryParameter | storyIssueId | Issue id of story. | true | integer (int64) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 | Successful operation. | No Content |
400 | Returned if the given story issue id / test case/scenario/scenario issue id is invalid. | No Content |
403 | Returned if the currently authenticated user does not have permission to link test case/scenario with story. | No Content |
404 | Returned if the given story issue id is not found. | No Content |
500 | Returned if there is some problem in linking test case/scenario with story. | No Content |
Produces
application/json
Tags
Story, Epic, Bug, Any other JIRA issue types.
TestCaseTestScenarioIssueIdRequest
Name | Description | Required | Schema | Default |
---|---|---|---|---|
issueIds | Array of issue ids. | true | integer (int64) array | |
jql | false | string |
Back to QMetry All Products Help Page