Difference between revisions of "App/API/Ontology/ontology class"

Latest revision as of 22:43, 4 March 2011

Back to ontology API home

[edit] 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.

[edit] 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
    }
    ... 
   ]

[edit] Response (HTML)

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

[edit] Example (JSON)

Request:

http://api.hymao.org/api/ontology/ontology_class/http%3A%2F%2Fpurl%2Eobolibrary%2Eorg%2Fobo%2FHAO_0000397.json preferred, note the escape periods as well

or

http://api.hymao.org/api/ontology/ontology_class/HAO_0000397.json short form, experimental

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."
     }
  }