Rest New API Documentation - Operator inputs

1. List inputs

Returns a page of inputs of the operator.

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

1.1. HTTP request

GET /minerva/new_api/projects/test_project/maps/314/bio_entities/reactions/141/operators/976/inputs/ HTTP/1.1

1.2. Path Parameters

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

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

1.4. CURL sample

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

1.5. HTTP response

HTTP/1.1 200 OK

1.6. Sample Response

{
  "content" : [ {
    "id" : 977,
    "line" : {
      "id" : 1259,
      "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" : 871
  }, {
    "id" : 978,
    "line" : {
      "id" : 1257,
      "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" : 870
  } ],
  "totalPages" : 1,
  "totalElements" : 2,
  "numberOfElements" : 2,
  "size" : 20,
  "number" : 0
}

2. Get input

Returns a single input of the operator.

2.1. HTTP request

GET /minerva/new_api/projects/test_project/maps/320/bio_entities/reactions/144/operators/997/inputs/999 HTTP/1.1

2.2. Path Parameters

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

2.3. CURL sample

$ curl 'https://minerva-dev.lcsb.uni.lu/minerva/new_api/projects/test_project/maps/320/bio_entities/reactions/144/operators/997/inputs/999' -X GET \
    -H 'Authorization: Bearer xxxxxxxx'

2.4. HTTP response

HTTP/1.1 200 OK

2.5. Sample Response

{
  "id" : 999,
  "line" : {
    "id" : 1284,
    "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" : 890
}

3. Add input

Adds an input to the operator.

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

3.1. HTTP request

POST /minerva/new_api/projects/test_project/maps/318/bio_entities/reactions/143/operators/990/inputs/ HTTP/1.1

3.2. Path Parameters

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

3.3. Request Fields

Path Type Description

Path	Type	Description
`id`	`Number`	identifier of the referenced entity

id

Number

identifier of the referenced entity

3.4. CURL sample

$ curl 'https://minerva-dev.lcsb.uni.lu/minerva/new_api/projects/test_project/maps/318/bio_entities/reactions/143/operators/990/inputs/' -X POST \
    -H 'Authorization: Bearer xxxxxxxx' \
    -d '{"id":995}' \
    -H 'Content-Type: application/json'

3.5. HTTP response

HTTP/1.1 201 Created

3.6. Sample Response

{
  "id" : 995,
  "line" : {
    "id" : 1278,
    "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" : 884
}

4. Delete input

Removes an input from the operator.

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

4.1. HTTP request

DELETE /minerva/new_api/projects/test_project/maps/316/bio_entities/reactions/142/operators/983/inputs/985 HTTP/1.1

4.2. Path Parameters

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

4.3. CURL sample

$ curl 'https://minerva-dev.lcsb.uni.lu/minerva/new_api/projects/test_project/maps/316/bio_entities/reactions/142/operators/983/inputs/985' -X DELETE \
    -H 'Authorization: Bearer xxxxxxxx'

4.4. HTTP response

HTTP/1.1 200 OK