Skip to main content

Web Services

UMBEL Web services are supported by the structWSF Web services framework. The latest version of the UMBEL ontology has been indexed by the structWSF instance, and gets exposed to the generic public through these services.

This structWSF-UMBEL instance is made public for testing purposes only. If you want to develop commercial applications around it, you will have to install structWSF and import UMBEL into your own instance since the performances and the up-time of this demo instance is not guaranteed.

All of the tools on this Web site are using one, or multiple, of these structWSF endpoints:

Access Information

Here is the summary information you need to know in order to be able to query the latest version of the UMBEL ontology using the structWSF Web services endpoints. Use this information as your parameter values when accessing the endpoints.

The permissions of the guest users are:

  • Create: False
  • Read: True
  • Update: False
  • Delete: False

These settings mean that only the Web service endpoints that require Read permissions will be accessible to you.

Here is the URI of the dataset where the latest version of the UMBEL reference concepts structure is indexed:

  • Dataset URI: file://localhost/data/ontologies/files/umbel.org/umbel_reference_concepts_v100.n3

All of the endpoints that you may query offer their resultsets in four different formats:

  • text/xml
  • application/json
  • application/rdf+xml
  • application/rdf+n3

When reading the documentation for each of the endpoints, as listed next, do pay special heed to the HTTP method used to query each specific endpoint:

  • POST, or
  • GET

Web Service Endpoints

Here is the list of the UMBEL Web service endpoints you may access. The documentation pages for each service tells you how you to use and query each of these different structWSF endpoints:

Note: the documentation for these resides on the Open Semantic Framework (OSF) TechWiki. Also note that not all structWSF services and endpoints are supported on this UMBEL site.

Query Examples

Here are some example of queries you can send to these different endpoints. These examples are using the cURL command line application to send the queries to the web service endpoints.

Ontology Read: Get the first 10 classes URI of the ontology

curl -H "Accept: application/rdf+xml" http://umbel.org/ws/ontology/read/ -d "ontology=file://localhost/data/ontologies/files/umbel.org/umbel_reference_concepts_v100.n3&function=getClasses&parameters=mode%3Duris;limit%3D10;offset%3D0"

Ontology Read: Get the direct sub-classes-of descriptions of umbel:ReligiousPerson

curl -H "Accept: application/rdf+xml" http://umbel.org/ws/ontology/read/ -d "ontology=filest/data/ontologies/files/umbel.org/umbel_reference_concepts_v100.n3&function=getSubClasses&parameters=uri%3Dhttp%3A%2F%2Fumbel.org%2Fumbel%2Frc%2FReligiousPerson;mode%3Ddescriptions;direct%3Dtrue"

Search: search for the word "person"

curl -H "Accept: application/rdf+xml" http://umbel.org/ws/search/ -d "datasets=file://loca/ontologies/files/umbel.org/umbel_reference_concepts_v100.n3&query=person"