Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Authentication: All endpoints use basic auth. Refer to Enable & configure AssertThat Plugin to generate API access keys.

...

View file
nameassertthat-bdd-server.postman_collection.json
View file
nameassertthat-bdd-server.postman_collection.json
View file
nameassertthat-bdd.postman_environment.json

...

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

Parameters

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

...

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

Parameters

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:

...

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

Parameters

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

...

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

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/assertthat/latest/project/{projectId}/client/report/runs

Parameters

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

Server:

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

Parameters

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

...