Reactions of a map and their sub-resources, served from /new_api/projects/{projectId}/maps/{mapId}/bio_entities/reactions.

1. Reactants

Reactants consumed by the reaction.
See full documentation.

1.1. Reactant element

The map element that a reactant points at.
See full documentation.

2. Products

Products produced by the reaction.
See full documentation.

2.1. Product element

The map element that a product points at.
See full documentation.

3. Modifiers

Modifiers reference the map element acting as regulator (catalyst, inhibitor, trigger, modulator, …​) as determined by the reaction’s type.
See full documentation.

3.1. Modifier element

The map element that a modifier points at.
See full documentation.

4. Operators

Logic operators (AND, OR, …​) joining reactants and products of the reaction.
See full documentation.

4.1. Operator inputs

The reactants, or nested operators, combined as inputs of the logic operator.
See full documentation.

4.2. Operator outputs

The products, or nested operators, combined as outputs of the logic operator.
See full documentation.

5. Annotations

Annotations linking the reaction to external databases.
See full documentation.

6. List reactions

Returns all reactions belonging to a map.

Note
The result is paged - use the page and size query parameters to walk through it.

6.1. HTTP request

GET /minerva/new_api/projects/test_project/maps/274/bio_entities/reactions/ HTTP/1.1

6.2. Path Parameters

Table 1. /minerva/new_api/projects/{projectId}/maps/{mapId}/bio_entities/reactions/
Parameter Description

projectId

project identifier

mapId

map identifier

6.3. Query Parameters

Parameter Description

page

index of the page to fetch, counted from 0; 0 by default

size

number of entries on a page; 20 by default, 10000 at most

6.4. CURL sample

$ curl 'https://minerva-dev.lcsb.uni.lu/minerva/new_api/projects/test_project/maps/274/bio_entities/reactions/' -X GET \
    -H 'Authorization: Bearer xxxxxxxx'

6.5. HTTP response

HTTP/1.1 200 OK

6.6. Sample Response

{
  "content" : [ {
    "id" : 121,
    "notes" : "",
    "idReaction" : "path_0_re5933",
    "name" : "",
    "reversible" : false,
    "visibilityLevel" : "",
    "z" : 2,
    "kinetics" : {
      "parameters" : [ ],
      "functions" : [ ],
      "definition" : "<math xmlns=\"http://www.w3.org/1998/Math/MathML\"><lambda>\n<bvar>\n<ci> x </ci>\n</bvar>\n<bvar>\n<ci> y </ci>\n</bvar>\n<apply>\n<plus/>\n<ci> x </ci>\n<ci> y </ci>\n</apply>\n</lambda></math>"
    },
    "line" : {
      "id" : 1074,
      "width" : 1.0,
      "color" : "#000000ff",
      "z" : 0,
      "segments" : [ {
        "x1" : 0.0,
        "y1" : 0.0,
        "x2" : 10.0,
        "y2" : 0.0
      } ],
      "startArrow" : {
        "arrowType" : "NONE",
        "angle" : 2.748893571891069,
        "lineType" : "SOLID",
        "length" : 15.0
      },
      "endArrow" : {
        "arrowType" : "NONE",
        "angle" : 2.748893571891069,
        "lineType" : "SOLID",
        "length" : 15.0
      },
      "lineType" : "SOLID"
    },
    "processCoordinates" : null,
    "modifiers" : [ {
      "id" : 840,
      "line" : {
        "id" : 1081,
        "width" : 1.0,
        "color" : "#000000ff",
        "z" : 0,
        "segments" : [ {
          "x1" : 10.0,
          "y1" : 0.0,
          "x2" : 0.0,
          "y2" : 0.0
        } ],
        "startArrow" : {
          "arrowType" : "NONE",
          "angle" : 2.748893571891069,
          "lineType" : "SOLID",
          "length" : 15.0
        },
        "endArrow" : {
          "arrowType" : "NONE",
          "angle" : 2.748893571891069,
          "lineType" : "SOLID",
          "length" : 15.0
        },
        "lineType" : "SOLID"
      },
      "stoichiometry" : null,
      "element" : 753,
      "sboTerm" : "SBO:0000013"
    } ],
    "elementId" : "path_0_re5933",
    "products" : [ {
      "id" : 838,
      "line" : {
        "id" : 1080,
        "width" : 1.0,
        "color" : "#000000ff",
        "z" : 0,
        "segments" : [ {
          "x1" : 15.0,
          "y1" : 0.0,
          "x2" : 30.0,
          "y2" : 0.0
        } ],
        "startArrow" : {
          "arrowType" : "NONE",
          "angle" : 2.748893571891069,
          "lineType" : "SOLID",
          "length" : 15.0
        },
        "endArrow" : {
          "arrowType" : "NONE",
          "angle" : 2.748893571891069,
          "lineType" : "SOLID",
          "length" : 15.0
        },
        "lineType" : "SOLID"
      },
      "stoichiometry" : null,
      "element" : 752
    }, {
      "id" : 839,
      "line" : {
        "id" : 1078,
        "width" : 1.0,
        "color" : "#000000ff",
        "z" : 0,
        "segments" : [ {
          "x1" : 15.0,
          "y1" : 0.0,
          "x2" : 20.0,
          "y2" : 0.0
        } ],
        "startArrow" : {
          "arrowType" : "NONE",
          "angle" : 2.748893571891069,
          "lineType" : "SOLID",
          "length" : 15.0
        },
        "endArrow" : {
          "arrowType" : "NONE",
          "angle" : 2.748893571891069,
          "lineType" : "SOLID",
          "length" : 15.0
        },
        "lineType" : "SOLID"
      },
      "stoichiometry" : null,
      "element" : 753
    } ],
    "reactants" : [ {
      "id" : 835,
      "line" : {
        "id" : 1077,
        "width" : 1.0,
        "color" : "#000000ff",
        "z" : 0,
        "segments" : [ {
          "x1" : 15.0,
          "y1" : 0.0,
          "x2" : 0.0,
          "y2" : 0.0
        } ],
        "startArrow" : {
          "arrowType" : "NONE",
          "angle" : 2.748893571891069,
          "lineType" : "SOLID",
          "length" : 15.0
        },
        "endArrow" : {
          "arrowType" : "NONE",
          "angle" : 2.748893571891069,
          "lineType" : "SOLID",
          "length" : 15.0
        },
        "lineType" : "SOLID"
      },
      "stoichiometry" : null,
      "element" : 752
    }, {
      "id" : 836,
      "line" : {
        "id" : 1075,
        "width" : 1.0,
        "color" : "#000000ff",
        "z" : 0,
        "segments" : [ {
          "x1" : 10.0,
          "y1" : 0.0,
          "x2" : 0.0,
          "y2" : 0.0
        } ],
        "startArrow" : {
          "arrowType" : "NONE",
          "angle" : 2.748893571891069,
          "lineType" : "SOLID",
          "length" : 15.0
        },
        "endArrow" : {
          "arrowType" : "NONE",
          "angle" : 2.748893571891069,
          "lineType" : "SOLID",
          "length" : 15.0
        },
        "lineType" : "SOLID"
      },
      "stoichiometry" : null,
      "element" : 753
    } ],
    "operators" : [ {
      "id" : 834,
      "line" : {
        "id" : 1076,
        "width" : 1.0,
        "color" : "#000000ff",
        "z" : 0,
        "segments" : [ {
          "x1" : 10.0,
          "y1" : 0.0,
          "x2" : 15.0,
          "y2" : 0.0
        } ],
        "startArrow" : {
          "arrowType" : "NONE",
          "angle" : 2.748893571891069,
          "lineType" : "SOLID",
          "length" : 15.0
        },
        "endArrow" : {
          "arrowType" : "NONE",
          "angle" : 2.748893571891069,
          "lineType" : "SOLID",
          "length" : 15.0
        },
        "lineType" : "SOLID"
      },
      "inputs" : [ {
        "id" : 835
      }, {
        "id" : 836
      } ],
      "outputs" : [ ],
      "operatorText" : "",
      "productOperator" : false,
      "modifierOperator" : false,
      "reactantOperator" : true,
      "sboTerm" : "SBO:0000173"
    }, {
      "id" : 837,
      "line" : {
        "id" : 1079,
        "width" : 1.0,
        "color" : "#000000ff",
        "z" : 0,
        "segments" : [ {
          "x1" : 10.0,
          "y1" : 0.0,
          "x2" : 15.0,
          "y2" : 0.0
        } ],
        "startArrow" : {
          "arrowType" : "NONE",
          "angle" : 2.748893571891069,
          "lineType" : "SOLID",
          "length" : 15.0
        },
        "endArrow" : {
          "arrowType" : "NONE",
          "angle" : 2.748893571891069,
          "lineType" : "SOLID",
          "length" : 15.0
        },
        "lineType" : "SOLID"
      },
      "inputs" : [ ],
      "outputs" : [ {
        "id" : 838
      }, {
        "id" : 839
      } ],
      "operatorText" : "",
      "productOperator" : true,
      "modifierOperator" : false,
      "reactantOperator" : false,
      "sboTerm" : "SBO:0000173"
    } ],
    "references" : [ {
      "link" : null,
      "article" : null,
      "type" : "PUBMED",
      "resource" : "28725475",
      "id" : 969,
      "annotator" : null
    }, {
      "link" : null,
      "article" : null,
      "type" : "PUBMED",
      "resource" : "invalid123",
      "id" : 970,
      "annotator" : null
    } ],
    "map" : 274,
    "sboTerm" : "SBO:0000185"
  } ],
  "totalPages" : 1,
  "totalElements" : 1,
  "numberOfElements" : 1,
  "size" : 20,
  "number" : 0
}

