ViewSet for BuildImage RTT Tests.

Documents & examples

Method: GET

URL: /rest_api/v1/build-image-rtt-tests/

Query params:

  • build_nvr (string)
  • image_format (string)
  • test_result (string)
  • ordering (string) Comma separated list of fields for ordering results.
    • To sort by a field in descending order, prefix its name with minus (e.g. -name).
    • Use double underscores for nested field names (e.g. parent__child for {"parent": {"child": ...}}).

Following filters can be used to show only specific fields. This can make response time faster. Format is list or single value (JSON: {"fields": ["a","b"]} or {"fields": "a"}, in URL: ?fields=a&fields=b).

  • fields (list | string) Fields to display (other fields will be hidden).
  • exclude_fields: (list | string) Fields NOT to display (overrules fields).

Response:

# paged list
{
  "count": int,
  "next": url,
  "previous": url,
  "results": [
    {
        "build_nvr":    string,
        "format":       string,
        "id":           int,
        "test_result":  string
    },
    ...
  ]
}

Method: GET

URL: /rest_api/v1/build-image-rtt-tests/{build_nvr}/{image_format}/

Response:

{
    "build_nvr":    string,
    "format":       string,
    "id":           int,
    "test_result":  string
}

Only test_result fields can be modified by this call. Trying to change anything else will result in 400 BAD REQUEST response.

Method: PATCH

URL: /rest_api/v1/build-image-rtt-tests/{build_nvr}/{image_format}/

Data:

{
    "test_result": string
}

Response:

{
    "build_nvr":    string,
    "format":       string,
    "id":           int,
    "test_result":  string
}

It is possible to perform bulk partial update on 'test_result' with PATCH method. The request body should contain an object, where keys are identifiers of objects to be modified and their values use the same format as normal patch.

Browsable GET

GET /rest_api/v1/build-image-rtt-tests/
HTTP 200 OK
Allow: GET, PUT, PATCH, HEAD, OPTIONS
Content-Type: application/json
Vary: Accept

{
    "count": 0,
    "next": null,
    "previous": null,
    "results": []
}