Rest New API Documentation - Map SBML parameters

Global parameters of the map, taken from the parameter elements of the SBML file it was created from. Every parameter has a value and a unit chosen from the units defined at the map level. The endpoints are served from /new_api/projects/{projectId}/maps/{mapId}/parameters.

1. List parameters

Returns all parameters of the map.

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/166/parameters/ HTTP/1.1

1.2. Path Parameters

Table 1. /minerva/new_api/projects/{projectId}/maps/{mapId}/parameters/
Parameter	Description
`projectId`	project identifier
`mapId`	map 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/166/parameters/' -X GET \
    -H 'Authorization: Bearer xxxxxxxx'

1.5. HTTP response

HTTP/1.1 200 OK

1.6. Sample Response

{
  "content" : [ {
    "id" : 68,
    "parameterId" : "parameter1",
    "name" : "D coefficient",
    "value" : 1.0,
    "units" : null,
    "elementId" : "parameter1"
  } ],
  "totalPages" : 1,
  "totalElements" : 1,
  "numberOfElements" : 1,
  "size" : 20,
  "number" : 0
}

2. Get parameter

Returns a single parameter of the map.

2.1. HTTP request

GET /minerva/new_api/projects/test_project/maps/160/parameters/65 HTTP/1.1

2.2. Path Parameters

Table 2. /minerva/new_api/projects/{projectId}/maps/{mapId}/parameters/{parameterId}
Parameter	Description
`projectId`	project identifier
`mapId`	map identifier
`parameterId`	parameter identifier

2.3. CURL sample

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

2.4. HTTP response

HTTP/1.1 200 OK

2.5. Sample Response

{
  "id" : 65,
  "parameterId" : "parameter1",
  "name" : "D coefficient",
  "value" : 1.0,
  "units" : null,
  "elementId" : "parameter1"
}

3. Add parameter

Creates a new parameter in the map. The unitId must point to a unit that already exists in the map.

3.1. HTTP request

POST /minerva/new_api/projects/test_project/maps/158/parameters/ HTTP/1.1

3.2. Path Parameters

Table 3. /minerva/new_api/projects/{projectId}/maps/{mapId}/parameters/
Parameter	Description
`projectId`	project identifier
`mapId`	map identifier

3.3. Request Fields

Path Type Description

Path	Type	Description
`parameterId`	`String`	identifier of the parameter used in the SBML file
`name`	`String`	name of the parameter
`value`	`Number`	value of the parameter
`unitId`	`Number`	identifier of the unit of the value, defined at the map level

parameterId

String

identifier of the parameter used in the SBML file

name

String

name of the parameter

value

Number

value of the parameter

unitId

Number

identifier of the unit of the value, defined at the map level

3.4. CURL sample

$ curl 'https://minerva-dev.lcsb.uni.lu/minerva/new_api/projects/test_project/maps/158/parameters/' -X POST \
    -H 'Authorization: Bearer xxxxxxxx' \
    -d '{"parameterId":"parameter_id_12","name":"parameter_name_11","value":13.0,"unitId":131}' \
    -H 'Content-Type: application/json'

3.5. HTTP response

HTTP/1.1 201 Created

3.6. Sample Response

{
  "id" : 64,
  "parameterId" : "parameter_id_12",
  "name" : "parameter_name_11",
  "value" : 13.0,
  "units" : null,
  "elementId" : "parameter_id_12"
}

4. Update parameter

Replaces the identifier, name, value and unit of an existing parameter.

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

4.1. HTTP request

PUT /minerva/new_api/projects/test_project/maps/164/parameters/67 HTTP/1.1

4.2. Path Parameters

Table 4. /minerva/new_api/projects/{projectId}/maps/{mapId}/parameters/{parameterId}
Parameter	Description
`projectId`	project identifier
`mapId`	map identifier
`parameterId`	parameter identifier

4.3. Request Fields

Path Type Description

Path	Type	Description
`parameterId`	`String`	identifier of the parameter used in the SBML file
`name`	`String`	name of the parameter
`value`	`Number`	value of the parameter
`unitId`	`Number`	identifier of the unit of the value, defined at the map level

parameterId

String

identifier of the parameter used in the SBML file

name

String

name of the parameter

value

Number

value of the parameter

unitId

Number

identifier of the unit of the value, defined at the map level

4.4. CURL sample

$ curl 'https://minerva-dev.lcsb.uni.lu/minerva/new_api/projects/test_project/maps/164/parameters/67' -X PUT \
    -H 'Authorization: Bearer xxxxxxxx' \
    -d '{"parameterId":"parameter_id_12","name":"parameter_name_11","value":13.0,"unitId":137}' \
    -H 'Content-Type: application/json'

4.5. HTTP response

HTTP/1.1 200 OK

4.6. Sample Response

{
  "id" : 67,
  "parameterId" : "parameter_id_12",
  "name" : "parameter_name_11",
  "value" : 13.0,
  "units" : null,
  "elementId" : "parameter_id_12"
}

5. Delete parameter

Removes a parameter from the map.

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

5.1. HTTP request

DELETE /minerva/new_api/projects/test_project/maps/162/parameters/66 HTTP/1.1

5.2. Path Parameters

Table 5. /minerva/new_api/projects/{projectId}/maps/{mapId}/parameters/{parameterId}
Parameter	Description
`projectId`	project identifier
`mapId`	map identifier
`parameterId`	parameter identifier

5.3. CURL sample

$ curl 'https://minerva-dev.lcsb.uni.lu/minerva/new_api/projects/test_project/maps/162/parameters/66' -X DELETE \
    -H 'Authorization: Bearer xxxxxxxx'

5.4. HTTP response

HTTP/1.1 200 OK