Difference between revisions of "BioPortal REST services"

From NCBO Wiki
Jump to navigation Jump to search
(New page: This page documents the signatures for NCBO (and, more specifically, BioPortal) REST services. This list may not be exhaustive. '''Note''': ''Signatures for BioPoral services will change ...)
 
Line 6: Line 6:
 
  http://rest.bioontology.org/bioportal/rest
 
  http://rest.bioontology.org/bioportal/rest
  
{| border="1"
+
== List all ontologies ==
|-
+
 
! Functionality
+
* '''Signature''': ./ontologies
! Service signature
+
* '''Example''': http://rest.bioontology.org/bioportal/rest/ontologies
|-
+
 
| List all ontologies
+
==  Find a specific ontology based on a version id ==
| ./ontologies
+
* '''Signature''':  ./ontologies/{ontology version id}
|-
+
* '''Example''':  http://rest.bioontology.org/bioportal/rest/ontologies/39002
| Find a specific ontology based on a version id
+
 
| ./ontologies/{ontology version id}
+
==  Find all versions of an ontology form a virtual ontology id ==
|-
+
* '''Signature''':./virtual/{virtual ontology id}
| Find all versions of an ontology form a virtual ontology id
+
* '''Example''': http://rest.bioontology.org/bioportal/rest/virtual/1104
| ./virtual/{virtual ontology id}
+
 
|-
+
==  Download ontology file id ==
| Download ontology file
+
* '''Signature''':  ./ontologies/download/{ontology version id}
| ./ontologies/download/{ontology version id}
+
* '''Example''': http://rest.bioontology.org/bioportal/rest/ontologies/download/39002
|-
+
 
| Get versions of an ontology
+
==  Get versions of an ontology id ==
| ./ontologies/version/{ontology id}
+
* '''Signature''': ./ontologies/version/{ontology id}
|-
+
* '''Example''': http://rest.bioontology.org/bioportal/rest/ontologies/version/1104
| Get concept
+
 
| ./concepts/{ontology version id}/{concept id}
+
==  Get latest version of an ontology id ==
|-
+
* '''Signature''':  ./virtual/{ontology_id}
| Get all root concepts for an ontology
+
* '''Example''': http://rest.bioontology.org/bioportal/rest/virtual/1104
| ./concepts/{ontology version id}/root
+
 
|-
+
==  Get concept id ==
| Search for concepts
+
* '''Signature''': ./concepts/{ontology version id}/{concept id}
| ./search/concepts/{query>?ontologies={ids}
+
* '''Example''': http://rest.bioontology.org/bioportal/rest/concepts/39002/BRO:Resource
|-
+
 
| Get latest version of an ontology
+
==  Get all root concepts for an ontology id ==
| ./virtual/{ontology_id}
+
* '''Signature''': ./concepts/{ontology version id}/root
|-
+
* '''Example''': http://rest.bioontology.org/bioportal/rest/concepts/39002/root
| Get concept for latest ontology version
+
 
| ./virtual/{ontology id}/{concept id}
+
==  Search for concepts id ==
|-
+
* '''Signature''':  ./search/concepts/{query>?ontologies={ids}
| List all ontology categories
+
* '''Example''':
| ./categories
+
 
|}
+
==  Get concept for latest ontology version id ==
 +
* '''Signature''': ./virtual/{ontology id}/{concept id}
 +
* '''Example''': http://rest.bioontology.org/bioportal/rest/virtual/1104/BRO:Resource
 +
 
 +
==  List all ontology categories id ==
 +
* '''Signature''':  ./categories
 +
* '''Example''': http://rest.bioontology.org/bioportal/rest/categories

Revision as of 16:16, 17 December 2008

This page documents the signatures for NCBO (and, more specifically, BioPortal) REST services. This list may not be exhaustive.

Note: Signatures for BioPoral services will change in January 2009. We will update this page when this change occurs.

The prefix for all service URLs in the table below is

http://rest.bioontology.org/bioportal/rest

List all ontologies

Find a specific ontology based on a version id

Find all versions of an ontology form a virtual ontology id

Download ontology file id

Get versions of an ontology id

Get latest version of an ontology id

Get concept id

Get all root concepts for an ontology id

Search for concepts id

  • Signature: ./search/concepts/{query>?ontologies={ids}
  • Example:

Get concept for latest ontology version id

List all ontology categories id