Miscellaneous¶
Get configuration of model catalog app¶
-
GET
https://validation-v1.brainsimulation.eu/parametersconfiguration-model-catalog/parametersconfigurationrest/?app_id=
(string: app_id)¶ Gets the current filter configuration of a specific model catalog app
Example request:
GET /parametersconfiguration-model-catalog/parametersconfigurationrest/?app_id=80841 HTTP/1.1 Accept: application/json Authorization: Bearer TOKEN Content-Type: application/json Host: validation-v1.brainsimulation.eu
Example response:
HTTP/1.1 200 OK Content-Type: application/json { "param": [ { "id": "80841", "app_type": "model_catalog", "collab_id": 5165, "data_modalities": "", "test_type": "", "species": "Mouse (Mus musculus)", "brain_region": "Basal Ganglia,Hippocampus", "cell_type": "Pyramidal Cell,Medium spiny neuron,Fast spiking interneuron", "model_type": "Single Cell,Network", "organization": "HBP-SP6" } ] }
Parameters: - app_id – navigation ID of the app inside the Collab
Request Headers: - Authorization – Bearer TOKEN
Status Codes: - 200 OK – configuration successfully retrieved
- 400 Bad Request – incorrect API call
- 403 Forbidden – invalid token provided
Initial configuration of model catalog app¶
-
POST
https://validation-v1.brainsimulation.eu/parametersconfiguration-model-catalog/parametersconfigurationrest/?app_id=
(string: app_id)¶ Configure the filters of a specific model catalog app that is presently unconfigured (e.g. new instance of app)
Example request:
POST /parametersconfiguration-model-catalog/parametersconfigurationrest/?app_id=80841 HTTP/1.1 Accept: application/json Authorization: Bearer TOKEN Content-Type: application/json Host: validation-v1.brainsimulation.eu { "id": 80841, "data_modalities": "", "test_type": "", "species": "Mouse (Mus musculus)", "brain_region": "Basal Ganglia,Hippocampus", "cell_type": "Pyramidal Cell,Medium spiny neuron,Fast spiking interneuron", "model_type": "Single Cell,Network", "organization": "HBP-SP6", "app_type": "model_catalog", "collab_id": 5165 }
Example response:
HTTP/1.1 201 Created Content-Type: application/json { "uuid":80841 }
Parameters: - app_id – navigation ID of the app inside the Collab
JSON Parameters: - key (string) – key value pairs
Request Headers: - Authorization – Bearer TOKEN
Status Codes: - 201 Created – app successfully configured
- 400 Bad Request – incorrect API call
- 403 Forbidden – invalid token provided
Reconfiguration of model catalog app¶
-
PUT
https://validation-v1.brainsimulation.eu/parametersconfiguration-model-catalog/parametersconfigurationrest/?app_id=
(string: app_id)¶ Reconfigure the filters of a specific model catalog app that has previously been configured
Example request:
PUT /parametersconfiguration-model-catalog/parametersconfigurationrest/?app_id=80841 HTTP/1.1 Accept: application/json Authorization: Bearer TOKEN Content-Type: application/json Host: validation-v1.brainsimulation.eu { "id": 80841, "data_modalities": "", "test_type": "", "species": "Mouse (Mus musculus)", "brain_region": "Basal Ganglia,Hippocampus", "cell_type": "Pyramidal Cell,Medium spiny neuron,Fast spiking interneuron", "model_type": "Single Cell,Network", "organization": "HBP-SP6", "app_type": "model_catalog", "collab_id": 5165 }
Example response:
HTTP/1.1 202 Accepted Content-Type: application/json { "uuid":80841 }
Parameters: - app_id – navigation ID of the app inside the Collab
JSON Parameters: - key (string) – key value pairs
Request Headers: - Authorization – Bearer TOKEN
Status Codes: - 202 Accepted – app successfully reconfigured
- 400 Bad Request – incorrect API call
- 403 Forbidden – invalid token provided
Get configuration of validation framework app¶
-
GET
https://validation-v1.brainsimulation.eu/parametersconfiguration-validation-app/parametersconfigurationrest/?app_id=
(string: app_id)¶ Gets the current filter configuration of a specific validation framework app
Example request:
GET /parametersconfiguration-validation-app/parametersconfigurationrest/?app_id=80839 HTTP/1.1 Accept: application/json Authorization: Bearer TOKEN Content-Type: application/json Host: validation-v1.brainsimulation.eu
Example response:
HTTP/1.1 200 OK Content-Type: application/json { "param": [ { "id": "80839", "app_type": "validation_app", "collab_id": 5165, "data_modalities": "electrophysiology", "test_type": "single cell activity,network structure", "species": "Mouse (Mus musculus)", "brain_region": "Basal Ganglia,Hippocampus", "cell_type": "Pyramidal Cell,Medium spiny neuron,Fast spiking interneuron", "model_type": "Single Cell,Network", "organization": "HBP-SP6" } ] }
Parameters: - app_id – navigation ID of the app inside the Collab
Request Headers: - Authorization – Bearer TOKEN
Status Codes: - 200 OK – configuration successfully retrieved
- 400 Bad Request – incorrect API call
- 403 Forbidden – invalid token provided
Initial configuration of validation framework app¶
-
POST
https://validation-v1.brainsimulation.eu/parametersconfiguration-validation-app/parametersconfigurationrest/?app_id=
(string: app_id)¶ Configure the filters of a specific validation framework app that is presently unconfigured (e.g. new instance of app)
Example request:
POST /parametersconfiguration-validation-app/parametersconfigurationrest/?app_id=80839 HTTP/1.1 Accept: application/json Authorization: Bearer TOKEN Content-Type: application/json Host: validation-v1.brainsimulation.eu { "id": 80839, "app_type": "validation_app", "collab_id": 5165, "data_modalities": "electrophysiology", "test_type": "single cell activity,network structure", "species": "Mouse (Mus musculus)", "brain_region": "Basal Ganglia,Hippocampus", "cell_type": "Pyramidal Cell,Medium spiny neuron,Fast spiking interneuron", "model_type": "Single Cell,Network", "organization": "HBP-SP6" }
Example response:
HTTP/1.1 201 Created Content-Type: application/json { "uuid":80839 }
Parameters: - app_id – navigation ID of the app inside the Collab
JSON Parameters: - key (string) – key value pairs
Request Headers: - Authorization – Bearer TOKEN
Status Codes: - 201 Created – app successfully configured
- 400 Bad Request – incorrect API call
- 403 Forbidden – invalid token provided
Reconfiguration of validation framework app¶
-
PUT
https://validation-v1.brainsimulation.eu/parametersconfiguration-validation-app/parametersconfigurationrest/?app_id=
(string: app_id)¶ Reconfigure the filters of a specific validation framework app that has previously been configured
Example request:
PUT /parametersconfiguration-validation-app/parametersconfigurationrest/?app_id=80839 HTTP/1.1 Accept: application/json Authorization: Bearer TOKEN Content-Type: application/json Host: validation-v1.brainsimulation.eu { "id": 80839, "app_type": "validation_app", "collab_id": 5165, "data_modalities": "electrophysiology", "test_type": "single cell activity,network structure", "species": "Mouse (Mus musculus)", "brain_region": "Basal Ganglia,Hippocampus", "cell_type": "Pyramidal Cell,Medium spiny neuron,Fast spiking interneuron", "model_type": "Single Cell,Network", "organization": "HBP-SP6" }
Example response:
HTTP/1.1 202 Accepted Content-Type: application/json { "uuid":80839 }
Parameters: - app_id – navigation ID of the app inside the Collab
JSON Parameters: - key (string) – key value pairs
Request Headers: - Authorization – Bearer TOKEN
Status Codes: - 202 Accepted – app successfully reconfigured
- 400 Bad Request – incorrect API call
- 403 Forbidden – invalid token provided
Get valid attribute values¶
Retrieves the list of valid values for either a specified attribute or all attributes
Example request:
GET /authorizedcollabparameterrest/?python_client=true¶meters=cell_type&format=json HTTP/1.1 Accept: application/json, text/plain, */* Authorization: Bearer TOKEN Host: validation-v1.brainsimulation.eu
Example response:
HTTP/1.1 200 OK Content-Type: application/json { "cell_type": [ "Granule Cell", "Interneuron", "Pyramidal Cell", "Other", "Purkinje Cell", "Golgi Cell", "Medium spiny neuron", "Spiny stellate neuron", "Fast spiking interneuron", "Medium spiny neuron (D1 type)", "Medium spiny neuron (D2 type)", "Not applicable", "L1 Neurogliaform cell", "L2 Inverted pyramidal cell", "L2/3 Chandelier cell", "L4 Martinotti cell", "L5 Tufted pyramidal cell", "L6 Inverted pyramidal cell", "Cholinergic interneuron", "L2/3 Pyramidal cell" ] }
Parameters: - attribute_name (string) – required attribute name or all for every attribute
Request Headers: - Authorization – Bearer TOKEN
Status Codes: - 200 OK – values successfully retrieved