Skip to content
Snippets Groups Projects
Commit c8d98751 authored by Piotr Gawron's avatar Piotr Gawron
Browse files

Update README.md

parent 29937c75
No related branches found
No related tags found
1 merge request!55Resolve "REST API documentation"
...@@ -243,10 +243,10 @@ curl -X GET --cookie "MINERVA_AUTH_TOKEN=xxxxxxxx" http://pg-sandbox.uni.lu/mine ...@@ -243,10 +243,10 @@ curl -X GET --cookie "MINERVA_AUTH_TOKEN=xxxxxxxx" http://pg-sandbox.uni.lu/mine
* Method: GET * Method: GET
* Parameters: * Parameters:
* `projectId` - identifier of the project * `projectId` - identifier of the project
* `modelId` - identifier of the (sub)map in the project or wildcard '*' character * `modelId` - identifier of the (sub)map in the project or wildcard '*' character
* `coordinates` - coordinates of the point on (sub)map * `coordinates` - coordinates of the point on (sub)map
* `columns` (\*) - set of columns for each result. Possible values are: title, type, content, removed, coord, modelId, elementId, id, pinned, author, email, * `columns` (\*) - set of columns for each result. Possible values are: title, type, content, removed, coord, modelId, elementId, id, pinned, author, email,
* `removed` (\*) - if defined then removed paramter must match. * `removed` (\*) - if defined then removed paramter must match.
* Example: TODO * Example: TODO
* Create element comment * Create element comment
...@@ -254,7 +254,7 @@ curl -X GET --cookie "MINERVA_AUTH_TOKEN=xxxxxxxx" http://pg-sandbox.uni.lu/mine ...@@ -254,7 +254,7 @@ curl -X GET --cookie "MINERVA_AUTH_TOKEN=xxxxxxxx" http://pg-sandbox.uni.lu/mine
* Method: POST * Method: POST
* Parameters: * Parameters:
* `projectId` - identifier of the project * `projectId` - identifier of the project
* `modelId` - identifier of the (sub)map in the project * `modelId` - identifier of the (sub)map in the project
* `elementId` - identifier of the element to be commented * `elementId` - identifier of the element to be commented
* `name` - name of the author * `name` - name of the author
* `email` - email of the author * `email` - email of the author
...@@ -271,7 +271,7 @@ curl -X POST --cookie "MINERVA_AUTH_TOKEN=xxxxxxxx" --data "name=testComment&ema ...@@ -271,7 +271,7 @@ curl -X POST --cookie "MINERVA_AUTH_TOKEN=xxxxxxxx" --data "name=testComment&ema
* Method: POST * Method: POST
* Parameters: * Parameters:
* `projectId` - identifier of the project * `projectId` - identifier of the project
* `modelId` - identifier of the (sub)map in the project * `modelId` - identifier of the (sub)map in the project
* `reactionId` - identifier of the reaction * `reactionId` - identifier of the reaction
* `name` - name of the author * `name` - name of the author
* `email` - email of the author * `email` - email of the author
...@@ -289,7 +289,7 @@ curl -X POST --cookie "MINERVA_AUTH_TOKEN=xxxxxxxx" --data "name=testComment&ema ...@@ -289,7 +289,7 @@ curl -X POST --cookie "MINERVA_AUTH_TOKEN=xxxxxxxx" --data "name=testComment&ema
* Method: GET * Method: GET
* Parameters: * Parameters:
* `projectId` - identifier of the project * `projectId` - identifier of the project
* `modelId` - identifier of the (sub)map in the project * `modelId` - identifier of the (sub)map in the project
* `name` - name of the author * `name` - name of the author
* `email` - email of the author * `email` - email of the author
* `content` - content of the comment * `content` - content of the comment
...@@ -304,10 +304,10 @@ curl -X POST --cookie "MINERVA_AUTH_TOKEN=xxxxxxxx" --data "name=testComment&ema ...@@ -304,10 +304,10 @@ curl -X POST --cookie "MINERVA_AUTH_TOKEN=xxxxxxxx" --data "name=testComment&ema
* URL: `/projects/{projectId}/drugs:search` * URL: `/projects/{projectId}/drugs:search`
* Method: GET * Method: GET
* Parameters: * Parameters:
* `projectId` - identifier of the project * `projectId` - identifier of the project
* `columns` (\*) - set of columns for each result. Possible values are: name, references, description, bloodBrainBarrier, brandNames, synonyms, id, targets, * `columns` (\*) - set of columns for each result. Possible values are: name, references, description, bloodBrainBarrier, brandNames, synonyms, id, targets,
* `query` (\*) - drug name or synonym * `query` (\*) - drug name or synonym
* `target` (\*) - target for which we are lookig for drugs. Target is defined as TYPE:ID. For example "ALIAS:534" is searching for drugs that target Alias with id=534. * `target` (\*) - target for which we are lookig for drugs. Target is defined as TYPE:ID. For example "ALIAS:534" is searching for drugs that target Alias with id=534.
* Example: * Example:
``` ```
curl -X GET --cookie "MINERVA_AUTH_TOKEN=xxxxxxxx" http://pg-sandbox.uni.lu/minerva/api/projects/pdmap_dec15/drugs:search?query=aspirin curl -X GET --cookie "MINERVA_AUTH_TOKEN=xxxxxxxx" http://pg-sandbox.uni.lu/minerva/api/projects/pdmap_dec15/drugs:search?query=aspirin
...@@ -318,10 +318,10 @@ curl -X GET --cookie "MINERVA_AUTH_TOKEN=xxxxxxxx" http://pg-sandbox.uni.lu/mine ...@@ -318,10 +318,10 @@ curl -X GET --cookie "MINERVA_AUTH_TOKEN=xxxxxxxx" http://pg-sandbox.uni.lu/mine
* URL: `/projects/{projectId}/miRnas:search` * URL: `/projects/{projectId}/miRnas:search`
* Method: GET * Method: GET
* Parameters: * Parameters:
* `projectId` - identifier of the project * `projectId` - identifier of the project
* `columns` (\*) - set of columns for each result. Possible values are: name, id, targets, * `columns` (\*) - set of columns for each result. Possible values are: name, id, targets,
* `query` (\*) - mirna id * `query` (\*) - mirna id
* `target` (\*) - target for which we are lookig for drugs. Target is defined as TYPE:ID. For example "ALIAS:534" is searching for drugs that target Alias with id=534. * `target` (\*) - target for which we are lookig for drugs. Target is defined as TYPE:ID. For example "ALIAS:534" is searching for drugs that target Alias with id=534.
* Example: * Example:
``` ```
curl -X GET --cookie "MINERVA_AUTH_TOKEN=xxxxxxxx" http://pg-sandbox.uni.lu/minerva/api/projects/pdmap_dec15/miRnas:search?query=hsa-miR-125a-3p curl -X GET --cookie "MINERVA_AUTH_TOKEN=xxxxxxxx" http://pg-sandbox.uni.lu/minerva/api/projects/pdmap_dec15/miRnas:search?query=hsa-miR-125a-3p
...@@ -334,7 +334,7 @@ curl -X GET --cookie "MINERVA_AUTH_TOKEN=xxxxxxxx" http://pg-sandbox.uni.lu/mine ...@@ -334,7 +334,7 @@ curl -X GET --cookie "MINERVA_AUTH_TOKEN=xxxxxxxx" http://pg-sandbox.uni.lu/mine
* Method: GET * Method: GET
* Parameters: * Parameters:
* `projectId` - identifier of the project * `projectId` - identifier of the project
* `modelId` - identifier of the (sub)map in the project or wildcard '*' character * `modelId` - identifier of the (sub)map in the project or wildcard '\*' character
* `start` (\*) - first element to be return when pagination is on (default 0) * `start` (\*) - first element to be return when pagination is on (default 0)
* `length` (\*) - how many publication we want to retrieve (default 10) * `length` (\*) - how many publication we want to retrieve (default 10)
...@@ -359,10 +359,10 @@ curl -X GET --cookie "MINERVA_AUTH_TOKEN=xxxxxxxx" http://pg-sandbox.uni.lu/mine ...@@ -359,10 +359,10 @@ curl -X GET --cookie "MINERVA_AUTH_TOKEN=xxxxxxxx" http://pg-sandbox.uni.lu/mine
* Method: POST * Method: POST
* Parameters: * Parameters:
* `projectId` - identifier of the project * `projectId` - identifier of the project
* `name` - name of the data overlay * `name` - name of the data overlay
* `content` - content of the file that is uploaded with definition what should be visible where * `content` - content of the file that is uploaded with definition what should be visible where
* `description` - short desription of the data overlay * `description` - short desription of the data overlay
* `filename` - name of the file that should be used when downloading the source * `filename` - name of the file that should be used when downloading the source
* Example: * Example:
``` ```
curl -X POST --data "content=name%09color%0ACAPN1%09%2300FF00%0APARK7%09%23AC0000&description=test%20desc&filename=test.txt&name=test%20nam" --cookie "MINERVA_AUTH_TOKEN=xxxxxxxx" http://pg-sandbox.uni.lu/minerva/api/projects/pdmap_dec15/overlays/ curl -X POST --data "content=name%09color%0ACAPN1%09%2300FF00%0APARK7%09%23AC0000&description=test%20desc&filename=test.txt&name=test%20nam" --cookie "MINERVA_AUTH_TOKEN=xxxxxxxx" http://pg-sandbox.uni.lu/minerva/api/projects/pdmap_dec15/overlays/
...@@ -375,14 +375,14 @@ curl -X POST --data "content=name%09color%0ACAPN1%09%2300FF00%0APARK7%09%23AC000 ...@@ -375,14 +375,14 @@ curl -X POST --data "content=name%09color%0ACAPN1%09%2300FF00%0APARK7%09%23AC000
* `projectId` - identifier of the project * `projectId` - identifier of the project
* `overlayId` - identifier of data overlay * `overlayId` - identifier of data overlay
* Body: json with updated overlay * Body: json with updated overlay
```
{ {
"overlay": {   "overlay": {
"name" : name,     "name" : name,
"description" : description     "description" : description
}   }
} }
```
* Example: * Example:
``` ```
curl -X PATCH --data "{\"overlay\":{\"name\":\"test\", \"description\":\"test2\"}}" --cookie "MINERVA_AUTH_TOKEN=xxxxxxxx" http://pg-sandbox.uni.lu/minerva/api/projects/pdmap_dec15/overlays/3203/ curl -X PATCH --data "{\"overlay\":{\"name\":\"test\", \"description\":\"test2\"}}" --cookie "MINERVA_AUTH_TOKEN=xxxxxxxx" http://pg-sandbox.uni.lu/minerva/api/projects/pdmap_dec15/overlays/3203/
...@@ -437,7 +437,7 @@ curl -X GET --cookie "MINERVA_AUTH_TOKEN=xxxxxxxx" http://pg-sandbox.uni.lu/mine ...@@ -437,7 +437,7 @@ curl -X GET --cookie "MINERVA_AUTH_TOKEN=xxxxxxxx" http://pg-sandbox.uni.lu/mine
* Method: GET * Method: GET
* Parameters: * Parameters:
* `projectId` - identifier of the project * `projectId` - identifier of the project
* `modelId` - identifier of the (sub)map in the project * `modelId` - identifier of the (sub)map in the project
* `overlayId` - identifier of data overlay * `overlayId` - identifier of data overlay
* `reactionId` - identifier of the reaction * `reactionId` - identifier of the reaction
* Example: * Example:
...@@ -450,7 +450,7 @@ curl -X GET --cookie "MINERVA_AUTH_TOKEN=xxxxxxxx" http://pg-sandbox.uni.lu/mine ...@@ -450,7 +450,7 @@ curl -X GET --cookie "MINERVA_AUTH_TOKEN=xxxxxxxx" http://pg-sandbox.uni.lu/mine
* Method: GET * Method: GET
* Parameters: * Parameters:
* `projectId` - identifier of the project * `projectId` - identifier of the project
* `modelId` - identifier of the (sub)map in the project * `modelId` - identifier of the (sub)map in the project
* `overlayId` - identifier of data overlay * `overlayId` - identifier of data overlay
* `elementId` - identifier of the element * `elementId` - identifier of the element
* Example: * Example:
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment