App/API/Ontology/ontology class

From mx Help Wiki
Revision as of 12:45, 4 March 2011 by Matt (Talk | contribs)

Jump to: navigation, search

Back to ontology API home

Contents

Description

http://base_url/api/ontology/ontology_class/<CLASS_ID>

Defaults to returning HTML. Pass an OBO formatted ID with colon translated to underscore. API returns the possible labels (and associated references), and relationships for the class.

Response (JSON)

CLASS_ID:
 definition: definition
 label: name
 relationships: 
   [
    {  subject: 
         id: CLASS_ID1
         label: name
       predicate: 
         id: ID
         name: name
       object: 
         id: CLASS_ID2
         label: name
    }
    ... 
   ]

Response (HTML)

Redirects to the /public/ontology_class/show-expanded/ID action.

Example (JSON)

Request:

http://api.hymao.org/api/ontology/ontology_class/HAO_0000397.json

Response:

  {
    "http://purl.obolibrary.org/obo/HAO_0000397":
     {
       "label":"head",
       "relationships": [
          {"predicate": {"name":"is_a","id":"http://purl.obolibrary.org/obo/OBO_REL_is_a"},
           "subject":{"id":"http://purl.obolibrary.org/obo/HAO_0000397","label":"head"},
           "object":{"id":"http://purl.obolibrary.org/obo/HAO_0000988","label":"tagma"}
          },
         {"predicate": {"name":"part_of","id":"http://purl.obolibrary.org/obo/OBO_REL_part_of"},
          "subject":{"id":"http://purl.obolibrary.org/obo/HAO_0000397","label":"head"},
          "object":{"id":"http://purl.obolibrary.org/obo/HAO_0000182","label":"body"}}],
          "definition":"The tagma that is located anterior to the thorax."}
  }
Personal tools