A validation corresponds to the validation of a model on a test dataset. The results are stored in another dataset. Parameters with default values are optional.
REST operations
Description
Method
URI
Parameters
Result
Status codes
Get all validations
GET
/
-
List of validation URIs
200,404
Retrieves a validation representation
GET
/{id}
-
Validation representation in one of the supported MIME types
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, format according to accept-header
GET
/report/{report-type}/{id}
-
According to accept-header: text/x-yaml, application/rdf+xml -> report object with meta data (see rdf example below)
text/xml, text/html, application/pdf -> report document in specified format
200,404
Creates a report
POST
/report/{report-type}
various params, see below
Report URI or Task URI
200,400,404,500
Deletes a report.
DELETE
/report/{report-type}/{id}
-
-
200,404
Available (validation-)report types
Create ToxPredict report (multiple models, one compound to predict)
POST
/report/toxpredict
List of validation URIs
Report URI or Task URI
200,400,404,500
Create single validation report (one model, one test dataset)
POST
/report/validation
validation URIs
Report URI or Task URI
200,400,404,500
Create cross-validation report (crossvalidation with one algorithm and one dataset)
POST
/report/crossvalidation
crossvalidation URIs
Report URI or Task URI
200,400,404,500
Create report for comparing different prediction algorithms (crossvalidations/validations with multiple algorithms and datasets)
POST
/report/algorithm_comparison
List of crossvalidation URIs or list of validation URIs
Report URI or Task URI
200,400,404,500
Create report for comparing different models
POST
/report/model_comparison
list of validation URIs
Report URI or Task URI
200,400,404,500
Special report formats
Create QMRF report *)
POST
/report/qmrf
application/x-form-www-urlencoded
model_uri=Model URI
or validation_uri = a List of crossvalidation URIs and/or validation URIs of the same model additional fields of the report that cannot be filled out automatically (yet to be defined)
or application/qmrf-xml (smth lke) for creating a report with predefined QMRF XML content
Report URI or Task URI
200,400,404,500
Update QMRF report
POST
/report/qmrf/{reportid}
same as above
Report URI
200,400,404,500
Delete QMRF report
DELETE
/report/qmrf/{reportid}
deletes the report
Retrieves the report
GET
/report/qmrf/{reportid}
retrieves the report
representation, , format specified by MIME type (XML, RDF, HTML, PDF, XLS, where applicable)
Create QPRF report *)
POST
/report/qprf
application/x-form-www-urlencoded
model_uri = Model URI validation_uri = a List of crossvalidation URIs and/or validation URIs of the same model One of { dataset_uri = Dataset URI compound_uri = compound uri }, specifying the compounds
or application/qprf-format-to-be-defined for creating a report with predefined QPRF content
Report URI or Task URI
200,400,404,500
Replaces QPRF report
POST
/report/qprf/{reportid}
same as above, replaces the content
Report URI
Updates QPRF report
PUT
/report/qprf/{reportid}
same as above, but adds new content to the report
Report URI
Deletes QPRF report
DELETE
/report/qprf/{reportid}
deletes the report
Retrieves the report content
GET
/report/qprf/{reportid}
retrieves the report
representation, , format specified by MIME type (XML, RDF, HTML, PDF, XLS, where applicable)
Report searching facilities
GET
/report/{type}
application/x-form-www-urlencoded any or subset of
model_uri = Model URI dataset_uri = Dataset URI compound_uri = Compound URI algorithm_uri = Algorithm URI endpoint_uri= endpoint URI, as defined by the ontology search=any free text,
etc.
Retrieves list of reports, related to the model, specified by any of the parameter URI
Validation reports are returned in 2 different ways according to the accept-header
Accept header is text/xml, text/html, application/pdf: the actual report document is returned (the core document is an XML format according to the DocBook standard, which allows conversion to the other formats).
Accept header is application/rdf+xml or text/x-yaml: the report object is returned, containing meta-data. Example (in N3) below