Difference between revisions of "BioPortal REST services"

From NCBO Wiki
Jump to: navigation, search
(Undo revision 8653 by Alextest (Talk))
Line 54: Line 54:
 
* '''Signature''':  ./categories
 
* '''Signature''':  ./categories
 
* '''Example''': http://rest.bioontology.org/bioportal/categories
 
* '''Example''': http://rest.bioontology.org/bioportal/categories
 +
 +
==  Hierarchy Services ==
 +
 +
==  Find parents of a given concept in a specific ontology version ==
 +
* '''Signature''': ./concepts/parents/{ontlogyVersionId}/{conceptId}[?{optional args}]
 +
* '''Example''': http://rest.bioontology.org/bioportal/concepts/parents/13578/Melanoma
 +
* '''Optional arguments:'''
 +
** level=<integer> - limits results to a given level in the hierarchy
 +
** offset=<integer> – results offset (used for pagination)
 +
** limit=<integer> – limits the number of results
 +
** '''Example''': http://rest.bioontology.org/bioportal/concepts/parents/13578/Melanoma?level=1&offset=1&limit=10
 +
 +
==  Find parents of a given concept in the latest version of a given ontology ==
 +
* '''Signature''': ./virtual/parents/{ontlogyId}/{conceptId}[?{optional args}]
 +
* '''Example''': http://rest.bioontology.org/bioportal/virtual/parents/1032/Melanoma
 +
* '''Optional arguments:'''
 +
** level=<integer> - limits results to a given level in the hierarchy
 +
** offset=<integer> – results offset (used for pagination)
 +
** limit=<integer> – limits the number of results
 +
** '''Example''': http://rest.bioontology.org/bioportal/virtual/parents/1032/Melanoma?level=1&offset=1&limit=10
 +
 +
==  Find children of a given concept in a specific ontology version ==
 +
* '''Signature''': ./concepts/children/{ontlogyVersionId}/{conceptId}[?{optional args}]
 +
* '''Example''': http://rest.bioontology.org/bioportal/concepts/children/13578/Melanoma
 +
* '''Optional arguments:'''
 +
** level=<integer> - limits results to a given level in the hierarchy
 +
** offset=<integer> – results offset (used for pagination)
 +
 +
==  Find children of a given concept in the latest version of a given ontology ==
 +
* '''Signature''': ./virtual/children/{ontlogyId}/{conceptId}[?{optional args}]
 +
* '''Example''': http://rest.bioontology.org/bioportal/virtual/children/1032/Melanoma
 +
* '''Optional arguments:'''
 +
** level=<integer> - limits results to a given level in the hierarchy
 +
** offset=<integer> – results offset (used for pagination)
 +
 +
==  Find paths to root from a concept in a specific ontology version ==
 +
* '''Signature''': ./concepts/rootpath/{ontologyVersionId}/{conceptId}[?{optional args}]
 +
* '''Example''': http://rest.bioontology.org/bioportal/concepts/rootpath/13578/Melanoma
 +
* '''Optional arguments:'''
 +
** offset=<integer> – results offset (used for pagination)
 +
** limit=<integer> – limits the number of results
 +
 +
==  Find paths to root from a concept in the latest version of a given ontology  ==
 +
* '''Signature''': ./virtual/rootpath/{ontologyId}/{conceptId}[?{optional args}]
 +
* '''Example''': http://rest.bioontology.org/bioportal/virtual/rootpath/1032/Melanoma
 +
* '''Optional arguments:'''
 +
** offset=<integer> – results offset (used for pagination)
 +
** limit=<integer> – limits the number of results
 +
 +
==  Find paths to leaves from a concept in a specific ontology version ==
 +
* '''Signature''': ./concepts/leafpath/{ontologyVersionId}/{conceptId}[?{optional args}]
 +
* '''Example''': http://rest.bioontology.org/bioportal/concepts/leafpath/13578/Melanoma
 +
* '''Optional arguments:'''
 +
** offset=<integer> – results offset (used for pagination)
 +
** limit=<integer> – limits the number of results
 +
 +
==  Find paths to leaves from a concept in the latest version of a given ontology  ==
 +
* '''Signature''': ./virtual/leafpath/{ontologyId}/{conceptId}[?{optional args}]
 +
* '''Example''': http://rest.bioontology.org/bioportal/virtual/leafpath/1032/Melanoma
 +
* '''Optional arguments:'''
 +
** offset=<integer> – results offset (used for pagination)
 +
** limit=<integer> – limits the number of results
 +
 +
==  Find siblings of a given concept in a specific ontology version ==
 +
* '''Signature''': ./concepts/siblings/{ontlogyVersionId}/{conceptId}?level=<level>[&{optional args}]
 +
* '''Example''': http://rest.bioontology.org/bioportal/concepts/siblings/13578/Melanoma?level=1
 +
* '''Required arguments:'''
 +
** level=<integer> - limits results to a given level in the hierarchy
 +
* '''Optional arguments:'''
 +
** offset=<integer> – results offset (used for pagination)
 +
 +
==  Find siblings of a given concept in the latest version of a given ontology ==
 +
* '''Signature''': ./virtual/siblings/{ontlogyId}/{conceptId}?level=<level>[&{optional args}]
 +
* '''Example''': http://rest.bioontology.org/bioportal/virtual/siblings/1032/Melanoma?level=1
 +
* '''Required arguments:'''
 +
** level=<integer> - limits results to a given level in the hierarchy
 +
* '''Optional arguments:'''
 +
** offset=<integer> – results offset (used for pagination)

Revision as of 11:53, 20 April 2009

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

Note: Signatures for BioPortal services have changed in BioPortal 2.0.4 release on January 13th, 2009. This page has the new service URLs. If you have any questions, please contact BioPortal Support.

The prefix for all service URLs in the table below is http://rest.bioontology.org/bioportal/

Contents

List all the latest version of ontologies

Find a specific ontology based on a version id

Download an ontology file

Find all versions of an ontology form a virtual ontology id

Get latest version of an ontology id

Get concept id

Get all root concepts for an ontology id

Get concept for latest ontology version id

Search BioPortal

List all ontology categories id

Hierarchy Services

Find parents of a given concept in a specific ontology version

Find parents of a given concept in the latest version of a given ontology

Find children of a given concept in a specific ontology version

Find children of a given concept in the latest version of a given ontology

Find paths to root from a concept in a specific ontology version

Find paths to root from a concept in the latest version of a given ontology

Find paths to leaves from a concept in a specific ontology version

Find paths to leaves from a concept in the latest version of a given ontology

Find siblings of a given concept in a specific ontology version

Find siblings of a given concept in the latest version of a given ontology

Personal tools
Namespaces

Variants
Actions
Navigation
Toolbox