Skip to content
Shahim Essaid edited this page Feb 2, 2015 · 2 revisions

Running Web Services

Introduction

Starting a server

owltools go.obo --start-server -p 9031

Now connect to http://localhost:9031/

Remember, order of arguments matters on the command line: start the server after loading the ontology (everything after the server arguments are ignored). See Command Line Examples for more details.

you can specify a default reasoner:

owltools go.obo --reasoner hermit --start-server -p 9031

Ontology Services

You can obtain a list of supported commands by accessing http://localhost:9031/help/

E.g.

  • allSubClassOf
  • getSuperClasses
  • about
  • ...

Formats

Formats can be optionally specified after the period ("."). E.g.

  • allSubClassOf.owl
  • allSubClassOf.obo
  • allSubClassOf.owx
  • allSubClassOf.plain
  • allSubClassOf.txt (default)

Reasoner Services

Some services require use of a reasoner. The structural reasoner is selected as a default, unless this is overridden at startup time. The reasoner can be controlled via the "reasoner" parameter. The usual list of owltools reasoners are available:

  • elk
  • jcel
  • hermit
  • pellet
  • factpp

Examples

reasoner subclasses

= by ID =

or

(OBO assumed)

= class expression (with labels) =

All parts of the head

All reasoner SubClass axioms for whole ontology

If the server was started with caro.obo, we get:

Prefix(xsd:=<http://www.w3.org/2001/XMLSchema#>)
Prefix(owl:=<http://www.w3.org/2002/07/owl#>)
Prefix(xml:=<http://www.w3.org/XML/1998/namespace>)
Prefix(rdf:=<http://www.w3.org/1999/02/22-rdf-syntax-ns#>)
Prefix(rdfs:=<http://www.w3.org/2000/01/rdf-schema#>)


Ontology(
SubClassOf(<http://purl.obolibrary.org/obo/CARO_0000000> owl:Thing)
SubClassOf(<http://purl.obolibrary.org/obo/CARO_0000003> <http://purl.obolibrary.org/obo/CARO_0000006>)
SubClassOf(<http://purl.obolibrary.org/obo/CARO_0000004> <http://purl.obolibrary.org/obo/CARO_0000006>)
SubClassOf(<http://purl.obolibrary.org/obo/CARO_0000005> <http://purl.obolibrary.org/obo/CARO_0000007>)
...

Parameters:

Use in GO

JSON output

Use ".json" or format=json to get back results in json

For calls that return lists of objects, the results will be a json list or IRIs. E.g.

http://localhost:9031/getSubClasses.json?expression=%27part+of%27+some+%27head%27

Returns

[IRI2, ...](IRI1,)

In future there may be an option for returning obo-style IDs, or a prefix mechanism to avoid repetition in the payload.

For calls that return OWLAxioms, the results will be a json-ified OWL functional syntax. E.g.

http://localhost:9031/allSubClassOf.json

Returns JSON where each axiom is represented as a dictionary, with two keys "type" (ie axiom type) and arguments (analagous to the arguments in functional syntax). Class expressions follow the same pattern.

If the W3C decides on a standard JSON for OWL we may adapt to this.

Specific commands may return other json formats according to what is being returned

API Docs