1. Machines
1.1. List machines
1.1.1. CURL sample
$ curl 'https://minerva-net.lcsb.uni.lu/api/machines/' -i -X GET
1.1.2. Sample Response
{
"pageContent" : [ {
"id" : 31,
"rootUrl" : "https://pdmap.uni.lu/minerva/",
"version" : "0.0.1",
"createdAt" : "2022-10-14T19:29:24.544521Z",
"status" : "OK",
"statusUpdatedAt" : "2022-10-14T19:29:24.544523Z"
} ],
"isLastPage" : true,
"totalPages" : 1,
"totalElements" : 1,
"pageSize" : 20,
"pageNumber" : 0
}
1.1.3. Response Fields
Path | Type | Description |
---|---|---|
|
|
is it the last page in pageable response |
|
|
number of pages |
|
|
number of elements in the database |
|
|
page size |
|
|
page content |
|
|
page number |
|
|
machine id |
|
|
minerva version |
|
|
machine status |
|
|
token that should be used when modyfing machine data |
|
|
timestamp when the status was last updated |
|
|
timestamp when machine was registered in the net |
|
|
root url of minerva installation |
1.2. Register machine
1.2.1. CURL sample
$ curl 'https://minerva-net.lcsb.uni.lu/api/machines/' -i -X POST \
-H 'Content-Type: application/json' \
-d '{"rootUrl":"https://pdmap.uni.lu/minerva/","email":"minerva@uni.lu","name":"John Doe"}'
1.2.2. Request Fields
Path | Type | Description |
---|---|---|
|
|
contact email address |
|
|
who is registering the machine |
|
|
root url of minerva installation |
1.2.3. Sample Response
{
"id" : 29,
"rootUrl" : "https://pdmap.uni.lu/minerva/",
"version" : "16.2.8",
"createdAt" : "2022-10-14T19:29:23.992815Z",
"status" : "OK",
"statusUpdatedAt" : "2022-10-14T19:29:24.457193Z",
"authenticationToken" : "hDJKJRIzmRgwVjzl2Bj3"
}
1.2.4. Response Fields
Path | Type | Description |
---|---|---|
|
|
machine id |
|
|
minerva version |
|
|
machine status |
|
|
token that should be used when modyfing machine data |
|
|
timestamp when the status was last updated |
|
|
timestamp when machine was registered in the net |
|
|
root url of minerva installation |
1.3. Unregister machine
1.3.1. CURL sample
$ curl 'https://minerva-net.lcsb.uni.lu/api/machines/35' -i -X DELETE \
-H 'Authorization: Bearer pg1fncW3AZwqZZgoV3Tb'
1.3.2. Path Parameters
Parameter | Description |
---|---|
|
machine id |
2. Projects
2.1. List projects
2.1.1. CURL sample
$ curl 'https://minerva-net.lcsb.uni.lu/api/machines/63/projects/' -i -X GET
2.1.2. Sample Response
{
"pageContent" : [ {
"machine" : {
"id" : 63,
"rootUrl" : "https://pdmap.uni.lu/minerva/",
"version" : "0.0.1",
"createdAt" : "2022-10-14T19:29:25.822776Z",
"status" : "OK",
"statusUpdatedAt" : "2022-10-14T19:29:25.822780Z"
},
"projectId" : "pdmap",
"mapName" : "x",
"mapVersion" : "0.0.1",
"organism" : "",
"disease" : "",
"status" : "OK",
"statusUpdatedAt" : "2022-10-14T19:29:25.834721Z",
"createdAt" : "2022-10-14T19:29:25.834718Z"
} ],
"isLastPage" : true,
"totalPages" : 1,
"totalElements" : 1,
"pageSize" : 20,
"pageNumber" : 0
}
2.1.3. Response Fields
Path | Type | Description |
---|---|---|
|
|
is it the last page in pageable response |
|
|
number of pages |
|
|
number of elements in the database |
|
|
page size |
|
|
page content |
|
|
page number |
|
|
project id |
|
|
project version |
|
|
project name |
|
|
organism (taxonomy ID) |
|
|
disease (mesh ID) |
|
|
project status |
|
|
timestamp when the status was last updated |
|
|
timestamp when project was registered in the net |
|
|
machine where project is located |
2.2. Register Project
2.2.1. CURL sample
$ curl 'https://minerva-net.lcsb.uni.lu/api/machines/55/projects/' -i -X POST \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer BsJgBK8OmLu91g0WxIsY' \
-d '{"projectId":"pdmap","email":"minerva@uni.lu"}'
2.2.2. Request Fields
Path | Type | Description |
---|---|---|
|
|
contact email address |
|
|
project id |
2.2.3. Sample Response
{
"machine" : {
"id" : 55,
"rootUrl" : "https://pdmap.uni.lu/minerva/",
"version" : "0.0.1",
"createdAt" : "2022-10-14T19:29:25.268916Z",
"status" : "OK",
"statusUpdatedAt" : "2022-10-14T19:29:25.268921Z"
},
"projectId" : "pdmap",
"mapName" : "",
"mapVersion" : "June'2015",
"organism" : "9606",
"disease" : "D010300",
"status" : "OK",
"statusUpdatedAt" : "2022-10-14T19:29:25.521143Z",
"createdAt" : "2022-10-14T19:29:25.302386Z"
}
2.2.4. Response Fields
Path | Type | Description |
---|---|---|
|
|
project id |
|
|
project version |
|
|
project name |
|
|
organism (taxonomy ID) |
|
|
disease (mesh ID) |
|
|
project status |
|
|
timestamp when the status was last updated |
|
|
timestamp when project was registered in the net |
|
|
machine where project is located |
2.3. Unregister Project
2.3.1. CURL sample
$ curl 'https://minerva-net.lcsb.uni.lu/api/machines/50/projects/pdmap' -i -X DELETE \
-H 'Authorization: Bearer 9OlwSWdrQDRxYc05gFaE'
2.3.2. Path Parameters
Parameter | Description |
---|---|
|
machine id |
|
project id |