Rest New API Documentation - Reaction modifiers

Modifiers of a reaction, served from /new_api/projects/{projectId}/maps/{mapId}/bio_entities/reactions/{reactionId}/modifiers. Every modifier points at an element of the map; the element it points at can be read and replaced through its element sub-resource.

1. Modifier element

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

2. List modifiers

Returns a page of modifiers of the reaction.

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

2.1. HTTP request

GET /minerva/new_api/projects/test_project/maps/286/bio_entities/reactions/127/modifiers/ HTTP/1.1

2.2. Path Parameters

Table 1. /minerva/new_api/projects/{projectId}/maps/{mapId}/bio_entities/reactions/{reactionId}/modifiers/
Parameter	Description
`projectId`	project identifier
`mapId`	map identifier
`reactionId`	reaction identifier

2.3. Query Parameters

Parameter Description

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

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

2.4. CURL sample

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

2.5. HTTP response

HTTP/1.1 200 OK

2.6. Sample Response

{
  "content" : [ {
    "id" : 882,
    "line" : {
      "id" : 1135,
      "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" : 786,
    "sboTerm" : "SBO:0000013"
  } ],
  "totalPages" : 1,
  "totalElements" : 1,
  "numberOfElements" : 1,
  "size" : 20,
  "number" : 0
}

3. Get modifier

Returns a single modifier of the reaction.

3.1. HTTP request

GET /minerva/new_api/projects/test_project/maps/294/bio_entities/reactions/131/modifiers/911 HTTP/1.1

3.2. Path Parameters

Table 2. /minerva/new_api/projects/{projectId}/maps/{mapId}/bio_entities/reactions/{reactionId}/modifiers/{modifierId}
Parameter	Description
`projectId`	project identifier
`mapId`	map identifier
`reactionId`	reaction identifier
`modifierId`	modifier identifier

3.3. CURL sample

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

3.4. HTTP response

HTTP/1.1 200 OK

3.5. Sample Response

{
  "id" : 911,
  "line" : {
    "id" : 1172,
    "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" : 811,
  "sboTerm" : "SBO:0000013"
}

4. Add modifier

The request body points at the map element acting as regulator (element) and states the kind of regulation in sboTerm (catalyst, inhibitor, trigger, …), together with the stoichiometry. The modifier is created with an empty connector line, which can be shaped afterwards through the modifier line resource.

4.1. HTTP request

POST /minerva/new_api/projects/test_project/maps/290/bio_entities/reactions/129/modifiers/ HTTP/1.1

4.2. Path Parameters

Table 3. /minerva/new_api/projects/{projectId}/maps/{mapId}/bio_entities/reactions/{reactionId}/modifiers/
Parameter	Description
`projectId`	project identifier
`mapId`	map identifier
`reactionId`	reaction identifier

4.3. CURL sample

$ curl 'https://minerva-dev.lcsb.uni.lu/minerva/new_api/projects/test_project/maps/290/bio_entities/reactions/129/modifiers/' -X POST \
    -H 'Authorization: Bearer xxxxxxxx' \
    -d '{"stoichiometry":3.0,"element":{"id":800},"sboTerm":"SBO:0000013"}' \
    -H 'Content-Type: application/json'

4.4. HTTP response

HTTP/1.1 201 Created

4.5. Sample Response

{
  "id" : 897,
  "line" : {
    "id" : 1154,
    "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"
  },
  "stoichiometry" : 3.0,
  "element" : 800,
  "sboTerm" : "SBO:0000013"
}

5. Update modifier

Updates a modifier of the reaction.

Note	Supports optimistic locking via the `If-Match` header.

5.1. HTTP request

PUT /minerva/new_api/projects/test_project/maps/288/bio_entities/reactions/128/modifiers/889 HTTP/1.1

5.2. Path Parameters

Table 4. /minerva/new_api/projects/{projectId}/maps/{mapId}/bio_entities/reactions/{reactionId}/modifiers/{modifierId}
Parameter	Description
`projectId`	project identifier
`mapId`	map identifier
`reactionId`	reaction identifier
`modifierId`	modifier identifier

5.3. CURL sample

$ curl 'https://minerva-dev.lcsb.uni.lu/minerva/new_api/projects/test_project/maps/288/bio_entities/reactions/128/modifiers/889' -X PUT \
    -H 'Authorization: Bearer xxxxxxxx' \
    -d '{"stoichiometry":3.0,"element":{"id":793},"sboTerm":"SBO:0000013"}' \
    -H 'Content-Type: application/json'

5.4. HTTP response

HTTP/1.1 200 OK

5.5. Sample Response

{
  "id" : 889,
  "line" : {
    "id" : 1144,
    "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" : 3.0,
  "element" : 793,
  "sboTerm" : "SBO:0000013"
}

6. Delete modifier

Removes a modifier from the reaction.

Note	Supports optimistic locking via the `If-Match` header.

6.1. HTTP request

DELETE /minerva/new_api/projects/test_project/maps/292/bio_entities/reactions/130/modifiers/904 HTTP/1.1

6.2. Path Parameters

Table 5. /minerva/new_api/projects/{projectId}/maps/{mapId}/bio_entities/reactions/{reactionId}/modifiers/{modifierId}
Parameter	Description
`projectId`	project identifier
`mapId`	map identifier
`reactionId`	reaction identifier
`modifierId`	modifier identifier

6.3. CURL sample

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

6.4. HTTP response

HTTP/1.1 200 OK