[OTDev] Algorithm/Model/Task related API documentation

Nina Jeliazkova jeliazkova.nina at gmail.com
Sat Oct 30 09:53:02 CEST 2010


Hello All,

We have found somewhat inconsistent documentation, regarding the usage of
tasks.  The API wiki says it is either the URL of the result returned, or
the task URL.

In practice, if the (default) "Accept:application/rdf+xml" header is
requested, a task URL is always returned and the task contains information
if it is completed or not, and if it is completed, then the RDF
representation of the task contains the URI of result.

However, if the "Accept:text/uri-list" is requested instead of the default
RDF, the URL returned by completion will be the one of the result itself
(e.g. URL of a dataset with predicted results).

Should we change anything, or just try to make the documentation clear?
Perhaps make explicit what is being returned if different "Accept:" headers
are used?
Are there implementations that handles these cases differently?

1)Algorithm  http://opentox.org/dev/apis/api-1.1/Algorithm
Result: *model URI ,dataset URI,featureURI* , Redirect to task URI for time
consuming computations

Note: Redirect was removed from the API but apparently this page was not
updated, there is still reference to 303 status codes.

2)Model  http://opentox.org/dev/apis/api-1.1/Model
Result: URI of created prediction dataset (predictions are features), task
URI for time consuming computations

Best regards,
Nina



More information about the Development mailing list