Module Report (v1)#

REST Requests:#

GET /api/v1/report/reports
DELETE /api/v1/report/reports/(name)
GET (url)

Websockets:#

Websocket endpoint: GET /api/v1/report/notifications

Websocket Events:

report_created
report_removed

Module Report REST API (v1)#

GET /api/v1/report/reports#

get report list

Status Codes:

200 OK – the report list – JSON Schema: array(report)
500 Internal Server Error – if there is a server internal error

Example:

Get the report list

GET /api/v1/report/reports

[
  {
    "name": "report_004.tar.gz",
    "date": "19700103T182145+0100",
    "url": "/data/report/report_004.tar.gz"
  },
  {
    "name": "report_005.tar.gz",
    "date": "19700103T182145+0100",
    "url": "/data/report/report_005.tar.gz"
  }
]

DELETE /api/v1/report/reports/(name)#

delete a report (both regular and anonymous)

Parameters:

name (string) – the name of the report

Status Codes:

200 OK – no error
404 Not Found – if the requested report does not exist
500 Internal Server Error – if there is a server internal error

GET (url)#

download a report (regular or anonymous)

Parameters:

url (string) – the relative url of the report (as returned in the report list)

Query Parameters:

anonymous – select which version of the report (regular or anonymous) to download

Status Codes:

200 OK – content of the report (in response body) – JSON Schema: array(byte)
404 Not Found – if the requested report does not exist
500 Internal Server Error – if there is a server internal error

Module Report Websocket events (v1)#

Endpoint:

GET /api/v1/report/notifications#

Request Headers:

Connection – Upgrade
Upgrade – websocket

Events:

report_created

report_removed

Module Report JSON Schema (v1)#

report_created#

type	object
properties
name	string
data	report_created_event_data

report_removed#

type	object
properties
name	string
data	report_removed_event_data

anonymous#

type	string
oneOf	the anonymous version of the report
	const	yes
	the regular version of the report
	const	no

report#

type	object
properties
name	string
date	string
url	string

report_created_event_data#

type	object
properties
report	report

report_removed_event_data#

type	object
properties
report	report