ORR API Documentation

The API documentation is described in detail for each ORR instance according to the version of the ORR Ont software being used. Besides containing the documentation itself, the API Documentation pages referenced below also allow users to directly exercise the API against the corresponding ORR REST endpoint.

ORR Instance API Documentation Portal Page
MMI ORR https://mmisw.org/ontapi/ https://mmisw.org/ont
XDOMES ORR https://xdomes.org/ontapi/ https://xdomes.org/ont
ESIP COR http://cor.esipfed.org/ontapi/ http://cor.esipfed.org/ont
SensorML ORR http://sensorml.com/ontapi/ http://sensorml.com/ont

In each case you can use the "Authorize" button at the top of the API Documentation page to login with your corresponding credentials. Once authorized, you will be able to not only perform the basic GET operations, but also see expanded responses according to your access privileges as well as perform other operations.

In each API operation description, you are able to set the variables in the descriptions of the API interface, so that you can execute the API call, as well as see it appropriately formatted for an invocation with the curl command line tool.

Format Parameter

Note: this section added while API spec pages above are updated with more details.

Various API operations accept a format parameter to indicate the relevant serialization format: either the desired one for GET requests, or that of the submitted ontology payload in POST requests.

The recognized values for the format parameter are:

format Name Reference
jsonld JSON-LD https://www.w3.org/TR/json-ld/
rdf RDF/XML https://www.w3.org/TR/REC-rdf-syntax/
n3 Notation3 https://www.w3.org/TeamSubmission/n3/
nt N-TRIPLE https://www.w3.org/TR/n-triples/
ttl TURTLE https://www.w3.org/TeamSubmission/turtle/
owx OWL/XML https://www.w3.org/TR/owl-xml-serialization/