7. Get reaction

Returns a single reaction by its identifier.

7.1. HTTP request

GET /minerva/new_api/projects/test_project/maps/278/bio_entities/reactions/123 HTTP/1.1

7.2. Path Parameters

Table 2. /minerva/new_api/projects/{projectId}/maps/{mapId}/bio_entities/reactions/{reactionId}
Parameter Description

projectId

project identifier

mapId

map identifier

reactionId

reaction identifier

7.3. CURL sample

$ curl 'https://minerva-dev.lcsb.uni.lu/minerva/new_api/projects/test_project/maps/278/bio_entities/reactions/123' -X GET \
    -H 'Authorization: Bearer xxxxxxxx'

7.4. HTTP response

HTTP/1.1 200 OK

7.5. Response Fields

Path Type Description

immediateLink

String

link that should be opened immediately when element is clicked on the map

id

Number

unique bioEntity identifier

name

String

name of the bioEntity displayed on the map

elementId

String

element identifier taken from source file

map

Number

map identifier

references

Array

list of references

z

Number

z index (coordinate) of the element on the map

notes

String

notes and description

visibilityLevel

String

at what zoom level this element becomes visible in hierarchical view

homodimer

Number

multimer value

sboTerm

String

SBO term identifying the type of the bioEntity

idReaction

String

reaction identifier taken from source file

reversible

Boolean

is reaction reversible

kinetics

Object

reaction SBML kinetics law

products

Array

list of reaction products

products[].element

Number

identifier of the element for this product

products[].stoichiometry

Number

SBML stoichiometry

products[].line

Object

line used to draw product connection

reactants

Array

list of reaction reactants

reactants[].element

Number

identifier of the element for this reactant

reactants[].stoichiometry

Number

SBML stoichiometry

reactants[].line

Object

line used to draw reactant connection

modifiers

Array

list of reaction modifiers

modifiers[].element

Number

identifier of the element for this modifier

modifiers[].stoichiometry

Number

SBML stoichiometry

modifiers[].sboTerm

String

SBO term identifying the type of the modifier

modifiers[].line

Object

line used to draw modifier connection

processCoordinates

Object

coordinates of process in the reaction if defined manually. If this value is not present then center of line should be taken.

line

Object

reaction central line

line.id

Number

line identifier

line.width

Number

line width

line.z

Number

line z coordinate (z-index)

line.segments

Array

line segments

line.startArrow

Object

arrow definition of the line beginning

line.endArrow

Object

arrow definition of the line ending

line.lineType

String

line pattern

line.color

String

line color; #RRGGBBAA string

products[].line.id

Number

line identifier

products[].line.width

Number

line width

products[].line.z

Number

line z coordinate (z-index)

products[].line.segments

Array

line segments

products[].line.startArrow

Object

arrow definition of the line beginning

products[].line.endArrow

Object

arrow definition of the line ending

products[].line.lineType

String

line pattern

products[].line.color

String

line color; #RRGGBBAA string

reactants[].line.id

Number

line identifier

reactants[].line.width

Number

line width

reactants[].line.z

Number

line z coordinate (z-index)

reactants[].line.segments

Array

line segments

reactants[].line.startArrow

Object

arrow definition of the line beginning

reactants[].line.endArrow

Object

arrow definition of the line ending

reactants[].line.lineType

String

line pattern

reactants[].line.color

String

line color; #RRGGBBAA string

modifiers[].line.id

Number

line identifier

modifiers[].line.width

Number

line width

modifiers[].line.z

Number

line z coordinate (z-index)

modifiers[].line.segments

Array

line segments

modifiers[].line.startArrow

Object

arrow definition of the line beginning

modifiers[].line.endArrow

Object

arrow definition of the line ending

modifiers[].line.lineType

String

line pattern

modifiers[].line.color

String

line color; #RRGGBBAA string

operators

Array

reaction operators

operators[].id

Number

operator identifier

operators[].line

Object

line for the operator

operators[].sboTerm

String

SBO term identifying the type of the operator

7.6. Sample Response

