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

post Create a quick test

A POST to /sprint-req-versions/{id}/quick-tests creates a new quick test attached to the sprint requirement version.

Path parameters

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

id

the id of the sprint requirement version

Request fields

Path Type Description

name

String

the name of the quick test (optional, defaults to a date-based generated name)

description

String

the description of the quick test (optional)

status

String

the execution status of the quick test (optional, defaults to READY)

HTTP request

POST /api/rest/latest/sprint-req-versions/456/quick-tests HTTP/1.1
Content-Type: application/json
Accept: application/json
Content-Length: 85
Host: localhost:8080

{
  "name" : "my quick test",
  "description" : "<p>desc</p>",
  "status" : "READY"
}

HTTP response

HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 1363

{
  "_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" : "<p>desc</p>",
  "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" : [ ]
}

The response format is the same as Get quick test.

patch Modify a quick test

A PATCH to /quick-tests/{id} modifies 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

Request fields

Path Type Description

name

String

the name of the quick test (optional)

description

String

the description of the quick test (optional)

status

String

the execution status of the quick test (optional)

HTTP request

PATCH /api/rest/latest/quick-tests/321 HTTP/1.1
Content-Type: application/json
Accept: application/json
Content-Length: 98
Host: localhost:8080

{
  "name" : "my patched quick test",
  "description" : "<p>patched</p>",
  "status" : "SUCCESS"
}

HTTP response

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

{
  "_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 patched quick test",
  "execution_status" : "SUCCESS",
  "description" : "<p>patched</p>",
  "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" : [ ]
}

The response format is the same as Get quick test.

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

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

id

the id of the quick test

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

Path Type Description

_embedded.issues

Array

the issues of this quick test

_embedded.issues[].remoteIssueId

String

the remote issue id of the issue linked to the quick test

_embedded.issues[].url

String

the url of the issue linked to the quick test

page.size

Number

the page size for that query

page.totalElements

Number

total number of elements the user is allowed to read

page.totalPages

Number

how many pages can be browsed

page.number

Number

the page number

_links

Object

related links

Links

Relation Description

first

link to the first page (optional)

prev

link to the previous page (optional)

self

link to this page

next

link to the next page (optional)

last

link to the last page (optional)