ReMap API

ReMap API

A Web API for accessing to peaks informations from ReMap data.

# Install the command line client
$ pip install coreapi-cli

<!-- Load the JavaScript client library -->
<script src="/static/rest_framework/js/coreapi-0.1.1.js"></script>
<script src="/docs/schema.js"></script>

# Install the Python client library
$ pip install coreapi

api

GET /api/V1/get_peaks/{version}/{assembly}/{datatype}/{chr}:{start}-{end}

Endpoint of the REST API retrieves ReMap peaks data for specified genomic coordinates

Path Parameters

The following parameters should be included in the URL path.

ParameterDescription
version required
assembly required
datatype required
chr required
start required
end required
 
# Load the schema document
$ coreapi get http://remap-rest.univ-amu.fr/docs/

# Interact with the API endpoint
$ coreapi action api V1 get_peaks read -p version=... -p assembly=... -p datatype=... -p chr=... -p start=... -p end=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["api", "V1 &gt; get_peaks &gt; read"]
var params = {
    version: ...,
    assembly: ...,
    datatype: ...,
    chr: ...,
    start: ...,
    end: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://remap-rest.univ-amu.fr/docs/")

# Interact with the API endpoint
action = ["api", "V1 &gt; get_peaks &gt; read"]
params = {
    "version": ...,
    "assembly": ...,
    "datatype": ...,
    "chr": ...,
    "start": ...,
    "end": ...,
}
result = client.action(schema, action, params=params)
GET /api/V1/get_peaks/{version}/{assembly}/{datatype}/{chr}:{start}-{end}{format}

Endpoint of the REST API retrieves ReMap peaks data for specified genomic coordinates

Path Parameters

The following parameters should be included in the URL path.

ParameterDescription
version required
assembly required
datatype required
chr required
start required
end required
format required
 
# Load the schema document
$ coreapi get http://remap-rest.univ-amu.fr/docs/

# Interact with the API endpoint
$ coreapi action api V1 get_peaks read_0 -p version=... -p assembly=... -p datatype=... -p chr=... -p start=... -p end=... -p format=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["api", "V1 &gt; get_peaks &gt; read_0"]
var params = {
    version: ...,
    assembly: ...,
    datatype: ...,
    chr: ...,
    start: ...,
    end: ...,
    format: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://remap-rest.univ-amu.fr/docs/")

# Interact with the API endpoint
action = ["api", "V1 &gt; get_peaks &gt; read_0"]
params = {
    "version": ...,
    "assembly": ...,
    "datatype": ...,
    "chr": ...,
    "start": ...,
    "end": ...,
    "format": ...,
}
result = client.action(schema, action, params=params)
POST /api/V1/get_peaks/{version}/{assembly}/{datatype}/{outformat}/upload{format}

Path Parameters

The following parameters should be included in the URL path.

ParameterDescription
version required
assembly required
datatype required
outformat required
format required
 
# Load the schema document
$ coreapi get http://remap-rest.univ-amu.fr/docs/

# Interact with the API endpoint
$ coreapi action api V1 get_peaks create -p version=... -p assembly=... -p datatype=... -p outformat=... -p format=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["api", "V1 &gt; get_peaks &gt; create"]
var params = {
    version: ...,
    assembly: ...,
    datatype: ...,
    outformat: ...,
    format: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://remap-rest.univ-amu.fr/docs/")

# Interact with the API endpoint
action = ["api", "V1 &gt; get_peaks &gt; create"]
params = {
    "version": ...,
    "assembly": ...,
    "datatype": ...,
    "outformat": ...,
    "format": ...,
}
result = client.action(schema, action, params=params)
POST /api/V1/get_peaks/{version}/{assembly}/{datatype}/{outformat}/upload/

Path Parameters

The following parameters should be included in the URL path.

ParameterDescription
version required
assembly required
datatype required
outformat required
 
# Load the schema document
$ coreapi get http://remap-rest.univ-amu.fr/docs/

# Interact with the API endpoint
$ coreapi action api V1 get_peaks upload create -p version=... -p assembly=... -p datatype=... -p outformat=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["api", "V1 &gt; get_peaks &gt; upload &gt; create"]
var params = {
    version: ...,
    assembly: ...,
    datatype: ...,
    outformat: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://remap-rest.univ-amu.fr/docs/")

# Interact with the API endpoint
action = ["api", "V1 &gt; get_peaks &gt; upload &gt; create"]
params = {
    "version": ...,
    "assembly": ...,
    "datatype": ...,
    "outformat": ...,
}
result = client.action(schema, action, params=params)

api_swagger

GET /api_swagger 

# Load the schema document
$ coreapi get http://remap-rest.univ-amu.fr/docs/

# Interact with the API endpoint
$ coreapi action api_swagger list

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["api_swagger", "list"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://remap-rest.univ-amu.fr/docs/")

# Interact with the API endpoint
action = ["api_swagger", "list"]
result = client.action(schema, action)

hello

GET /hello/ 

# Load the schema document
$ coreapi get http://remap-rest.univ-amu.fr/docs/

# Interact with the API endpoint
$ coreapi action hello list

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["hello", "list"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://remap-rest.univ-amu.fr/docs/")

# Interact with the API endpoint
action = ["hello", "list"]
result = client.action(schema, action)

schema

GET /schema/ 

# Load the schema document
$ coreapi get http://remap-rest.univ-amu.fr/docs/

# Interact with the API endpoint
$ coreapi action schema list

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["schema", "list"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://remap-rest.univ-amu.fr/docs/")

# Interact with the API endpoint
action = ["schema", "list"]
result = client.action(schema, action)