{
  "id" : 123,
  "notes" : "",
  "idReaction" : "path_0_re5933",
  "name" : "",
  "reversible" : false,
  "visibilityLevel" : "",
  "z" : 2,
  "kinetics" : {
    "parameters" : [ ],
    "functions" : [ ],
    "definition" : "<math xmlns=\"http://www.w3.org/1998/Math/MathML\"><lambda>\n<bvar>\n<ci> x </ci>\n</bvar>\n<bvar>\n<ci> y </ci>\n</bvar>\n<apply>\n<plus/>\n<ci> x </ci>\n<ci> y </ci>\n</apply>\n</lambda></math>"
  },
  "line" : {
    "id" : 1092,
    "width" : 1.0,
    "color" : "#000000ff",
    "z" : 0,
    "segments" : [ {
      "x1" : 0.0,
      "y1" : 0.0,
      "x2" : 10.0,
      "y2" : 0.0
    } ],
    "startArrow" : {
      "arrowType" : "NONE",
      "angle" : 2.748893571891069,
      "lineType" : "SOLID",
      "length" : 15.0
    },
    "endArrow" : {
      "arrowType" : "NONE",
      "angle" : 2.748893571891069,
      "lineType" : "SOLID",
      "length" : 15.0
    },
    "lineType" : "SOLID"
  },
  "processCoordinates" : null,
  "modifiers" : [ {
    "id" : 854,
    "line" : {
      "id" : 1099,
      "width" : 1.0,
      "color" : "#000000ff",
      "z" : 0,
      "segments" : [ {
        "x1" : 10.0,
        "y1" : 0.0,
        "x2" : 0.0,
        "y2" : 0.0
      } ],
      "startArrow" : {
        "arrowType" : "NONE",
        "angle" : 2.748893571891069,
        "lineType" : "SOLID",
        "length" : 15.0
      },
      "endArrow" : {
        "arrowType" : "NONE",
        "angle" : 2.748893571891069,
        "lineType" : "SOLID",
        "length" : 15.0
      },
      "lineType" : "SOLID"
    },
    "stoichiometry" : null,
    "element" : 765,
    "sboTerm" : "SBO:0000013"
  } ],
  "elementId" : "path_0_re5933",
  "products" : [ {
    "id" : 852,
    "line" : {
      "id" : 1098,
      "width" : 1.0,
      "color" : "#000000ff",
      "z" : 0,
      "segments" : [ {
        "x1" : 15.0,
        "y1" : 0.0,
        "x2" : 30.0,
        "y2" : 0.0
      } ],
      "startArrow" : {
        "arrowType" : "NONE",
        "angle" : 2.748893571891069,
        "lineType" : "SOLID",
        "length" : 15.0
      },
      "endArrow" : {
        "arrowType" : "NONE",
        "angle" : 2.748893571891069,
        "lineType" : "SOLID",
        "length" : 15.0
      },
      "lineType" : "SOLID"
    },
    "stoichiometry" : null,
    "element" : 761
  }, {
    "id" : 853,
    "line" : {
      "id" : 1096,
      "width" : 1.0,
      "color" : "#000000ff",
      "z" : 0,
      "segments" : [ {
        "x1" : 15.0,
        "y1" : 0.0,
        "x2" : 20.0,
        "y2" : 0.0
      } ],
      "startArrow" : {
        "arrowType" : "NONE",
        "angle" : 2.748893571891069,
        "lineType" : "SOLID",
        "length" : 15.0
      },
      "endArrow" : {
        "arrowType" : "NONE",
        "angle" : 2.748893571891069,
        "lineType" : "SOLID",
        "length" : 15.0
      },
      "lineType" : "SOLID"
    },
    "stoichiometry" : null,
    "element" : 765
  } ],
  "reactants" : [ {
    "id" : 849,
    "line" : {
      "id" : 1095,
      "width" : 1.0,
      "color" : "#000000ff",
      "z" : 0,
      "segments" : [ {
        "x1" : 15.0,
        "y1" : 0.0,
        "x2" : 0.0,
        "y2" : 0.0
      } ],
      "startArrow" : {
        "arrowType" : "NONE",
        "angle" : 2.748893571891069,
        "lineType" : "SOLID",
        "length" : 15.0
      },
      "endArrow" : {
        "arrowType" : "NONE",
        "angle" : 2.748893571891069,
        "lineType" : "SOLID",
        "length" : 15.0
      },
      "lineType" : "SOLID"
    },
    "stoichiometry" : null,
    "element" : 761
  }, {
    "id" : 850,
    "line" : {
      "id" : 1093,
      "width" : 1.0,
      "color" : "#000000ff",
      "z" : 0,
      "segments" : [ {
        "x1" : 10.0,
        "y1" : 0.0,
        "x2" : 0.0,
        "y2" : 0.0
      } ],
      "startArrow" : {
        "arrowType" : "NONE",
        "angle" : 2.748893571891069,
        "lineType" : "SOLID",
        "length" : 15.0
      },
      "endArrow" : {
        "arrowType" : "NONE",
        "angle" : 2.748893571891069,
        "lineType" : "SOLID",
        "length" : 15.0
      },
      "lineType" : "SOLID"
    },
    "stoichiometry" : null,
    "element" : 765
  } ],
  "operators" : [ {
    "id" : 848,
    "line" : {
      "id" : 1094,
      "width" : 1.0,
      "color" : "#000000ff",
      "z" : 0,
      "segments" : [ {
        "x1" : 10.0,
        "y1" : 0.0,
        "x2" : 15.0,
        "y2" : 0.0
      } ],
      "startArrow" : {
        "arrowType" : "NONE",
        "angle" : 2.748893571891069,
        "lineType" : "SOLID",
        "length" : 15.0
      },
      "endArrow" : {
        "arrowType" : "NONE",
        "angle" : 2.748893571891069,
        "lineType" : "SOLID",
        "length" : 15.0
      },
      "lineType" : "SOLID"
    },
    "inputs" : [ {
      "id" : 849
    }, {
      "id" : 850
    } ],
    "outputs" : [ ],
    "operatorText" : "",
    "productOperator" : false,
    "modifierOperator" : false,
    "reactantOperator" : true,
    "sboTerm" : "SBO:0000173"
  }, {
    "id" : 851,
    "line" : {
      "id" : 1097,
      "width" : 1.0,
      "color" : "#000000ff",
      "z" : 0,
      "segments" : [ {
        "x1" : 10.0,
        "y1" : 0.0,
        "x2" : 15.0,
        "y2" : 0.0
      } ],
      "startArrow" : {
        "arrowType" : "NONE",
        "angle" : 2.748893571891069,
        "lineType" : "SOLID",
        "length" : 15.0
      },
      "endArrow" : {
        "arrowType" : "NONE",
        "angle" : 2.748893571891069,
        "lineType" : "SOLID",
        "length" : 15.0
      },
      "lineType" : "SOLID"
    },
    "inputs" : [ ],
    "outputs" : [ {
      "id" : 852
    }, {
      "id" : 853
    } ],
    "operatorText" : "",
    "productOperator" : true,
    "modifierOperator" : false,
    "reactantOperator" : false,
    "sboTerm" : "SBO:0000173"
  } ],
  "references" : [ {
    "link" : null,
    "article" : null,
    "type" : "PUBMED",
    "resource" : "28725475",
    "id" : 985,
    "annotator" : null
  }, {
    "link" : null,
    "article" : null,
    "type" : "PUBMED",
    "resource" : "invalid123",
    "id" : 986,
    "annotator" : null
  } ],
  "map" : 278,
  "sboTerm" : "SBO:0000185"
}

8. Add reaction

Creates a new reaction in the map. The reaction type is determined by the sboTerm field.

8.1. HTTP request

POST /minerva/new_api/projects/test_project/maps/272/bio_entities/reactions/ HTTP/1.1

8.2. Path Parameters

Table 3. /minerva/new_api/projects/{projectId}/maps/{mapId}/bio_entities/reactions/
Parameter Description

projectId

project identifier

mapId

map identifier

8.3. Request Fields

Path Type Description

reactionId

String

reaction identifier (must match existing reactionId on update; defines the id for create)

sboTerm

String

SBO term that determines the reaction type (e.g. SBO:0000185 for transport)

name

String

reaction name

notes

String

free-text notes

reversible

Boolean

whether the reaction is reversible

z

Number

z-index

processCoordinates

Object

coordinates of the process node (object with x and y)

visibilityLevel

String

hierarchy visibility level

8.4. CURL sample

$ curl 'https://minerva-dev.lcsb.uni.lu/minerva/new_api/projects/test_project/maps/272/bio_entities/reactions/' -X POST \
    -H 'Authorization: Bearer xxxxxxxx' \
    -d '{"notes":"note","name":"re_nam12","reversible":false,"sboTerm":"SBO:0000185","visibilityLevel":"","z":1,"processCoordinates":{"x":10.0,"y":10.0},"reactionId":"re11"}' \
    -H 'Content-Type: application/json'

8.5. HTTP response

HTTP/1.1 201 Created

8.6. Response Fields

Path Type Description

immediateLink

String

link that should be opened immediately when element is clicked on the map

id

Number

unique bioEntity identifier

name

String

name of the bioEntity displayed on the map

elementId

String

element identifier taken from source file

map

Number

map identifier

references

Array

list of references

z

Number

z index (coordinate) of the element on the map

notes

String

notes and description

visibilityLevel

String

at what zoom level this element becomes visible in hierarchical view

homodimer

Number

multimer value

sboTerm

String

SBO term identifying the type of the bioEntity

idReaction

String

reaction identifier taken from source file

reversible

Boolean

is reaction reversible

kinetics

Object

reaction SBML kinetics law

products

Array

list of reaction products

products[].element

Number

identifier of the element for this product

products[].stoichiometry

Number

SBML stoichiometry

products[].line

Object

line used to draw product connection

reactants

Array

list of reaction reactants

reactants[].element

Number

identifier of the element for this reactant

reactants[].stoichiometry

Number

SBML stoichiometry

reactants[].line

Object

line used to draw reactant connection

modifiers

Array

list of reaction modifiers

modifiers[].element

Number

identifier of the element for this modifier

modifiers[].stoichiometry

Number

SBML stoichiometry

modifiers[].sboTerm

String

SBO term identifying the type of the modifier

modifiers[].line

Object

line used to draw modifier connection

processCoordinates

Object

coordinates of process in the reaction if defined manually. If this value is not present then center of line should be taken.

line

Object

reaction central line

line.id

Number

line identifier

line.width

Number

line width

line.z

Number

line z coordinate (z-index)

line.segments

Array

line segments

line.startArrow

Object

arrow definition of the line beginning

line.endArrow

Object

arrow definition of the line ending

line.lineType

String

line pattern

line.color

String

line color; #RRGGBBAA string

products[].line.id

Number

line identifier

products[].line.width

Number

line width

products[].line.z

Number

line z coordinate (z-index)

products[].line.segments

Array

line segments

products[].line.startArrow

Object

arrow definition of the line beginning

products[].line.endArrow

Object

arrow definition of the line ending

