This is the reference documentation for the AssertThat - BDD & Cucumber for Jira REST API. This API is the primary way to get and modify data in the plugin, whether you are developing an app or any other integration. Use it to interact with the plugin for entities, such as features, reports, scenarios and more.
Authentication: All endpoints use basic auth. Refer to https://assertthat.atlassian.net/wiki/pages/createpage.action?spaceKey=ABTM&title=Enable%20%26%20configure%20AssertThat%20Plugin&linkCreation=true&fromPageId=766738433 Enable & configure AssertThat Plugin to generate API access keys.
...
API Requests
Table of Contents |
---|
Downloading features
GET /rest/api/1/project/{projectId}/features
...
Name | Required | Type | Description |
---|---|---|---|
mode | No | String | One of: automated, manual, both |
jql | No | String | JQL filter for scenarios linked to certain issues |
numbered | No | Boolean | Whether to prepend ordinal to the feature name |
tags | No | String | Tag expression to filter features/ scenarios |
Uploading report
POST/rest/api/1/project/{projectId}/report
...
Name | Required | Type | Description |
---|---|---|---|
runName | No | String | The name of the run. Default |
metadata | No | Json string | Metadata json |
runId | No | Long | If submitting new report set to -1. If adding test results to existing should be set to the value return when submitting new report. |
form-data: file | Yes | Json file | Cucumber json report file |
type | No | String | One of: cucumber, karate. Defaults to cucumber. |
customRunId | No | String | Overrides runId |
jql | No | String | JQL filter for updating status of scenarios linked to certain issues |
Updating scenario status
PUT /rest/api/1/project/{projectId}/scenario/status
...
Code Block |
---|
{ "featureName": "Feature name", "scenarioName": "Scenario Name", "issueKey": "XXX-123", "comment": "comment", "status": "NOT_RUN | PASSED | FAILED | IN_PROGRESS" } |
Get test runs
GET /rest/api/1/project/{projectId}/report/runs
...
Name | Required | Type | Description |
---|---|---|---|
length | No | int | Number of records to return. Default is 10 |
start | No | int | Start index. Default is 0 |
Upload feature
POST /rest/api/1/project/{projectId}/feature
Name | Required | Type | Description |
---|---|---|---|
override | No | boolean | Whether to override feature if exists with same name |
form-data: file | Yes | file | Feature file to upload |
Get scenarios report
GET /rest/api/1/project/{projectId}/scenarios/report
...
Name | Required | Type | Description |
---|---|---|---|
length | No | int | Number of records to return. Default is 10 |
start | No | int | Start index. Default is 0 |
Upload scenario executions
POST /rest/api/1/project/{projectId}/scenarios/execution
...