mg-rest-3d server

Methods

Get Endpoints

class rest.app.GetEndPoints[source]

Class to handle the http requests for returning information about the end points

static get()[source]

GET list all end points

List of all of the end points for the current service.

Example

1
curl -X GET http://localhost:5001/mug/api/3dcoord

Get Resolutions

class rest.app.GetResolutions[source]

Class to handle the http requests for returning information about the resolutions that models have been generated for

get(*args, **kwargs)[source]

GET List available resolutions from dataset

Parameters:
  • user_id (str) – User ID
  • file_id (str) – Identifier of the file to retrieve data from
Returns:

file – JSON file listing the available resolutions within the dataset
Return type:

json

Examples

1
curl -X GET http://localhost:5001/mug/api/3dcoord/resolutions?user_id=test&file_id=test_file

Get Chromosomes

class rest.app.GetChromosomes[source]

Class to handle the http requests for returning information about the chromosomes that the models have been generated across

get(*args, **kwargs)[source]

GET List available chromosomes from dataset

Parameters:
  • user_id (str) – User ID
  • file_id (str) – Identifier of the file to retrieve data from
  • res (int) – Resolution
Returns:

file – JSON file listing the available chromosomes within a dataset at a given resolution
Return type:

json

Examples

1
curl -X GET http://localhost:5001/mug/api/3dcoord/chromosomes?user_id=test&file_id=test_file

Get Regions

class rest.app.GetRegions[source]

Class to handle the http requests for returning information about the regions that are available in a given region and level of resolution

get(*args, **kwargs)[source]

GET List available models from dataset

Parameters:
  • user_id (str) – User ID
  • file_id (str) – Identifier of the file to retrieve data from
  • res (int) – Resolution
  • chrom (str) – Chromosome identifier (1, 2, 3, chr1, chr2, chr3, I, II, III, etc) for the chromosome of interest
  • start (int) – Start position for a selected region
  • end (int) – End position for a selected region
Returns:

file – JSON file listing the available models within a dataset at a given resolution and chromosomal region
Return type:

json

Examples

1
curl -X GET http://localhost:5001/mug/api/3dcoord/regions?user_id=test&file_id=test_file&res=1000000&chrom=1&start=1&end=1000000

Get Models

class rest.app.GetModels[source]

Class to handle the http requests for returning information about the models that are available within a given region.

get(*args, **kwargs)[source]

GET List available models from dataset

Parameters:
  • user_id (str) – User ID
  • file_id (str) – Identifier of the file to retrieve data from
  • res (int) – Resolution
  • region (str) – Region ID
Returns:

file – JSON file listing the available models within a dataset at a given resolution and chromosomal region
Return type:

json

Examples

1
curl -X GET http://localhost:5001/mug/api/3dcoord/models?user_id=test&file_id=test_file&res=1000000&region=1

Get Model

class rest.app.GetModel[source]

Class to handle the http requests for returning the models from a given region. The list of models is a comma separated list that can return multiple models from the same region

get(*args, **kwargs)[source]

GET List available model from dataset

Parameters:
  • user_id (str) – User ID
  • file_id (str) – Identifier of the file to retrieve data from
  • res (int) – Resolution
  • region (str) – Region ID
  • model (str) – model ID
Returns:

file – JSON file listing the available models within a dataset at a given resolution and chromosomal region
Return type:

json

Examples

1
curl -X GET http://localhost:5001/mug/api/3dcoord/model?user_id=test&file_id=test_file&region=1&model=model1

Ping

class rest.app.Ping[source]

Class to handle the http requests to ping a service

static get()[source]

GET Status

List the current status of the service along with the relevant information about the version.

Example

1
curl -X GET http://localhost:5001/mug/api/3dcoord/ping