products[].line.lineType

String

line pattern

products[].line.color

String

line color; #RRGGBBAA string

reactants[].line.id

Number

line identifier

reactants[].line.width

Number

line width

reactants[].line.z

Number

line z coordinate (z-index)

reactants[].line.segments

Array

line segments

reactants[].line.startArrow

Object

arrow definition of the line beginning

reactants[].line.endArrow

Object

arrow definition of the line ending

reactants[].line.lineType

String

line pattern

reactants[].line.color

String

line color; #RRGGBBAA string

modifiers[].line.id

Number

line identifier

modifiers[].line.width

Number

line width

modifiers[].line.z

Number

line z coordinate (z-index)

modifiers[].line.segments

Array

line segments

modifiers[].line.startArrow

Object

arrow definition of the line beginning

modifiers[].line.endArrow

Object

arrow definition of the line ending

modifiers[].line.lineType

String

line pattern

modifiers[].line.color

String

line color; #RRGGBBAA string

operators

Array

reaction operators

operators[].id

Number

operator identifier

operators[].line

Object

line for the operator

operators[].sboTerm

String

SBO term identifying the type of the operator

8.7. Sample Response

{
  "id" : 120,
  "notes" : "note",
  "idReaction" : "re11",
  "name" : "re_nam12",
  "reversible" : false,
  "visibilityLevel" : "",
  "z" : 1,
  "kinetics" : null,
  "line" : {
    "id" : 1072,
    "width" : 1.0,
    "color" : "#000000ff",
    "z" : 0,
    "segments" : [ ],
    "startArrow" : {
      "arrowType" : "NONE",
      "angle" : 2.748893571891069,
      "lineType" : "SOLID",
      "length" : 15.0
    },
    "endArrow" : {
      "arrowType" : "NONE",
      "angle" : 2.748893571891069,
      "lineType" : "SOLID",
      "length" : 15.0
    },
    "lineType" : "SOLID"
  },
  "processCoordinates" : {
    "x" : 10.0,
    "y" : 10.0
  },
  "modifiers" : [ ],
  "elementId" : "re11",
  "products" : [ ],
  "reactants" : [ ],
  "operators" : [ ],
  "references" : [ ],
  "map" : 272,
  "sboTerm" : "SBO:0000185"
}

9. Update reaction

Updates an existing reaction. The sboTerm (reaction type) cannot be changed on update.

Note
Supports optimistic locking via the If-Match header.

9.1. HTTP request

PUT /minerva/new_api/projects/test_project/maps/270/bio_entities/reactions/118 HTTP/1.1

9.2. Path Parameters

Table 4. /minerva/new_api/projects/{projectId}/maps/{mapId}/bio_entities/reactions/{reactionId}
Parameter Description

projectId

project identifier

mapId

map identifier

reactionId

reaction identifier

9.3. Request Fields

Path Type Description

reactionId

String

reaction identifier (must match existing reactionId on update; defines the id for create)

sboTerm

String

SBO term that determines the reaction type (e.g. SBO:0000185 for transport)

name

String

reaction name

notes

String

free-text notes

reversible

Boolean

whether the reaction is reversible

z

Number

z-index

processCoordinates

Object

coordinates of the process node (object with x and y)

visibilityLevel

String

hierarchy visibility level

9.4. CURL sample

$ curl 'https://minerva-dev.lcsb.uni.lu/minerva/new_api/projects/test_project/maps/270/bio_entities/reactions/118' -X PUT \
    -H 'Authorization: Bearer xxxxxxxx' \
    -d '{"notes":"note","name":"re_nam12","reversible":false,"sboTerm":"SBO:0000185","visibilityLevel":"","z":1,"processCoordinates":{"x":10.0,"y":10.0},"reactionId":"path_0_re5933"}' \
    -H 'Content-Type: application/json'

9.5. HTTP response

HTTP/1.1 200 OK

9.6. Response Fields

Path Type Description

immediateLink

String

link that should be opened immediately when element is clicked on the map

id

Number

unique bioEntity identifier

name

String

name of the bioEntity displayed on the map

elementId

String

element identifier taken from source file

map

Number

map identifier

references

Array

list of references

z

Number

z index (coordinate) of the element on the map

notes

String

notes and description

visibilityLevel

String

at what zoom level this element becomes visible in hierarchical view

homodimer

Number

multimer value

sboTerm

String

SBO term identifying the type of the bioEntity

idReaction

String

reaction identifier taken from source file

reversible

Boolean

is reaction reversible

kinetics

Object

reaction SBML kinetics law

products

Array

list of reaction products

products[].element

Number

identifier of the element for this product

products[].stoichiometry

Number

SBML stoichiometry

products[].line

Object

line used to draw product connection

reactants

Array

list of reaction reactants

reactants[].element

Number

identifier of the element for this reactant

reactants[].stoichiometry

Number

SBML stoichiometry

reactants[].line

Object

line used to draw reactant connection

modifiers

Array

list of reaction modifiers

modifiers[].element

Number

identifier of the element for this modifier

modifiers[].stoichiometry

Number

SBML stoichiometry

modifiers[].sboTerm

String

SBO term identifying the type of the modifier

modifiers[].line

Object

line used to draw modifier connection

processCoordinates

Object

coordinates of process in the reaction if defined manually. If this value is not present then center of line should be taken.

line

Object

reaction central line

line.id

Number

line identifier

line.width

Number

line width

line.z

Number

line z coordinate (z-index)

line.segments

Array

line segments

line.startArrow

Object

arrow definition of the line beginning

line.endArrow

Object

arrow definition of the line ending

line.lineType

String

line pattern

line.color

String

line color; #RRGGBBAA string

products[].line.id

Number

line identifier

products[].line.width

Number

line width

products[].line.z

Number

line z coordinate (z-index)

products[].line.segments

Array

line segments

products[].line.startArrow

Object

arrow definition of the line beginning

products[].line.endArrow

Object

arrow definition of the line ending

products[].line.lineType

String

line pattern

products[].line.color

String

line color; #RRGGBBAA string

reactants[].line.id

Number

line identifier

reactants[].line.width

Number

line width

reactants[].line.z

Number

line z coordinate (z-index)

reactants[].line.segments

Array

line segments

reactants[].line.startArrow

Object

arrow definition of the line beginning

reactants[].line.endArrow

Object

arrow definition of the line ending

reactants[].line.lineType

String

line pattern

reactants[].line.color

String

line color; #RRGGBBAA string

modifiers[].line.id

Number

line identifier

modifiers[].line.width

Number

line width

modifiers[].line.z

Number

line z coordinate (z-index)

modifiers[].line.segments

Array

line segments

modifiers[].line.startArrow

Object

arrow definition of the line beginning

modifiers[].line.endArrow

Object

arrow definition of the line ending

modifiers[].line.lineType

String

line pattern

modifiers[].line.color

String

line color; #RRGGBBAA string

operators

Array

reaction operators

operators[].id

Number

operator identifier

operators[].line

Object

line for the operator

operators[].sboTerm

String

SBO term identifying the type of the operator

9.7. Sample Response

