Zitgist Logo  
upper left corner gradient
List of UMBEL Web Services    Invoke this Web Service    Short Description of this Web Service    Access this Web Service
API and Documentation

Inference Lister Web Service API Documentation






For background, we suggest first reading the about section for this Web Service. Also, you may want to consult this document for an overall discussion of API design and philosophy.

Developers communicate with the Inference Lister Zitgist UMBEL Web service using the HTTP GET method. You may request one of the following mime types: (1) text/xml, (2) application/rdf+xml and (3) application/rdf+n3. The content returned by the Web service will be serialized using the mime type requested and the data returned will depend on the parameters selected.

Web Service Endpoint Information

Here is the information needed to communicate with this Web service's endpoint. Descriptions of the parameters are included below.

Note: if a parameter has a default value, the requester can omit it and the default value will be used. Also, some baseline UMBEL Web services may not offer other values than the default.

HTTP Method:
  • GET

Possible "Accept:" HTTP header field value:
URI:
  • http://umbel.zitgist.com/ws/inference/lister/
    ?source_concept=param1&relation=param2&show_how_many=param3&lang=param3


URI dynamic parameters description:

Note: All parameters have to be URL-encoded
  • param1. The source UMBEL subject concept URI or external class URI
  • param2. One of:
    • " sub_class_of (default)": Get the list of inferred
      sub-classes-of the source subject concept
    • " super_class_of": Get the list of inferred
      super-classes-of the source subject concept
    • " equivalent_class": Get the list of inferred
      equivalent-classes-of the source subject concept
  • param3 (default: "0"). The number of maximum results to
    add to the resultset. "0" means as many results as possible
  • param4. One of:
    • " en (default)": Labels of resultsets in English if available

Example of Returned XML Document

This is an example of the XML document returned by this Web service endpoint for a given URI. This example returns a list of UMBEL subject concepts and external classes that are super class/concept of the umbel:Project subject concept.


Query:
  • http://umbel.zitgist.com/ws/inference/lister/
    ?source_concept=http://umbel.org/umbel/sc/Project&relation=super_class_of
"Accept:" HTTP header field value:
  • text/xml

Result:
  1. <?xml version="1.0" encoding="utf-8"?>
  2. <!DOCTYPE resultset PUBLIC
    "-//Zitgist LLC.//Infer Lister DTD 0.1//EN"
    "http://umbel.zitgist.com/ws/dtd/inference/lister.dtd">
  3. <resultset>
  4.   <subject type="umbel:SubjectConcept"
    uri="http://umbel.org/umbel/sc/Project">
  5.     <relation type="umbel:superClassOf">
  6.       <object type="owl:Class"
    uri="http://purl.org/NET/c4dm/event.owl#Event"/>
  7.     </relation>
  8.     <relation type="umbel:superClassOf">
  9.       <object type="umbel:SubjectConcept"
    uri="http://umbel.org/umbel/sc/Individual"/>
  10.     </relation>
  11.   </subject>
  12. </resultset>
  13.  

DTD of the XML Document

  1. <!DOCTYPE resultset [
  2.  
  3.         <!ELEMENT resultset (subject)+ >
  4.        
  5.         <!ELEMENT subject (predicate)*>
  6.         <!ATTLIST subject type (umbel:SubjectConcept
    | owl:Class) "umbel:SubjectConcept">
  7.         <!ATTLIST subject uri CDATA #IMPLIED>
  8.  
  9.         <!ELEMENT predicate (object)+>
  10.         <!ATTLIST predicate type (rdfs:subClassOf
    | umbel:superClassOf | owl:equivalentClass
    | umbel:isAligned) "rdfs:subClassOf">
  11.  
  12.         <!ELEMENT object EMPTY>
  13.         <!ATTLIST object type (umbel:SubjectConcept
    | umbel:AbstractConcept | owl:Class) "umbel:SubjectConcept">
  14.         <!ATTLIST object uri CDATA #IMPLIED>
  15.  
  16. ]>

Descriptions of the Types of XML Elements

Here are descriptions of the types of XML elements that might be returned from from this Web service. Please read the XML data structure documentation to understand how the data is structured within these XML documents.

  • umbel:SubjectConcept (subject/object). An UMBEL subject concept
    resource returned by the Web service for the requested parameters
  • umbel:AbstractConcept (subject/object). An UMBEL abstract concept
    resource returned by the Web service for the requested parameters
  • owl:Class (subject/object). A class defined in another
    vocabulary than UMBEL
  • owl:equivalentClass (predicate). Link a umbel:SubjectConcept or a
    owl:Class to an equivalent owl:Class
  • rdfs:subClassOf (predicate). Link a umbel:SubjectConcept or a
    owl:Class to a sub-class-of a owl:Class
  • umbel:superClassOf (predicate). Link a umbel:SubjectConcept or a
    owl:Class ot a super-class-of a owl:Class

Example of Returned RDF/XML Document

Here is an example of a RDF/XML document returned by this Web service endpoint for a given URI. This example returns a list of UMBEL subject concepts and external classes that are super class/concept of the umbel:Project subject concept.


Query:
  • http://umbel.zitgist.com/ws/inference/lister/
    ?source_concept=http://umbel.org/umbel/sc/Project&relation=super_class_of
"Accept:" HTTP header field value:
  • application/rdf+xml

Result:
  1. <?xml version="1.0"?>
  2. <rdf:RDF xmlns:umbel="http://umbel.org/umbel#"
    xmlns:owl="http://www.w3.org/2002/07/owl#"
    xmlns:rdfs="http://www.w3.org/2000/01/rdf-schema#"
    xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#">
  3.  
  4.     <rdf:Description rdf:about="http://umbel.org/umbel/sc/Project">
  5.         <umbel:superClassOf
    rdf:resource="http://purl.org/NET/c4dm/event.owl#Event" />
  6.     </rdf:Description>
  7.         <rdf:Description rdf:about="http://umbel.org/umbel/sc/Project">
  8.                 <umbel:superClassOf
    rdf:resource="http://umbel.org/umbel/sc/Individual" />
  9.         </rdf:Description>
  10.  
  11. </rdf:RDF>

Example of Returned RDF/N3 Document

Here is an example of a RDF/N3 document returned by this Web service endpoint for a given URI. This example returns a list of UMBEL subject concepts and external classes that are super class/concept of the umbel:Project subject concept.


Query:
  • http://umbel.zitgist.com/ws/inference/lister/
    ?source_concept=http://umbel.org/umbel/sc/Project&relation=super_class_of
"Accept:" HTTP header field value:
  • application/rdf+n3

Result:
  1. @prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> .
  2. @prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
  3. @prefix owl: <http://www.w3.org/2002/07/owl#> .
  4. @prefix umbel: <http://umbel.org/umbel#> .
  5. <http://umbel.org/umbel/sc/Project> umbel:superClassOf
    <http://purl.org/NET/c4dm/event.owl#Event> .
  6. <http://umbel.org/umbel/sc/Project> umbel:superClassOf
    <http://umbel.org/umbel/sc/Individual> .

HTTP Status Codes

Here are the possible HTTP status (error) codes returned by this Web service endpoint.

  • Code: 200
    • Message: OK
  • Code: 400
    • Message: Bad Request
    • Message description: No subject concept
  • Code: 406
    • Message: Not Acceptable
    • Message description: Unacceptable mime type requested
  • Code: 500
    • Message: Internal Error
 upper right corner gradient