REST API

This is the reference 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/spaces/ABTM/pages/725385217/Enable+AssertThat+Plugin to generate API access keys.

Base cloud URL: https://bdd.assertthat.app

Base server URL: your company Jira URL

Postman collection and environment with example requests is available for download below.

Downloading features

Cloud:

GET /rest/api/1/project/{projectId}/features

Server:

GET /rest/assertthat/latest/project/{projectId}/client/features

Parameters

Name

Required

Type

Description

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

Uploading report

Cloud:

POST/rest/api/1/project/{projectId}/report

Server:

POST/rest/assertthat/latest/project/{projectId}/client/report

Parameters

Name

Required

Type

Description

Name

Required

Type

Description

runName

No

String

The name of the run. Default Test run dd MMM yyyy HH:mm:ss

metadata

No

Json string

Metadata json

runId

Yes

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.

Updating scenario status

Cloud:

PUT /rest/api/1/project/{projectId}/scenario/status

Body:

1 2 3 4 5 { "featureName": "Feature name", "scenarioName": "Scenario Name", "status": "NOT_RUN | PASSED | FAILED | IN_PROGRESS | SKIPPED | PENDING | UNDEFINED" }

Get test runs

Cloud:

GET /rest/api/1/project/{projectId}/report/runs

Server:

GET /rest/assertthat/latest/project/{projectId}/client/report/runs

Parameters

Name

Required

Type

Description

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

Cloud:

POST /rest/api/1/project/{projectId}/feature

Server:

POST /rest/assertthat/latest/project/{projectId}/client/upload

Name

Required

Type

Description

Name

Required

Type

Description

projectKey

Yes

String

Project key (abbreviation)

override

No

boolean

Whether to override feature if exists with same name

form-data: file

Yes

file

Feature file to upload

 

Get scenarios report

Cloud:

GET /rest/api/1/project/{projectId}/scenarios/report

Server:

GET /rest/assertthat/latest/project/{projectId}/client/report/runs

Parameters

Name

Required

Type

Description

Name

Required

Type

Description

length

No

int

Number of records to return. Default is 10

start

No

int

Start index. Default is 0