{
  "id" : 118,
  "notes" : "note",
  "idReaction" : "path_0_re5933",
  "name" : "re_nam12",
  "reversible" : false,
  "visibilityLevel" : "",
  "z" : 1,
  "kinetics" : {
    "parameters" : [ ],
    "functions" : [ ],
    "definition" : "<math xmlns=\"http://www.w3.org/1998/Math/MathML\"><lambda>\n<bvar>\n<ci> x </ci>\n</bvar>\n<bvar>\n<ci> y </ci>\n</bvar>\n<apply>\n<plus/>\n<ci> x </ci>\n<ci> y </ci>\n</apply>\n</lambda></math>"
  },
  "line" : {
    "id" : 1055,
    "width" : 1.0,
    "color" : "#000000ff",
    "z" : 0,
    "segments" : [ {
      "x1" : 0.0,
      "y1" : 0.0,
      "x2" : 10.0,
      "y2" : 0.0
    } ],
    "startArrow" : {
      "arrowType" : "NONE",
      "angle" : 2.748893571891069,
      "lineType" : "SOLID",
      "length" : 15.0
    },
    "endArrow" : {
      "arrowType" : "NONE",
      "angle" : 2.748893571891069,
      "lineType" : "SOLID",
      "length" : 15.0
    },
    "lineType" : "SOLID"
  },
  "processCoordinates" : {
    "x" : 10.0,
    "y" : 10.0
  },
  "modifiers" : [ {
    "id" : 826,
    "line" : {
      "id" : 1062,
      "width" : 1.0,
      "color" : "#000000ff",
      "z" : 0,
      "segments" : [ {
        "x1" : 10.0,
        "y1" : 0.0,
        "x2" : 0.0,
        "y2" : 0.0
      } ],
      "startArrow" : {
        "arrowType" : "NONE",
        "angle" : 2.748893571891069,
        "lineType" : "SOLID",
        "length" : 15.0
      },
      "endArrow" : {
        "arrowType" : "NONE",
        "angle" : 2.748893571891069,
        "lineType" : "SOLID",
        "length" : 15.0
      },
      "lineType" : "SOLID"
    },
    "stoichiometry" : null,
    "element" : 738,
    "sboTerm" : "SBO:0000013"
  } ],
  "elementId" : "path_0_re5933",
  "products" : [ {
    "id" : 824,
    "line" : {
      "id" : 1061,
      "width" : 1.0,
      "color" : "#000000ff",
      "z" : 0,
      "segments" : [ {
        "x1" : 15.0,
        "y1" : 0.0,
        "x2" : 30.0,
        "y2" : 0.0
      } ],
      "startArrow" : {
        "arrowType" : "NONE",
        "angle" : 2.748893571891069,
        "lineType" : "SOLID",
        "length" : 15.0
      },
      "endArrow" : {
        "arrowType" : "NONE",
        "angle" : 2.748893571891069,
        "lineType" : "SOLID",
        "length" : 15.0
      },
      "lineType" : "SOLID"
    },
    "stoichiometry" : null,
    "element" : 742
  }, {
    "id" : 825,
    "line" : {
      "id" : 1059,
      "width" : 1.0,
      "color" : "#000000ff",
      "z" : 0,
      "segments" : [ {
        "x1" : 15.0,
        "y1" : 0.0,
        "x2" : 20.0,
        "y2" : 0.0
      } ],
      "startArrow" : {
        "arrowType" : "NONE",
        "angle" : 2.748893571891069,
        "lineType" : "SOLID",
        "length" : 15.0
      },
      "endArrow" : {
        "arrowType" : "NONE",
        "angle" : 2.748893571891069,
        "lineType" : "SOLID",
        "length" : 15.0
      },
      "lineType" : "SOLID"
    },
    "stoichiometry" : null,
    "element" : 738
  } ],
  "reactants" : [ {
    "id" : 821,
    "line" : {
      "id" : 1058,
      "width" : 1.0,
      "color" : "#000000ff",
      "z" : 0,
      "segments" : [ {
        "x1" : 15.0,
        "y1" : 0.0,
        "x2" : 0.0,
        "y2" : 0.0
      } ],
      "startArrow" : {
        "arrowType" : "NONE",
        "angle" : 2.748893571891069,
        "lineType" : "SOLID",
        "length" : 15.0
      },
      "endArrow" : {
        "arrowType" : "NONE",
        "angle" : 2.748893571891069,
        "lineType" : "SOLID",
        "length" : 15.0
      },
      "lineType" : "SOLID"
    },
    "stoichiometry" : null,
    "element" : 742
  }, {
    "id" : 822,
    "line" : {
      "id" : 1056,
      "width" : 1.0,
      "color" : "#000000ff",
      "z" : 0,
      "segments" : [ {
        "x1" : 10.0,
        "y1" : 0.0,
        "x2" : 0.0,
        "y2" : 0.0
      } ],
      "startArrow" : {
        "arrowType" : "NONE",
        "angle" : 2.748893571891069,
        "lineType" : "SOLID",
        "length" : 15.0
      },
      "endArrow" : {
        "arrowType" : "NONE",
        "angle" : 2.748893571891069,
        "lineType" : "SOLID",
        "length" : 15.0
      },
      "lineType" : "SOLID"
    },
    "stoichiometry" : null,
    "element" : 738
  } ],
  "operators" : [ {
    "id" : 820,
    "line" : {
      "id" : 1057,
      "width" : 1.0,
      "color" : "#000000ff",
      "z" : 0,
      "segments" : [ {
        "x1" : 10.0,
        "y1" : 0.0,
        "x2" : 15.0,
        "y2" : 0.0
      } ],
      "startArrow" : {
        "arrowType" : "NONE",
        "angle" : 2.748893571891069,
        "lineType" : "SOLID",
        "length" : 15.0
      },
      "endArrow" : {
        "arrowType" : "NONE",
        "angle" : 2.748893571891069,
        "lineType" : "SOLID",
        "length" : 15.0
      },
      "lineType" : "SOLID"
    },
    "inputs" : [ {
      "id" : 821
    }, {
      "id" : 822
    } ],
    "outputs" : [ ],
    "operatorText" : "",
    "productOperator" : false,
    "modifierOperator" : false,
    "reactantOperator" : true,
    "sboTerm" : "SBO:0000173"
  }, {
    "id" : 823,
    "line" : {
      "id" : 1060,
      "width" : 1.0,
      "color" : "#000000ff",
      "z" : 0,
      "segments" : [ {
        "x1" : 10.0,
        "y1" : 0.0,
        "x2" : 15.0,
        "y2" : 0.0
      } ],
      "startArrow" : {
        "arrowType" : "NONE",
        "angle" : 2.748893571891069,
        "lineType" : "SOLID",
        "length" : 15.0
      },
      "endArrow" : {
        "arrowType" : "NONE",
        "angle" : 2.748893571891069,
        "lineType" : "SOLID",
        "length" : 15.0
      },
      "lineType" : "SOLID"
    },
    "inputs" : [ ],
    "outputs" : [ {
      "id" : 824
    }, {
      "id" : 825
    } ],
    "operatorText" : "",
    "productOperator" : true,
    "modifierOperator" : false,
    "reactantOperator" : false,
    "sboTerm" : "SBO:0000173"
  } ],
  "references" : [ {
    "link" : null,
    "article" : null,
    "type" : "PUBMED",
    "resource" : "28725475",
    "id" : 953,
    "annotator" : null
  }, {
    "link" : null,
    "article" : null,
    "type" : "PUBMED",
    "resource" : "invalid123",
    "id" : 954,
    "annotator" : null
  } ],
  "map" : 270,
  "sboTerm" : "SBO:0000185"
}

10. Delete reaction

Deletes the reaction together with everything attached to it: its reactants, products, modifiers, logic operators and all of their lines. The map elements that those reactants, products and modifiers pointed at remain on the map.

Note
Supports optimistic locking via the If-Match header.

10.1. HTTP request

DELETE /minerva/new_api/projects/test_project/maps/276/bio_entities/reactions/122 HTTP/1.1

10.2. Path Parameters

Table 5. /minerva/new_api/projects/{projectId}/maps/{mapId}/bio_entities/reactions/{reactionId}
Parameter Description

projectId

project identifier

mapId

map identifier

reactionId

reaction identifier

10.3. CURL sample

$ curl 'https://minerva-dev.lcsb.uni.lu/minerva/new_api/projects/test_project/maps/276/bio_entities/reactions/122' -X DELETE \
    -H 'Authorization: Bearer xxxxxxxx'

10.4. HTTP response

HTTP/1.1 200 OK

11. Get reaction line

Returns the line geometry and style for a reaction.

11.1. HTTP request

GET /minerva/new_api/projects/test_project/maps/282/bio_entities/reactions/125/line HTTP/1.1

11.2. Path Parameters

Table 6. /minerva/new_api/projects/{projectId}/maps/{mapId}/bio_entities/reactions/{reactionId}/line
Parameter Description

projectId

project identifier

mapId

map identifier

reactionId

reaction identifier

11.3. CURL sample

$ curl 'https://minerva-dev.lcsb.uni.lu/minerva/new_api/projects/test_project/maps/282/bio_entities/reactions/125/line' -X GET \
    -H 'Authorization: Bearer xxxxxxxx'

11.4. HTTP response

HTTP/1.1 200 OK

11.5. Response Fields

Path Type Description

id

Number

line identifier

width

Number

line width

z

Number

line z coordinate (z-index)

segments

Array

line segments

