reports
GET /api/reports
Summary: List available generated reports
Parameters
| In | Name | Type | Required | Description |
|---|---|---|---|---|
| query | ordering |
string | no | Which field to use when ordering the results. |
| query | page |
integer | no | A page number within the paginated result set. |
| query | page_size |
integer | no | Number of results to return per page. |
Responses
-
200 —
-
Media type:
application/json
Type: PaginatedShortReportList
DELETE /api/reports/{id}
Summary: Remove generated report
Parameters
| In | Name | Type | Required | Description |
|---|---|---|---|---|
| path | id |
integer | yes | A unique integer value identifying this report. |
Responses
- 204 — No response body
GET /api/reports/{id}
Summary: Get metadata for given report
Parameters
| In | Name | Type | Required | Description |
|---|---|---|---|---|
| path | id |
integer | yes | A unique integer value identifying this report. |
Responses
-
200 —
-
Media type:
application/json
Type: ShortReport
GET /api/reports/{id}/file
Summary: Retrieve report contents as file
Parameters
| In | Name | Type | Required | Description |
|---|---|---|---|---|
| path | id |
integer | yes | A unique integer value identifying this report. |
| query | saveas |
string | no | destination name of file to save |
Responses
-
200 —
-
Media type:
application/json
Type: ShortReport