REST API for Jira Server and Data Center

Authentication

Basic authentication

Use credentials of a user (preferably dedicated for API usage with limited access to current project) which has access to project you are interacting with.

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

 

API token authentication

Bearer authentication (also called token authentication) is an HTTP authentication scheme that involves security tokens called bearer tokens.

Follow the steps described here to generate API token https://confluence.atlassian.com/enterprise/using-personal-access-tokens-1026032365.html. Once generated the token should be passed in a header in the format of Authorization: Bearer <token>

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

Base server URL

The base URL is your company Jira instance URL e.g. https://jira.mycompany.com

Project ID

Refer to https://assertthat.atlassian.net/wiki/spaces/ABTM/pages/2328264705 to get projectId for the request path parameter.

Downloading features

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

tags

No

String

Tag expression to filter features/ scenarios

Uploading report

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

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 Jira issues with test results

Get test runs

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

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

Parameters

Name

Required

Type

Description

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/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

Get scenarios executions

GET /rest/assertthat/latest/project/{projectId}/client/scenarios/report/executions

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