startArrow

Object

arrow definition of the line beginning

endArrow

Object

arrow definition of the line ending

lineType

String

line pattern

color

String

line color; #RRGGBBAA string

11.6. Sample Response

{
  "id" : 1110,
  "width" : 1.0,
  "color" : "#000000ff",
  "z" : 0,
  "segments" : [ {
    "x1" : 0.0,
    "y1" : 0.0,
    "x2" : 10.0,
    "y2" : 0.0
  } ],
  "startArrow" : {
    "arrowType" : "NONE",
    "angle" : 2.748893571891069,
    "lineType" : "SOLID",
    "length" : 15.0
  },
  "endArrow" : {
    "arrowType" : "NONE",
    "angle" : 2.748893571891069,
    "lineType" : "SOLID",
    "length" : 15.0
  },
  "lineType" : "SOLID"
}

12. Get reactant line

Returns the line geometry and style for a reactant connector within a reaction.

12.1. HTTP request

GET /minerva/new_api/projects/test_project/maps/358/bio_entities/reactions/163/reactants/1133/line HTTP/1.1

12.2. Path Parameters

Table 7. /minerva/new_api/projects/{projectId}/maps/{mapId}/bio_entities/reactions/{reactionId}/reactants/{reactantId}/line
Parameter Description

projectId

project identifier

mapId

map identifier

reactionId

reaction identifier

reactantId

reactant identifier

12.3. CURL sample

$ curl 'https://minerva-dev.lcsb.uni.lu/minerva/new_api/projects/test_project/maps/358/bio_entities/reactions/163/reactants/1133/line' -X GET \
    -H 'Authorization: Bearer xxxxxxxx'

12.4. HTTP response

HTTP/1.1 200 OK

12.5. Response Fields

Path Type Description

id

Number

line identifier

width

Number

line width

z

Number

line z coordinate (z-index)

segments

Array

line segments

startArrow

Object

arrow definition of the line beginning

endArrow

Object

arrow definition of the line ending

lineType

String

line pattern

color

String

line color; #RRGGBBAA string

12.6. Sample Response

{
  "id" : 1456,
  "width" : 1.0,
  "color" : "#000000ff",
  "z" : 0,
  "segments" : [ {
    "x1" : 10.0,
    "y1" : 0.0,
    "x2" : 0.0,
    "y2" : 0.0
  } ],
  "startArrow" : {
    "arrowType" : "NONE",
    "angle" : 2.748893571891069,
    "lineType" : "SOLID",
    "length" : 15.0
  },
  "endArrow" : {
    "arrowType" : "NONE",
    "angle" : 2.748893571891069,
    "lineType" : "SOLID",
    "length" : 15.0
  },
  "lineType" : "SOLID"
}

13. Update reactant line

Updates the line geometry and style for a reactant connector within a reaction.

Note
Supports optimistic locking via the If-Match header.

13.1. HTTP request

PUT /minerva/new_api/projects/test_project/maps/356/bio_entities/reactions/162/reactants/1126/line HTTP/1.1

13.2. Path Parameters

Table 8. /minerva/new_api/projects/{projectId}/maps/{mapId}/bio_entities/reactions/{reactionId}/reactants/{reactantId}/line
Parameter Description

projectId

project identifier

mapId

map identifier

reactionId

reaction identifier

reactantId

reactant identifier

13.3. Request Fields

Path Type Description

startArrow

Object

arrow at the start of the line. Object with: arrowType (one of: NONE, FULL, OPEN, BLANK, CIRCLE, CROSSBAR, DIAMOND, BLANK_CROSSBAR, FULL_CROSSBAR), length (number), angle (number)

endArrow

Object

arrow at the end of the line. Same structure as startArrow

segments

Array

list of line segments, each with x1, y1, x2, y2

width

Number

line width (minimum: 1)

z

Number

z-index of the line

color

String

line color; #RRGGBBAA string

lineType

String

line pattern, one of: SOLID, DASHED, DOTTED, DASH_DOT, DASH_DOT_DOT

13.4. CURL sample

$ curl 'https://minerva-dev.lcsb.uni.lu/minerva/new_api/projects/test_project/maps/356/bio_entities/reactions/162/reactants/1126/line' -X PUT \
    -H 'Authorization: Bearer xxxxxxxx' \
    -d '{"startArrow":{"arrowType":"NONE","angle":2.748893571891069,"lineType":"SOLID","length":15.0},"endArrow":{"arrowType":"NONE","angle":2.748893571891069,"lineType":"SOLID","length":15.0},"segments":[{"x1":1.0,"y1":2.0,"x2":12.0,"y2":23.0}],"width":2.0,"z":97,"color":"#ffff00ff","lineType":"DOTTED"}' \
    -H 'Content-Type: application/json'

13.5. HTTP response

HTTP/1.1 200 OK

13.6. Response Fields

Path Type Description

id

Number

line identifier

width

Number

line width

z

Number

line z coordinate (z-index)

segments

Array

line segments

startArrow

Object

arrow definition of the line beginning

endArrow

Object

arrow definition of the line ending

lineType

String

line pattern

color

String

line color; #RRGGBBAA string

13.7. Sample Response

{
  "id" : 1447,
  "width" : 2.0,
  "color" : "#ffff00ff",
  "z" : 97,
  "segments" : [ {
    "x1" : 1.0,
    "y1" : 2.0,
    "x2" : 12.0,
    "y2" : 23.0
  } ],
  "startArrow" : {
    "arrowType" : "NONE",
    "angle" : 2.748893571891069,
    "lineType" : "SOLID",
    "length" : 15.0
  },
  "endArrow" : {
    "arrowType" : "NONE",
    "angle" : 2.748893571891069,
    "lineType" : "SOLID",
    "length" : 15.0
  },
  "lineType" : "DOTTED"
}

14. Get product line

Returns the line geometry and style for a product connector within a reaction.

14.1. HTTP request

GET /minerva/new_api/projects/test_project/maps/350/bio_entities/reactions/159/products/1108/line HTTP/1.1

14.2. Path Parameters

Table 9. /minerva/new_api/projects/{projectId}/maps/{mapId}/bio_entities/reactions/{reactionId}/products/{productId}/line
Parameter Description

projectId

project identifier

mapId

map identifier

reactionId

reaction identifier

productId

product identifier

14.3. CURL sample

$ curl 'https://minerva-dev.lcsb.uni.lu/minerva/new_api/projects/test_project/maps/350/bio_entities/reactions/159/products/1108/line' -X GET \
    -H 'Authorization: Bearer xxxxxxxx'

14.4. HTTP response

HTTP/1.1 200 OK

14.5. Response Fields

Path Type Description

id

Number

line identifier

width

Number

line width

z

Number

line z coordinate (z-index)

segments

Array

line segments

startArrow

Object

arrow definition of the line beginning

endArrow

Object

arrow definition of the line ending

lineType

String

line pattern

color

String

line color; #RRGGBBAA string

14.6. Sample Response

{
  "id" : 1423,
  "width" : 1.0,
  "color" : "#000000ff",
  "z" : 0,
  "segments" : [ {
    "x1" : 15.0,
    "y1" : 0.0,
    "x2" : 20.0,
    "y2" : 0.0
  } ],
  "startArrow" : {
    "arrowType" : "NONE",
    "angle" : 2.748893571891069,
    "lineType" : "SOLID",
    "length" : 15.0
  },
  "endArrow" : {
    "arrowType" : "NONE",
    "angle" : 2.748893571891069,
    "lineType" : "SOLID",
    "length" : 15.0
  },
  "lineType" : "SOLID"
}

15. Update product line

Updates the line geometry and style for a product connector within a reaction.

Note
Supports optimistic locking via the If-Match header.

15.1. HTTP request

PUT /minerva/new_api/projects/test_project/maps/348/bio_entities/reactions/158/products/1101/line HTTP/1.1

15.2. Path Parameters

Table 10. /minerva/new_api/projects/{projectId}/maps/{mapId}/bio_entities/reactions/{reactionId}/products/{productId}/line
Parameter Description

projectId

project identifier

mapId

map identifier

reactionId

reaction identifier

productId

product identifier

15.3. Request Fields

Path Type Description

startArrow

Object

