Conversion API provides access to MINERVA’s ability convert between different systems biology network formats and to export of layouts to different graphical formats.

1. Conversion to systems biology formats

1.1. List available formats

1.1.1. CURL sample

$ curl 'https://minerva-service.lcsb.uni.lu/minerva/api/convert/' -i -X GET

1.1.2. Response Fields

Path Type Description

inputs

array

list of available input formats

inputs[].available_names

array<string>

list of names that could be used for specific format

outputs

array

list of available input formats

outputs[].available_names

array<string>

list of names that could be used for specific format

1.1.3. Sample Response

{
  "inputs" : [ {
    "available_names" : [ "CellDesigner_SBML", "lcsb.mapviewer.converter.model.celldesigner.CellDesignerXmlParser" ]
  }, {
    "available_names" : [ "SBGN-ML", "lcsb.mapviewer.converter.model.sbgnml.SbgnmlXmlConverter" ]
  }, {
    "available_names" : [ "SBML", "lcsb.mapviewer.converter.model.sbml.SbmlParser" ]
  }, {
    "available_names" : [ "GPML", "lcsb.mapviewer.wikipathway.GpmlParser" ]
  } ],
  "outputs" : [ {
    "available_names" : [ "CellDesigner_SBML", "lcsb.mapviewer.converter.model.celldesigner.CellDesignerXmlParser" ]
  }, {
    "available_names" : [ "SBGN-ML", "lcsb.mapviewer.converter.model.sbgnml.SbgnmlXmlConverter" ]
  }, {
    "available_names" : [ "SBML", "lcsb.mapviewer.converter.model.sbml.SbmlParser" ]
  }, {
    "available_names" : [ "GPML", "lcsb.mapviewer.wikipathway.GpmlParser" ]
  } ]
}

1.2. Convert network from an input format to an output format

1.2.1. CURL sample

$ curl 'https://minerva-service.lcsb.uni.lu/minerva/api/convert/CellDesigner_SBML:GPML' -i -X POST \
    --data-binary @input_file.xml \
    --cookie "MINERVA_AUTH_TOKEN=xxxxxxxx"

1.2.2. Path Parameters

Table 1. /api/convert/{inputFormat}:{outputFormat}
Parameter Description

inputFormat

input format, available options: [CellDesigner_SBML, SBGN-ML, SBML, GPML]

outputFormat

output format, available options: [CellDesigner_SBML, SBGN-ML, SBML, GPML]

2. Convert network from an input format to an output image

2.1. List available formats

2.1.1. CURL sample

$ curl 'https://minerva-service.lcsb.uni.lu/minerva/api/convert/image/' -i -X GET

2.1.2. Response Fields

Path Type Description

inputs

array

list of available input formats

inputs[].available_names

array<string>

list of names that could be used for specific format

outputs

array

list of available input formats

outputs[].available_names

array<string>

list of names that could be used for specific format

2.1.3. Sample Response

{
  "inputs" : [ {
    "available_names" : [ "CellDesigner_SBML", "lcsb.mapviewer.converter.model.celldesigner.CellDesignerXmlParser" ]
  }, {
    "available_names" : [ "SBGN-ML", "lcsb.mapviewer.converter.model.sbgnml.SbgnmlXmlConverter" ]
  }, {
    "available_names" : [ "SBML", "lcsb.mapviewer.converter.model.sbml.SbmlParser" ]
  }, {
    "available_names" : [ "GPML", "lcsb.mapviewer.wikipathway.GpmlParser" ]
  } ],
  "outputs" : [ {
    "available_names" : [ "png", "lcsb.mapviewer.converter.graphics.PngImageGenerator" ]
  }, {
    "available_names" : [ "pdf", "lcsb.mapviewer.converter.graphics.PdfImageGenerator" ]
  }, {
    "available_names" : [ "svg", "lcsb.mapviewer.converter.graphics.SvgImageGenerator" ]
  } ]
}

2.2. Convert network from an input format to an output image

2.2.1. CURL sample

$ curl 'https://minerva-service.lcsb.uni.lu/minerva/api/convert/image/CellDesigner_SBML:png' -i -X POST \
    --data-binary @input_file.xml \
    --cookie "MINERVA_AUTH_TOKEN=xxxxxxxx"

2.2.2. Path Parameters

Table 2. /api/convert/image/{inputFormat}:{outputFormat}
Parameter Description

inputFormat

input format, available options: [CellDesigner_SBML, SBGN-ML, SBML, GPML]

outputFormat

output format, available options: [png, pdf, svg]

3. Merging of maps

3.1. Merge

This API call allows to merge few files into one. Layout of merged map files will be a simple matrix.

3.1.1. CURL sample

$ curl 'https://minerva-service.lcsb.uni.lu/minerva/api/convert/merge/CellDesigner_SBML:CellDesigner_SBML' -i -X POST \
    --data-binary @maps.zip \
    --cookie "MINERVA_AUTH_TOKEN=xxxxxxxx"

3.1.2. Path Parameters

Table 3. /api/convert/merge/{inputFormat}:{outputFormat}
Parameter Description

inputFormat

input format, available options: [CellDesigner_SBML, SBGN-ML, SBML, GPML]

outputFormat

output format, available options: [CellDesigner_SBML, SBGN-ML, SBML, GPML]

3.1.3. Input file structure

Input file should be a zip file with single zip folder called "maps". All map files to merge should be located in this folder.