/
REST API for Jira Cloud V2

REST API for Jira Cloud V2

Owned by Glib
Feb 21, 2025
3 min read

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 toAssertThat Configuration & Enable for project to generate API access keys.

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

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

 

API Requests

Get scenarios report

Retrieves the scenarios report for a specified project. This report includes all active scenarios.

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

Request Parameters

  • Path Parameter:

    • projectId (String):
      The unique identifier of the project for which the report is to be retrieved.

  • Query Parameters:

    • page (Integer, optional):
      The page number to retrieve. If omitted, a default value 0 is applied.

    • size (Integer, optional):
      The number of records per page. If omitted, a default value 10 is applied.

Response

  • HTTP Status: 200 OK

  • Body: Returns a JSON object

    • Pagination Metadata: e.g., total pages, total elements.

    • Content: A list of active scenario details.

Example Request

GET /rest/api/2/project/12345/report/scenarios?page=0&size=10

Example Response

{ "page": 0, "size": 1, "projectId": 10000, "total": 145, "scenarios": [ { "id": "5ef1cce621e9cacfa49f544dedaed993", "name": "Filter enabled and JQL supplied", "feature": "Order Automated status scenarios filter", "mode": "manual", "steps": "Given autoStatusFilterEnabled == true\nWhen JQL filter is supplied in API request\nAnd scenario is matched by name\nAnd scenario is linked to issue from the JQL filter\nThen test status is updated for this scenario on issue from the JQL filter only\nAnd execution history is updated with latest execution on issue from the JQL filter only", "created_at": "2023-11-30T11:31:07", "updated_at": "2024-02-28T13:26:22", "issues": [ "DEMO-2", "DEMO-134", "DEMO-48", "DEMO-69" ], "tags": [ "test-scenario" ], "stepsCount": 6, "deleted": false, "executions": [ { "id": "e6a4d1f82a7f44b6e1926d70a7c96eb6", "status": "FAILED", "issueKey": "DEMO-2", "comment": "", "steps": "\nGiven autoStatusFilterEnabled == true\nWhen JQL filter is supplied in API request\nAnd scenario is matched by name\nAnd scenario is linked to issue from the JQL filter\nThen test status is updated for this scenario on issue from the JQL filter only\nAnd execution history is updated with latest execution on issue from the JQL filter only", "userId": "557045:5fa25bf4-3b59-46d5-95e3-28e652456", "timestamp": "2024-02-15T19:12:23" } ] } ] }

Get deleted scenarios report

Retrieves the scenarios report for a specified project. This report includes all deleted scenarios.

GET /rest/api/2/project/{projectId}/report/scenarios/deleted

Request Parameters

  • Path Parameter:

    • projectId (String):
      The unique identifier of the project for which the report is to be retrieved.

  • Query Parameters:

    • page (Integer, optional):
      The page number to retrieve. If omitted, a default value 0 is applied.

    • size (Integer, optional):
      The number of records per page. If omitted, a default value 10 is applied.

Response

  • HTTP Status: 200 OK

  • Body: Returns a JSON object

    • Pagination Metadata: e.g., total pages, total elements.

    • Content: A list of deleted scenario details.

Example Request

GET /rest/api/2/project/12345/report/scenarios/deleted?page=0&size=10

Example Response