arrow at the start of the line. Object with: arrowType (one of: NONE, FULL, OPEN, BLANK, CIRCLE, CROSSBAR, DIAMOND, BLANK_CROSSBAR, FULL_CROSSBAR), length (number), angle (number)

endArrow

Object

arrow at the end of the line. Same structure as startArrow

segments

Array

list of line segments, each with x1, y1, x2, y2

width

Number

line width (minimum: 1)

z

Number

z-index of the line

color

String

line color; #RRGGBBAA string

lineType

String

line pattern, one of: SOLID, DASHED, DOTTED, DASH_DOT, DASH_DOT_DOT

15.4. CURL sample

$ curl 'https://minerva-dev.lcsb.uni.lu/minerva/new_api/projects/test_project/maps/348/bio_entities/reactions/158/products/1101/line' -X PUT \
    -H 'Authorization: Bearer xxxxxxxx' \
    -d '{"startArrow":{"arrowType":"NONE","angle":2.748893571891069,"lineType":"SOLID","length":15.0},"endArrow":{"arrowType":"NONE","angle":2.748893571891069,"lineType":"SOLID","length":15.0},"segments":[{"x1":1.0,"y1":2.0,"x2":12.0,"y2":23.0}],"width":2.0,"z":76,"color":"#ffff00ff","lineType":"DOTTED"}' \
    -H 'Content-Type: application/json'

15.5. HTTP response

HTTP/1.1 200 OK

15.6. Response Fields

Path Type Description

id

Number

line identifier

width

Number

line width

z

Number

line z coordinate (z-index)

segments

Array

line segments

startArrow

Object

arrow definition of the line beginning

endArrow

Object

arrow definition of the line ending

lineType

String

line pattern

color

String

line color; #RRGGBBAA string

15.7. Sample Response

{
  "id" : 1414,
  "width" : 2.0,
  "color" : "#ffff00ff",
  "z" : 76,
  "segments" : [ {
    "x1" : 1.0,
    "y1" : 2.0,
    "x2" : 12.0,
    "y2" : 23.0
  } ],
  "startArrow" : {
    "arrowType" : "NONE",
    "angle" : 2.748893571891069,
    "lineType" : "SOLID",
    "length" : 15.0
  },
  "endArrow" : {
    "arrowType" : "NONE",
    "angle" : 2.748893571891069,
    "lineType" : "SOLID",
    "length" : 15.0
  },
  "lineType" : "DOTTED"
}

16. Get modifier line

Returns the line geometry and style for a modifier connector within a reaction.

16.1. HTTP request

GET /minerva/new_api/projects/test_project/maps/302/bio_entities/reactions/135/modifiers/939/line HTTP/1.1

16.2. Path Parameters

Table 11. /minerva/new_api/projects/{projectId}/maps/{mapId}/bio_entities/reactions/{reactionId}/modifiers/{modifierId}/line
Parameter Description

projectId

project identifier

mapId

map identifier

reactionId

reaction identifier

modifierId

modifier identifier

16.3. CURL sample

$ curl 'https://minerva-dev.lcsb.uni.lu/minerva/new_api/projects/test_project/maps/302/bio_entities/reactions/135/modifiers/939/line' -X GET \
    -H 'Authorization: Bearer xxxxxxxx'

16.4. HTTP response

HTTP/1.1 200 OK

16.5. Response Fields

Path Type Description

id

Number

line identifier

width

Number

line width

z

Number

line z coordinate (z-index)

segments

Array

line segments

startArrow

Object

arrow definition of the line beginning

endArrow

Object

arrow definition of the line ending

lineType

String

line pattern

color

String

line color; #RRGGBBAA string

16.6. Sample Response

{
  "id" : 1208,
  "width" : 1.0,
  "color" : "#000000ff",
  "z" : 0,
  "segments" : [ {
    "x1" : 10.0,
    "y1" : 0.0,
    "x2" : 0.0,
    "y2" : 0.0
  } ],
  "startArrow" : {
    "arrowType" : "NONE",
    "angle" : 2.748893571891069,
    "lineType" : "SOLID",
    "length" : 15.0
  },
  "endArrow" : {
    "arrowType" : "NONE",
    "angle" : 2.748893571891069,
    "lineType" : "SOLID",
    "length" : 15.0
  },
  "lineType" : "SOLID"
}

17. Update modifier line

Updates the line geometry and style for a modifier connector within a reaction.

Note
Supports optimistic locking via the If-Match header.

17.1. HTTP request

PUT /minerva/new_api/projects/test_project/maps/300/bio_entities/reactions/134/modifiers/932/line HTTP/1.1

17.2. Path Parameters

Table 12. /minerva/new_api/projects/{projectId}/maps/{mapId}/bio_entities/reactions/{reactionId}/modifiers/{modifierId}/line
Parameter Description

projectId

project identifier

mapId

map identifier

reactionId

reaction identifier

modifierId

modifier identifier

17.3. Request Fields

Path Type Description

startArrow

Object

arrow at the start of the line. Object with: arrowType (one of: NONE, FULL, OPEN, BLANK, CIRCLE, CROSSBAR, DIAMOND, BLANK_CROSSBAR, FULL_CROSSBAR), length (number), angle (number)

endArrow

Object

arrow at the end of the line. Same structure as startArrow

segments

Array

list of line segments, each with x1, y1, x2, y2

width

Number

line width (minimum: 1)

z

Number

z-index of the line

color

String

line color; #RRGGBBAA string

lineType

String

line pattern, one of: SOLID, DASHED, DOTTED, DASH_DOT, DASH_DOT_DOT

17.4. CURL sample

$ curl 'https://minerva-dev.lcsb.uni.lu/minerva/new_api/projects/test_project/maps/300/bio_entities/reactions/134/modifiers/932/line' -X PUT \
    -H 'Authorization: Bearer xxxxxxxx' \
    -d '{"startArrow":{"arrowType":"NONE","angle":2.748893571891069,"lineType":"SOLID","length":15.0},"endArrow":{"arrowType":"NONE","angle":2.748893571891069,"lineType":"SOLID","length":15.0},"segments":[{"x1":1.0,"y1":2.0,"x2":12.0,"y2":23.0}],"width":2.0,"z":37,"color":"#ffff00ff","lineType":"DOTTED"}' \
    -H 'Content-Type: application/json'

17.5. HTTP response

HTTP/1.1 200 OK

17.6. Response Fields

Path Type Description

id

Number

line identifier

width

Number

line width

z

Number

line z coordinate (z-index)

segments

Array

line segments

startArrow

Object

arrow definition of the line beginning

endArrow

Object

arrow definition of the line ending

lineType

String

line pattern

color

String

line color; #RRGGBBAA string

17.7. Sample Response

{
  "id" : 1199,
  "width" : 2.0,
  "color" : "#ffff00ff",
  "z" : 37,
  "segments" : [ {
    "x1" : 1.0,
    "y1" : 2.0,
    "x2" : 12.0,
    "y2" : 23.0
  } ],
  "startArrow" : {
    "arrowType" : "NONE",
    "angle" : 2.748893571891069,
    "lineType" : "SOLID",
    "length" : 15.0
  },
  "endArrow" : {
    "arrowType" : "NONE",
    "angle" : 2.748893571891069,
    "lineType" : "SOLID",
    "length" : 15.0
  },
  "lineType" : "DOTTED"
}

18. Get operator line

Returns the line geometry and style for an operator connector within a reaction.

18.1. HTTP request

GET /minerva/new_api/projects/test_project/maps/324/bio_entities/reactions/146/operators/1014/line HTTP/1.1

18.2. Path Parameters

Table 13. /minerva/new_api/projects/{projectId}/maps/{mapId}/bio_entities/reactions/{reactionId}/operators/{operatorId}/line
Parameter Description

projectId

project identifier

mapId

map identifier

reactionId

reaction identifier

operatorId

operator identifier

18.3. CURL sample

$ curl 'https://minerva-dev.lcsb.uni.lu/minerva/new_api/projects/test_project/maps/324/bio_entities/reactions/146/operators/1014/line' -X GET \
    -H 'Authorization: Bearer xxxxxxxx'

18.4. HTTP response

HTTP/1.1 200 OK

18.5. Response Fields

Path Type Description

id

Number

line identifier

width

Number

line width

z

Number

line z coordinate (z-index)

segments

Array

line segments

startArrow

Object

