report

A report is the result of sending a boot or build report. The actual report sent is not stored here, only information on the report status are.

More info about the report schema can be found here.

Note

This resource can only be accessed with an admin or super user token.

Note

This resource can also be accessed using the plural form reports.

GET

GET /report/(string: id)

Get all the available reports or a single one if id is provided.

Parameters:
  • id (string) – The ID of the report to retrieve.
Request Headers:
 
Response Headers:
 
Query Parameters:
 
  • limit (int) – Number of results to return. Default 0 (all results).
  • skip (int) – Number of results to skip. Default 0 (none).
  • sort (string) – Field to sort the results on. Can be repeated multiple times.
  • sort_order (int) – The sort order of the results: -1 (descending), 1 (ascending). This will be applied only to the first sort parameter passed. Default -1.
  • date_range (int) – Number of days to consider, starting from today (more info). By default consider all results.
  • field (string) – The field that should be returned in the response. Can be repeated multiple times.
  • nfield (string) – The field that should not be returned in the response. Can be repeated multiple times.
  • _id (string) – The internal ID of the report.
  • created_on (string) – The creation date: accepted formats are YYYY-MM-DD and YYYYMMDD.
  • job (string) – A job name.
  • kernel (string) – A kernel name.
  • name (string) – The name of the report.
  • status (string) – The status of the report report.
  • type (string) – The type of the report.
Status Codes:

Example Requests

GET /report/ HTTP/1.1
Host: api.kernelci.org
Accept: */*
Authorization: token
GET /report/?job=next&kernel=next-20140731 HTTP/1.1
Host: api.kernelci.org
Accept: */*
Authorization: token

Example Responses

HTTP/1.1 200 OK
Vary: Accept-Encoding
Date: Mon, 11 Aug 2014 15:12:50 GMT
Content-Type: application/json; charset=UTF-8

{
    "code": 200,
    "count:" 1,
    "limit": 0,
    "result": [
        {
            "status": "SENT",
            "job": "next",
            "kernel": "next-20140731",
        },
    ],
}

Note

Results shown here do not include the full JSON response.

POST

Caution

Not implemented. Will return a status code of 501.

DELETE

Caution

Not implemented. Will return a status code of 501.