Developer Documents

NeXO RESTful API Version 1 Beta

Introduction

NeXO datasets are fully accessible through simple RESTful API. This is the beta release of API, and some of the method may change in the final version.

Base URL

Our API server is http://chardonnay.ucsd.edu/

Basic Entry Retrieval

Get Details by ID

Syntax

• BASE_URL/ID

ID is a unique identifier for terms and genes. For example, term IDs start with namespace, and then ID for the ontology. For genes, SGD IDs are used as unique identifier.

Return Value

A JSON Object

Example

• http://chardonnay.ucsd.edu/NEXO:9818
• http://chardonnay.ucsd.edu/GO:0000502
• http://chardonnay.ucsd.edu/S000004466

Get Path to the root term

Syntax

• BASE_URL/ID/path

This return array of paths. First element is always the shortest path to the root, and others are the first neighbour of the term. These first neighbours are hidden in the visualization, and if you want to get those, you need to access this API to get all neighbour terms.

Return value

Array of arrays

Example

• http://chardonnay.ucsd.edu/NEXO:9818/path
• http://chardonnay.ucsd.edu/GO:0000502/path
• http://chardonnay.ucsd.edu/S000004466/path

Get raw interactions (NeXO only)

Example

• http://chardonnay.ucsd.edu/NEXO:9818/interactions

Source Code Availability