arrow definition of the line beginning

endArrow

Object

arrow definition of the line ending

lineType

String

line pattern

color

String

line color; #RRGGBBAA string

18.6. Sample Response

{
  "id" : 1306,
  "width" : 1.0,
  "color" : "#000000ff",
  "z" : 0,
  "segments" : [ {
    "x1" : 10.0,
    "y1" : 0.0,
    "x2" : 15.0,
    "y2" : 0.0
  } ],
  "startArrow" : {
    "arrowType" : "NONE",
    "angle" : 2.748893571891069,
    "lineType" : "SOLID",
    "length" : 15.0
  },
  "endArrow" : {
    "arrowType" : "NONE",
    "angle" : 2.748893571891069,
    "lineType" : "SOLID",
    "length" : 15.0
  },
  "lineType" : "SOLID"
}

19. Update operator line

Updates the line geometry and style for an operator connector within a reaction.

Note
Supports optimistic locking via the If-Match header.

19.1. HTTP request

PUT /minerva/new_api/projects/test_project/maps/322/bio_entities/reactions/145/operators/1007/line HTTP/1.1

19.2. Path Parameters

Table 14. /minerva/new_api/projects/{projectId}/maps/{mapId}/bio_entities/reactions/{reactionId}/operators/{operatorId}/line
Parameter Description

projectId

project identifier

mapId

map identifier

reactionId

reaction identifier

operatorId

operator identifier

19.3. Request Fields

Path Type Description

startArrow

Object

arrow at the start of the line. Object with: arrowType (one of: NONE, FULL, OPEN, BLANK, CIRCLE, CROSSBAR, DIAMOND, BLANK_CROSSBAR, FULL_CROSSBAR), length (number), angle (number)

endArrow

Object

arrow at the end of the line. Same structure as startArrow

segments

Array

list of line segments, each with x1, y1, x2, y2

width

Number

line width (minimum: 1)

z

Number

z-index of the line

color

String

line color; #RRGGBBAA string

lineType

String

line pattern, one of: SOLID, DASHED, DOTTED, DASH_DOT, DASH_DOT_DOT

19.4. CURL sample

$ curl 'https://minerva-dev.lcsb.uni.lu/minerva/new_api/projects/test_project/maps/322/bio_entities/reactions/145/operators/1007/line' -X PUT \
    -H 'Authorization: Bearer xxxxxxxx' \
    -d '{"startArrow":{"arrowType":"NONE","angle":2.748893571891069,"lineType":"SOLID","length":15.0},"endArrow":{"arrowType":"NONE","angle":2.748893571891069,"lineType":"SOLID","length":15.0},"segments":[{"x1":1.0,"y1":2.0,"x2":12.0,"y2":23.0}],"width":2.0,"z":50,"color":"#ffff00ff","lineType":"DOTTED"}' \
    -H 'Content-Type: application/json'

19.5. HTTP response

HTTP/1.1 200 OK

19.6. Response Fields

Path Type Description

id

Number

line identifier

width

Number

line width

z

Number

line z coordinate (z-index)

segments

Array

line segments

startArrow

Object

arrow definition of the line beginning

endArrow

Object

arrow definition of the line ending

lineType

String

line pattern

color

String

line color; #RRGGBBAA string

19.7. Sample Response

{
  "id" : 1297,
  "width" : 2.0,
  "color" : "#ffff00ff",
  "z" : 50,
  "segments" : [ {
    "x1" : 1.0,
    "y1" : 2.0,
    "x2" : 12.0,
    "y2" : 23.0
  } ],
  "startArrow" : {
    "arrowType" : "NONE",
    "angle" : 2.748893571891069,
    "lineType" : "SOLID",
    "length" : 15.0
  },
  "endArrow" : {
    "arrowType" : "NONE",
    "angle" : 2.748893571891069,
    "lineType" : "SOLID",
    "length" : 15.0
  },
  "lineType" : "DOTTED"
}

20. Export reactions to CSV

Exports reactions matching the request to a CSV file.

20.1. HTTP request

POST /minerva/new_api/projects/test_project/maps/*/bio_entities/reactions:download_csv HTTP/1.1

20.2. Path Parameters

Table 15. /minerva/new_api/projects/{projectId}/maps/{mapId}/bio_entities/reactions:download_csv
Parameter Description

projectId

project identifier

mapId

map identifier

20.3. Request Fields

Path Type Description

elementTypes

Array

list of element types

reactionTypes

Array

list of reaction types

submaps

Array

list of map identifiers

includedCompartmentIds

Array

list of compartment identifiers where at least one participant should be present

columns

Array

list of columns that should be returned in csv

annotations

Array

list of annotations that should be returned in csv

excludedCompartmentIds

Array

list of compartment identifiers where all participant should not be present

20.4. CURL sample

$ curl 'https://minerva-dev.lcsb.uni.lu/minerva/new_api/projects/test_project/maps/*/bio_entities/reactions:download_csv' -X POST \
    -d '{"elementTypes":["Simple molecule"],"reactionTypes":["Process description"],"submaps":[284],"columns":["id","modelId"],"annotations":["PUBMED"],"includedCompartmentIds":[783],"excludedCompartmentIds":[]}' \
    -H 'Content-Type: application/json'

20.5. HTTP response

HTTP/1.1 200 OK

20.6. Sample Response

id,modelId,PUBMED
126,284,28725475;invalid123

21. Update reaction line

Updates the line geometry and style for a reaction.

Note
Supports optimistic locking via the If-Match header.

21.1. HTTP request

PUT /minerva/new_api/projects/test_project/maps/280/bio_entities/reactions/124/line HTTP/1.1

21.2. Path Parameters

Table 16. /minerva/new_api/projects/{projectId}/maps/{mapId}/bio_entities/reactions/{reactionId}/line
Parameter Description

projectId

project identifier

mapId

map identifier

reactionId

reaction identifier

21.3. Request Fields

Path Type Description

startArrow

Object

arrow at the start of the line. Object with: arrowType (one of: NONE, FULL, OPEN, BLANK, CIRCLE, CROSSBAR, DIAMOND, BLANK_CROSSBAR, FULL_CROSSBAR), length (number), angle (number)

endArrow

Object

arrow at the end of the line. Same structure as startArrow

segments

Array

list of line segments, each with x1, y1, x2, y2

width

Number

line width (minimum: 1)

z

Number

z-index of the line

color

String

line color; #RRGGBBAA string

lineType

String

line pattern, one of: SOLID, DASHED, DOTTED, DASH_DOT, DASH_DOT_DOT

21.4. CURL sample

$ curl 'https://minerva-dev.lcsb.uni.lu/minerva/new_api/projects/test_project/maps/280/bio_entities/reactions/124/line' -X PUT \
    -H 'Authorization: Bearer xxxxxxxx' \
    -d '{"startArrow":{"arrowType":"NONE","angle":2.748893571891069,"lineType":"SOLID","length":15.0},"endArrow":{"arrowType":"NONE","angle":2.748893571891069,"lineType":"SOLID","length":15.0},"segments":[{"x1":1.0,"y1":2.0,"x2":12.0,"y2":23.0}],"width":2.0,"z":76,"color":"#ffff00ff","lineType":"DOTTED"}' \
    -H 'Content-Type: application/json'

21.5. HTTP response

HTTP/1.1 200 OK

21.6. Response Fields

Path Type Description

id

Number

line identifier

width

Number

line width

z

Number

line z coordinate (z-index)

segments

Array

line segments

startArrow

Object

arrow definition of the line beginning

endArrow

Object

arrow definition of the line ending

lineType

String

line pattern

color

String

line color; #RRGGBBAA string

21.7. Sample Response

{
  "id" : 1101,
  "width" : 2.0,
  "color" : "#ffff00ff",
  "z" : 76,
  "segments" : [ {
    "x1" : 1.0,
    "y1" : 2.0,
    "x2" : 12.0,
    "y2" : 23.0
  } ],
  "startArrow" : {
    "arrowType" : "NONE",
    "angle" : 2.748893571891069,
    "lineType" : "SOLID",
    "length" : 15.0
  },
  "endArrow" : {
    "arrowType" : "NONE",
    "angle" : 2.748893571891069,
    "lineType" : "SOLID",
    "length" : 15.0
  },
  "lineType" : "DOTTED"
}