Rest New API Documentation - Reaction operators

Logic operators (AND, OR, …) of a reaction, served from /new_api/projects/{projectId}/maps/{mapId}/bio_entities/reactions/{reactionId}/operators. Operators join reactants and products of a reaction; their inputs and outputs are managed through separate sub-resources.

1. Operator inputs

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

2. Operator outputs

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

3. List operators

Returns a page of operators of the reaction.

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

3.1. HTTP request

GET /minerva/new_api/projects/test_project/maps/310/bio_entities/reactions/139/operators/ HTTP/1.1

3.2. Path Parameters

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

3.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

3.4. CURL sample

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

3.5. HTTP response

HTTP/1.1 200 OK

3.6. Sample Response

{
  "content" : [ {
    "id" : 962,
    "line" : {
      "id" : 1240,
      "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" : 963
    }, {
      "id" : 964
    } ],
    "outputs" : [ ],
    "operatorText" : "",
    "productOperator" : false,
    "modifierOperator" : false,
    "reactantOperator" : true,
    "sboTerm" : "SBO:0000173"
  }, {
    "id" : 965,
    "line" : {
      "id" : 1243,
      "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" : 966
    }, {
      "id" : 967
    } ],
    "operatorText" : "",
    "productOperator" : true,
    "modifierOperator" : false,
    "reactantOperator" : false,
    "sboTerm" : "SBO:0000173"
  } ],
  "totalPages" : 1,
  "totalElements" : 2,
  "numberOfElements" : 2,
  "size" : 20,
  "number" : 0
}

4. Get operator

Returns a single operator of the reaction.

4.1. HTTP request

GET /minerva/new_api/projects/test_project/maps/312/bio_entities/reactions/140/operators/972 HTTP/1.1

4.2. Path Parameters

Table 2. /minerva/new_api/projects/{projectId}/maps/{mapId}/bio_entities/reactions/{reactionId}/operators/{operatorId}
Parameter	Description
`projectId`	project identifier
`mapId`	map identifier
`reactionId`	reaction identifier
`operatorId`	operator identifier

4.3. CURL sample

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

4.4. HTTP response

HTTP/1.1 200 OK

4.5. Sample Response

{
  "id" : 972,
  "line" : {
    "id" : 1252,
    "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" : 973
  }, {
    "id" : 974
  } ],
  "operatorText" : "",
  "productOperator" : true,
  "modifierOperator" : false,
  "reactantOperator" : false,
  "sboTerm" : "SBO:0000173"
}

5. Add operator

Adds an operator to the reaction.

5.1. HTTP request

POST /minerva/new_api/projects/test_project/maps/306/bio_entities/reactions/137/operators/ HTTP/1.1

5.2. Path Parameters

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

5.3. CURL sample

$ curl 'https://minerva-dev.lcsb.uni.lu/minerva/new_api/projects/test_project/maps/306/bio_entities/reactions/137/operators/' -X POST \
    -H 'Authorization: Bearer xxxxxxxx' \
    -d '{"sboTerm":"SBO:0000173"}' \
    -H 'Content-Type: application/json'

5.4. HTTP response

HTTP/1.1 201 Created

5.5. Sample Response

{
  "id" : 954,
  "line" : {
    "id" : 1227,
    "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"
  },
  "inputs" : [ ],
  "outputs" : [ ],
  "operatorText" : "",
  "productOperator" : false,
  "modifierOperator" : false,
  "reactantOperator" : false,
  "sboTerm" : "SBO:0000173"
}

6. Update operator

Updates an operator of the reaction.

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

6.1. HTTP request

PUT /minerva/new_api/projects/test_project/maps/304/bio_entities/reactions/136/operators/943 HTTP/1.1

6.2. Path Parameters

Table 4. /minerva/new_api/projects/{projectId}/maps/{mapId}/bio_entities/reactions/{reactionId}/operators/{operatorId}
Parameter	Description
`projectId`	project identifier
`mapId`	map identifier
`reactionId`	reaction identifier
`operatorId`	operator identifier

6.3. CURL sample

$ curl 'https://minerva-dev.lcsb.uni.lu/minerva/new_api/projects/test_project/maps/304/bio_entities/reactions/136/operators/943' -X PUT \
    -H 'Authorization: Bearer xxxxxxxx' \
    -d '{"sboTerm":"SBO:0000173"}' \
    -H 'Content-Type: application/json'

6.4. HTTP response

HTTP/1.1 200 OK

6.5. Sample Response

{
  "id" : 943,
  "line" : {
    "id" : 1215,
    "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" : 944
  }, {
    "id" : 945
  } ],
  "operatorText" : "",
  "productOperator" : true,
  "modifierOperator" : false,
  "reactantOperator" : false,
  "sboTerm" : "SBO:0000173"
}

7. Delete operator

Removes an operator from the reaction.

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

7.1. HTTP request

DELETE /minerva/new_api/projects/test_project/maps/308/bio_entities/reactions/138/operators/958 HTTP/1.1

7.2. Path Parameters

Table 5. /minerva/new_api/projects/{projectId}/maps/{mapId}/bio_entities/reactions/{reactionId}/operators/{operatorId}
Parameter	Description
`projectId`	project identifier
`mapId`	map identifier
`reactionId`	reaction identifier
`operatorId`	operator identifier

7.3. CURL sample

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

7.4. HTTP response

HTTP/1.1 200 OK