1. List data overlays
1.1. Path Parameters
| Parameter | Description |
|---|---|
|
project identifier |
1.2. Response Fields
| Path | Type | Description |
|---|---|---|
|
|
name |
|
|
description |
|
|
identifier |
|
|
is the data overlay publicaly available to all users |
|
|
did creator accepted license required by Google Maps API |
|
|
sort order |
|
|
type; available options: GENERIC, GENETIC_VARIANT |
|
|
reference genome type; available options: UCSC |
|
|
reference genome version |
|
|
login of the user who uploaded data overlay |
1.3. CURL sample 1
$ curl 'https://minerva-service.lcsb.uni.lu/minerva/api/projects/test_project/overlays/' -i -X GET
1.4. Sample Response 1
[ {
"name" : "test title",
"googleLicenseConsent" : false,
"creator" : "admin",
"description" : "test description",
"genomeType" : null,
"genomeVersion" : null,
"idObject" : 1000121,
"publicOverlay" : true,
"type" : "GENERIC",
"order" : 0
}, {
"name" : "test title",
"googleLicenseConsent" : false,
"creator" : "test_user",
"description" : "test description",
"genomeType" : null,
"genomeVersion" : null,
"idObject" : 1000122,
"publicOverlay" : false,
"type" : "GENERIC",
"order" : 0
} ]
1.5. CURL sample 2
$ curl 'https://minerva-service.lcsb.uni.lu/minerva/api/projects/test_project/overlays/?creator=test_curator' -i -X GET
1.6. Sample Response 2
[ {
"name" : "test title",
"googleLicenseConsent" : false,
"creator" : "test_curator",
"description" : "test description",
"genomeType" : null,
"genomeVersion" : null,
"idObject" : 1000132,
"publicOverlay" : false,
"type" : "GENERIC",
"order" : 0
} ]
2. Get data overlay
2.1. Path Parameters
| Parameter | Description |
|---|---|
|
project identifier |
|
overlay identifier |
2.2. Response Fields
| Path | Type | Description |
|---|---|---|
|
|
name |
|
|
description |
|
|
identifier |
|
|
is the data overlay publicaly available to all users |
|
|
did creator accepted license required by Google Maps API |
|
|
sort order |
|
|
type; available options: GENERIC, GENETIC_VARIANT |
|
|
reference genome type; available options: UCSC |
|
|
reference genome version |
|
|
login of the user who uploaded data overlay |
2.3. CURL sample
$ curl 'https://minerva-service.lcsb.uni.lu/minerva/api/projects/test_project/overlays/1000094/' -i -X GET
2.4. Sample Response
{
"name" : "test title",
"googleLicenseConsent" : false,
"creator" : "test_user",
"description" : "test description",
"genomeType" : null,
"genomeVersion" : null,
"idObject" : 1000094,
"publicOverlay" : false,
"type" : "GENERIC",
"order" : 0
}
3. Add overlay
3.1. Path Parameters
| Parameter | Description |
|---|---|
|
project identifier |
3.2. Request Parameters
| Parameter | Description |
|---|---|
|
name of the data overlay |
|
content of the file that is uploaded with definition what should be visible where (alternative to fileId) |
|
uploaded file id that should be used as data overlay content content (alternative to content) |
|
short description of the data overlay |
|
name of the file that should be used when downloading the source |
|
type of the data overlay (default: GENERIC). Available options: GENERIC, GENETIC_VARIANT |
|
true/false indicating if user agreed to the new Google Maps API license https://cloud.google.com/maps-platform/terms/ |
3.3. Response Fields
| Path | Type | Description |
|---|---|---|
|
|
name |
|
|
description |
|
|
identifier |
|
|
is the data overlay publicaly available to all users |
|
|
did creator accepted license required by Google Maps API |
|
|
sort order |
|
|
type; available options: GENERIC, GENETIC_VARIANT |
|
|
reference genome type; available options: UCSC |
|
|
reference genome version |
|
|
login of the user who uploaded data overlay |
3.4. CURL sample from file
$ curl 'https://minerva-service.lcsb.uni.lu/minerva/api/projects/test_project/overlays/' -i -X POST \
-H 'Content-Type: application/x-www-form-urlencoded' \
-d 'fileId=436&name=overlay+name&description=overlay+name&filename=overlay+name&googleLicenseConsent=false&type=GENERIC' \
--cookie "MINERVA_AUTH_TOKEN=xxxxxxxx"
3.5. Sample Response from file
{
"name" : "overlay name",
"googleLicenseConsent" : false,
"creator" : "admin",
"description" : "overlay name",
"genomeType" : null,
"genomeVersion" : null,
"idObject" : 1000115,
"publicOverlay" : false,
"type" : "GENERIC",
"order" : 1
}
3.6. CURL sample from content
$ curl 'https://minerva-service.lcsb.uni.lu/minerva/api/projects/test_project/overlays/' -i -X POST \
-H 'Content-Type: application/x-www-form-urlencoded' \
-d 'content=element_identifier%09value%0A%09-1&name=overlay+name&description=overlay+name&filename=overlay+name&googleLicenseConsent=false&type=GENERIC' \
--cookie "MINERVA_AUTH_TOKEN=xxxxxxxx"
3.7. Sample Response from content
{
"name" : "overlay name",
"googleLicenseConsent" : false,
"creator" : "admin",
"description" : "overlay name",
"genomeType" : null,
"genomeVersion" : null,
"idObject" : 1000087,
"publicOverlay" : false,
"type" : "GENERIC",
"order" : 1
}
4. Update overlay
4.1. Path Parameters
| Parameter | Description |
|---|---|
|
project identifier |
|
overlay identifier |
4.2. Request Fields
| Path | Type | Description |
|---|---|---|
|
|
name |
|
|
description |
|
|
is the data overlay publicaly available to all users |
|
|
did creator accepted license required by Google Maps API |
|
|
sort order |
|
|
type; available options: GENERIC, GENETIC_VARIANT |
|
|
login of the user who uploaded data overlay |
4.3. Response Fields
| Path | Type | Description |
|---|---|---|
|
|
name |
|
|
description |
|
|
identifier |
|
|
is the data overlay publicaly available to all users |
|
|
did creator accepted license required by Google Maps API |
|
|
sort order |
|
|
type; available options: GENERIC, GENETIC_VARIANT |
|
|
reference genome type; available options: UCSC |
|
|
reference genome version |
|
|
login of the user who uploaded data overlay |
4.4. CURL sample
$ curl 'https://minerva-service.lcsb.uni.lu/minerva/api/projects/test_project/overlays/1000098' -i -X PATCH \
-H 'Content-Type: application/json' \
-d '{"overlay":{"name":"test title","googleLicenseConsent":false,"creator":"test_user","description":"test description","publicOverlay":false,"type":"GENERIC","order":0}}' \
--cookie "MINERVA_AUTH_TOKEN=xxxxxxxx"
4.5. Sample Response
{
"name" : "test title",
"googleLicenseConsent" : false,
"creator" : "test_user",
"description" : "test description",
"genomeType" : null,
"genomeVersion" : null,
"idObject" : 1000098,
"publicOverlay" : false,
"type" : "GENERIC",
"order" : 0
}
5. Delete overlay
5.1. CURL sample
$ curl 'https://minerva-service.lcsb.uni.lu/minerva/api/projects/test_project/overlays/1000143' -i -X DELETE
5.2. Path Parameters
| Parameter | Description |
|---|---|
|
project identifier |
|
overlay identifier |
6. Download source data
6.1. Path Parameters
| Parameter | Description |
|---|---|
|
project identifier |
|
overlay identifier |
6.2. CURL sample
$ curl 'https://minerva-service.lcsb.uni.lu/minerva/api/projects/test_project/overlays/1000124:downloadSource' -i -X GET
6.3. Sample Response
element_identifier value
-1
7. Download legend
7.1. Path Parameters
Unresolved directive in project_overlays.adoc - include::../../../target/generated-snippets/projects/project_legend/download_source/path-parameters.adoc[]
7.2. CURL sample
Unresolved directive in project_overlays.adoc - include::../../../target/generated-snippets/projects/project_legend/download_source/curl-request.adoc[]
8. Get list of associated bioEntites
8.1. Path Parameters
| Parameter | Description |
|---|---|
|
project identifier |
|
map identifier |
|
overlay identifier |
8.2. Response Fields
| Path | Type | Description |
|---|---|---|
|
|
type of bioEntity (ALIAS/REACTION) |
|
|
identifier of the bioEntity |
|
|
map identifier where bioEntity is located |
|
|
normalized value assigned to the bioEntity from overlay |
|
|
color assigned to the bioEntity from overlay |
|
|
description assigned to the bioEntity from overlay |
|
|
list of gene variants assigned to the bioEntity from overlay |
|
|
line width of reaction bioEntity assigned to the bioEntity from overlay |
8.3. CURL sample
$ curl 'https://minerva-service.lcsb.uni.lu/minerva/api/projects/test_project/overlays/1000130/models/*/bioEntities/' -i -X GET
8.4. Sample Response
[ {
"type" : "ALIAS",
"overlayContent" : {
"modelId" : 595,
"idObject" : "1456",
"value" : -1.0,
"color" : null,
"description" : null,
"type" : "GENERIC",
"uniqueId" : 1456
}
}, {
"type" : "ALIAS",
"overlayContent" : {
"modelId" : 595,
"idObject" : "1457",
"value" : -1.0,
"color" : null,
"description" : null,
"type" : "GENERIC",
"uniqueId" : 1457
}
}, {
"type" : "ALIAS",
"overlayContent" : {
"modelId" : 595,
"idObject" : "1458",
"value" : -1.0,
"color" : null,
"description" : null,
"type" : "GENERIC",
"uniqueId" : 1458
}
}, {
"type" : "ALIAS",
"overlayContent" : {
"modelId" : 595,
"idObject" : "1460",
"value" : -1.0,
"color" : null,
"description" : null,
"type" : "GENERIC",
"uniqueId" : 1460
}
}, {
"type" : "REACTION",
"overlayContent" : {
"modelId" : 595,
"idObject" : "294",
"value" : -1.0,
"color" : null,
"description" : null,
"type" : "GENERIC",
"uniqueId" : 294
}
}, {
"type" : "ALIAS",
"overlayContent" : {
"modelId" : 596,
"idObject" : "1459",
"value" : -1.0,
"color" : null,
"description" : null,
"type" : "GENERIC",
"uniqueId" : 1459
}
} ]
9. Get reaction data
9.1. Path Parameters
| Parameter | Description |
|---|---|
|
project identifier |
|
map identifier |
|
overlay identifier |
|
reaction identifier |
9.2. Response Fields
| Path | Type | Description |
|---|---|---|
|
|
type of bioEntity (ALIAS/REACTION) |
|
|
identifier of the bioEntity |
|
|
map identifier where bioEntity is located |
|
|
normalized value assigned to the bioEntity from overlay |
|
|
color assigned to the bioEntity from overlay |
|
|
description assigned to the bioEntity from overlay |
|
|
list of gene variants assigned to the bioEntity from overlay |
|
|
line width of reaction bioEntity assigned to the bioEntity from overlay |
9.3. CURL sample
$ curl 'https://minerva-service.lcsb.uni.lu/minerva/api/projects/test_project/overlays/1000084/models/501/bioEntities/reactions/247/' -i -X GET
9.4. Sample Response
[ {
"type" : "REACTION",
"overlayContent" : {
"modelId" : 501,
"idObject" : "247",
"value" : -1.0,
"color" : null,
"description" : null,
"type" : "GENERIC",
"geneVariations" : [ ],
"uniqueId" : 247
}
} ]
10. Get element data
10.1. Path Parameters
| Parameter | Description |
|---|---|
|
project identifier |
|
map identifier |
|
overlay identifier |
|
element identifier |
10.2. Response Fields
| Path | Type | Description |
|---|---|---|
|
|
type of bioEntity (ALIAS/REACTION) |
|
|
identifier of the bioEntity |
|
|
map identifier where bioEntity is located |
|
|
normalized value assigned to the bioEntity from overlay |
|
|
color assigned to the bioEntity from overlay |
|
|
description assigned to the bioEntity from overlay |
|
|
list of gene variants assigned to the bioEntity from overlay |
|
|
line width of reaction bioEntity assigned to the bioEntity from overlay |
10.3. CURL sample
$ curl 'https://minerva-service.lcsb.uni.lu/minerva/api/projects/test_project/overlays/1000136/models/607/bioEntities/elements/1489/' -i -X GET
10.4. Sample Response
[ {
"type" : "ALIAS",
"overlayContent" : {
"modelId" : 607,
"idObject" : "1489",
"value" : -1.0,
"color" : null,
"description" : null,
"type" : "GENERIC",
"geneVariations" : [ ],
"uniqueId" : 1489
}
} ]