Sections
You are here: Home » Development » API » API 1.0 - archived version » Report

Report

Report

Component description

A report visualizes the (prediction) results of algorithms.

REST operations

Description Method URI Parameters Result Status codes
Get all report types
GET /report - List of available report types
200,404
Get all reports for the particular report type
GET /report/{report-type} - List of available reports as URI
200,404
Retrieves a report in XML / PDF / HTML / RTF format GET /report/{report-type}/{id} - Report in specified format
200,404
Creates a report
POST /report/{report-type} various params, see below
Report URI
200,202,400,404,500
Deletes a report. DELETE /report/{report-type}/{id} - -
200,404
Available report types





Create Fasttox report
(multiple models, one compound to predict)
POST
/report/fasttox list of validation_uris
Report URI 200,202,400,404,500
Create single validation report
(one model, one test dataset)
POST
/report/validation validation_uri
Report URI 200,202,400,404,500
Create cross-validation report
(crossvalidation with one algorithm and one dataset)
POST
/report/crossvalidation crossvalidation_uri
Report URI 200,202,400,404,500
Create report for comparing different prediction algorithms
(crossvalidations/validations with multiple algorithms and datasets)
POST
/report/algorithm_comparison list of crossvalidation_uri
or list of validation_uris
Report URI 200,202,400,404,500

Output (file) format

XML format according to the DocBook standard (allows conversion to the other formats).

HTTP status codes

Interpretation Nr Name
Success 200 OK
Report type / report not found 404 Not Found
Illegal params 400 Bad request
Error creating the report
500 Internal Server Error
Report creation running 202 Accepted

 

Document Actions