-
Notifications
You must be signed in to change notification settings - Fork 2
RO checklist evaluation API
The checklist evaluation API is intended to provide access to the minim-based evaluation of Research Objects, used to test for completeness, executability, repeatability and other desired features. The functionality provided is based on the ro-manager evaluate checklist option:
ro evaluate checklist [ -d <dir> ] [ -a | -l <level> ] <minim> <purpose> [ <target> ]
where:
-
<dir>is the directory containing the RO to be evaluated -
<level>indicates the level of information detail to be returned -
<minim>is a URI reference for a minimum information model resource from which the checklist definition is obtained -
<target>is a target resource with respect to which the evaluation is performed; the default<target>is the RO itself, but a component within the RO may be selected. -
<purpose>is a keyword indicating the purpose for which the RO or<target>is to be evaluated.
ro evaluate checklist -d /workspace/myro -l all /workspace/minim.rdf "creation" myro/wfoutput.dat
might evaluate the RO at /workspace/myro using the minim model in file /workspace/minim.rdf.
The Web API is intended to provide remote access to the above functionality using simple HTTP requests.
Research Objects and other data are provided as web resources, and indicated in the API using their URIs.
Suppose we have:
- A checklist evaluation service accessible at http://service.example.org/evaluate/checklist
- An RO with URI http://sandbox.example.org/ROs/myro>
The checklist evaluation would then be invoked in a sequence of two HTTP operations:
- Client retrieves service document:
C: GET /evaluate/checklist HTTP/1.1 C: Host: service.example.org C: Accept: application/rdf+xml S: HTTP/1.1 200 OK S: Content-Type: application/rdf+xml S: S: <?xml version="1.0"?> S: <rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" S: xmlns:roe="http://purl.org/ro/service/evaluate/"> S: <rdf:Description rdf:about=""> S: <roe:checklist>/evaluate/checklist{?RO,minim,target,purpose}</roe:checklist> S: </rdf:Description> S: </rdf:RDF>
- Client parses the service document, extracts the URI template for the checklist evaluation service and assembles URI for the desired evaluation result (cf. RFC6570), and issues a second HTTP GET request:
The result from the second request is the checklist evaluation result. The URI shown above has been split over several lines for readability - the actual HTTP request must present it without whitespace. The optional target URI parameter has been omitted in this example on the assumption that the target is the Research Object itself.C: GET /evaluate/checklist?RO=http%3A%2F%2Fsandbox.example.org%2FROs%2Fmyro &minim=http%3A%2F%2Fanother.example.com%2Fminim%2Frepeatable.rdf &purpose=repeatable HTTP/1.1 C: Host: service.example.org C: Accept: application/rdf+xml S: HTTP/1.1 200 OK S: Content-Type: application/rdf+xml S: S: <?xml version="1.0"?> S: <rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" S: xmlns:...="..." S: > S: <rdf:Description rdf:about="..."> S: (Result of checklist evaluation) S: </rdf:Description> S: </rdf:RDF>
See also:
- http://tools.ietf.org/html/rfc2616
- http://tools.ietf.org/html/rfc3986
- http://tools.ietf.org/html/rfc6570
- https://github.com/wf4ever/ro-manager/blob/master/src/iaeval/Minim/minim.rdf
This relation is generally used used in the service description document
It indicates a relation between a service description and a URI template for RO evaluation results using the described service. The URI template is is used to construct a service result URI by:
- applying the URI template expansion procedures with caller-supplied RO URI, minim URI, purpose and target URIs, and
- resolving the resulting URI-reference to an absolute URI using normal URI resolution rules (e.g. typically, using the service document URI as a base URI)