Quick Tests

This chapter focuses on services for the quick tests.

get Get quick test

A GET to /quick-tests/{id} returns the quick test with the given id.

Path parameters

Table 1. /api/rest/latest/quick-tests/{id}
Parameter Description

id

the id of the quick test

HTTP request

GET /api/rest/latest/quick-tests/321 HTTP/1.1
Accept: application/json
Host: localhost:8080

Query parameters

Parameter Description

fields

which fields of the elements should be returned (optional)

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1384

{
  "_links" : {
    "self" : {
      "href" : "http://localhost:8080/api/rest/latest/quick-tests/321"
    },
    "sprint-req-version" : {
      "href" : "http://localhost:8080/api/rest/latest/sprint-req-versions/456"
    },
    "issues" : {
      "href" : "http://localhost:8080/api/rest/latest/quick-tests/321/issues"
    }
  },
  "_type" : "quick-test",
  "id" : 321,
  "name" : "my quick test",
  "execution_status" : "READY",
  "description" : "description as a rich text field",
  "created_by" : "admin",
  "created_on" : "2024-10-01T10:00:00.000Z",
  "last_modified_by" : "another user",
  "last_modified_on" : "2025-05-12T10:00:00.000Z",
  "sprint_req_version" : {
    "_links" : {
      "self" : {
        "href" : "http://localhost:8080/api/rest/latest/sprint-req-versions/456"
      }
    },
    "_type" : "sprint-req-version",
    "id" : 456,
    "requirement_version" : {
      "_links" : {
        "self" : {
          "href" : "http://localhost:8080/api/rest/latest/requirement-versions/789"
        }
      },
      "_type" : "requirement-version",
      "id" : 789,
      "name" : "requirement version name"
    },
    "sprint" : {
      "_links" : {
        "self" : {
          "href" : "http://localhost:8080/api/rest/latest/sprints/123"
        }
      },
      "_type" : "sprint",
      "id" : 123,
      "name" : "sprint name"
    }
  },
  "attachments" : [ ]
}

Response fields

Path Type Description

_type

String

the type of this entity

id

Number

the id of the quick test

name

String

the name of the quick test

description

String

the description of the quick test

execution_status

String

the execution status of the quick test

created_by

String

the user who created this quick test

created_on

String

the date the quick test was created

last_modified_by

String

the user who last modified the quick test

last_modified_on

String

the date the quick test was last modified

sprint_req_version

Object

the sprint requirement version to which this quick test is linked

attachments

Array

the attachments of this execution

_links

Object

related links

Links

Relation Description

self

link to this quick test

sprint-req-version

link to the sprint requirement version

issues

link to the issues of this quick test

delete Delete quick test

A DELETE to /quick-tests/{ids} deletes one or several quick test with the given id(s).

Path parameters

Table 1. /api/rest/latest/quick-tests/{id}
Parameter Description

id

the list of ids of the quick tests

HTTP request

DELETE /api/rest/latest/quick-tests/44 HTTP/1.1
Content-Type: application/json
Accept: application/json
Host: localhost:8080

HTTP response

HTTP/1.1 204 No Content

get Get issues of a quick test

A GET to /quick-tests/{id}/issues returns all the issues of the quick test with the given id declared using the bugtracker currently linked to the project.

Path parameters

Snippet path-parameters not found for operation::RestQuickTestControllerIT/get-quick-test-issues

HTTP request

GET /api/rest/latest/quick-tests/321/issues HTTP/1.1
Accept: application/json
Host: localhost:8080

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 395

{
  "_embedded" : {
    "issues" : [ {
      "remoteIssueId" : "981351896",
      "url" : "https://gitlab.com/sample-group/sample-project/issues/15"
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "http://localhost:8080/api/rest/latest/quick-tests/321/issues?page=0&size=20"
    }
  },
  "page" : {
    "number" : 0,
    "size" : 20,
    "totalElements" : 1,
    "totalPages" : 1
  }
}

Response fields

Snippet response-fields not found for operation::RestQuickTestControllerIT/get-quick-test-issues

Links

Snippet links not found for operation::RestQuickTestControllerIT/get-quick-test-issues