¶ Ontology Lookup Service (OLS)
The Ontology Lookup Service (OLS), or ontologies server, aims to centralize and maintain a list of validated ontologies used to manipulate avatars in Things. From a Thing'in instance named TiPod (Thing'in POD), the developers can select a set of ontologies present in OLS and add them to the TiPod to create, search, update, or delete their own avatars.
That is, using a REST and/or GraphQL APIs, developers can download ontologies registered in the system and search among those ontologies, concepts to better describe semantically their data.
Kindly keep in mind that not all the ontologies of the world are registered in OLS. Developers can use the REST APIs to import new ontologies in the system. To ensure a certain level of integrity and/or quality we have a validation process on new ontologies before they can be retrieved and used to manipulate avatars.
The procedure below describes how to use the different APIs to retrieve an ontology from the central OLS server and add it to the Tipod.
¶ Accessing the central ontologies server via the API
OLS provides a swagger documentation describing the REST and GraphQL API.
¶ Use the REST API to list the ontologies and get their checksums
-
GET /ontologies (get all the ontologies's checksums by specifying checksum in the includeFields)
pick the ontologies's checksums to add in the TiPoD and go on as described below
¶ Use the Tipod's API to retrieve the ontologies by their checksums
- POST /ontologies (add new ontologies (from their checksum) to the TiPod
