Manipulation API endpoint
A perturbation applied during a session, such as optogenetic or electrical stimulation.
Table of contents
Endpoints
- Private portal:
https://www.brainstem.org/api/private/modules/manipulation/(needs a token; one record: append<id>/) - Public portal:
https://www.brainstem.org/api/public/modules/manipulation/(read-only, public projects, no token) - Response keys:
manipulation(detail, create, update),manipulations(list) - Permissions: inherited through
session→projects(fromproject) - Schema payload:
typeselects a Manipulation type; send its fields indetails.type_schema_versionis set by the server; do not send it.
Form-only inputs (sent on create or update, not returned in responses):
experimental_interfaces[required].
Fields
[required] fields must be sent on create; [read-only] fields are returned but cannot be set. A nestable relation can be traversed in filters (filter{field.other}) and sideloaded with include[]=field.*; other relations can only be compared with ids (filter{field}=<id>). See the query syntax.
| Field | Description |
|---|---|
id | UUID string [read-only] |
type | one of the Manipulation types [required] |
notes | string; max 500 characters; nullable |
interfaces | list of experimentalinterface ids; nestable |
equipment | list of equipment ids |
session | session id [required]; nestable |
details | JSON object |
order | number; nullable. Determines the order items are listed. |
type_schema_version | string [set by the server]. Schema version for type_json field |
List
- Allowed portals: private, public
- Request method: GET
- URL:
https://www.brainstem.org/api/private/modules/manipulation/ - Responses:
200OK;401Not authenticated;403Not allowed
Use example (Python API tool)
resp = client.load('manipulation', load_all=True)
records = resp['manipulations']
Use example (MATLAB API tool)
resp = client.load('manipulation', 'load_all', true);
records = resp.manipulations;
Response example
{
"manipulations": [
{
"id": "<id>",
"type": "DeepBrainStimulation",
"notes": "",
"interfaces": [
"<experimentalinterface-id>"
],
"equipment": [
"<equipment-id>"
],
"session": "<session-id>",
"details": {
"...": "see the schema of the selected type"
},
"order": 1,
"type_schema_version": "set by the server"
}
],
"meta": {
"page": 1,
"per_page": 100,
"total_results": 1,
"total_pages": 1
}
}
Add
- Allowed portals: private
- Request method: POST
- URL:
https://www.brainstem.org/api/private/modules/manipulation/ - Data: JSON object with at least the required fields
- Responses:
201Created;400Bad request (validation errors per field);403Not allowed
Use example (Python API tool)
resp = client.save('manipulation', data={"type": "AuditoryStimulation", "session": "<session-id>", "details": {"...": "see the schema of the selected type"}, "experimental_interfaces": ["<experimentalinterface-id>"]})
record = resp.json()['manipulation']
Use example (MATLAB API tool)
created = client.save(struct('type', 'AuditoryStimulation', 'session', '<session-id>', 'details', struct(), 'experimental_interfaces', {{'<experimentalinterface-id>'}}), 'manipulation'); % struct() stands for the fields of the selected type
record = created.manipulation;
Detail
- Allowed portals: private, public
- Request method: GET
- URL:
https://www.brainstem.org/api/private/modules/manipulation/<id>/ - Responses:
200OK;403Not allowed;404Not found
Use example (Python API tool)
resp = client.load('manipulation', id='<id>')
record = resp.json()['manipulation']
Use example (MATLAB API tool)
out = client.load('manipulation', 'id', '<id>');
record = out.manipulation;
Response example
{
"manipulation": {
"id": "<id>",
"type": "DeepBrainStimulation",
"notes": "",
"interfaces": [
"<experimentalinterface-id>"
],
"equipment": [
"<equipment-id>"
],
"session": "<session-id>",
"details": {
"...": "see the schema of the selected type"
},
"order": 1,
"type_schema_version": "set by the server"
}
}
Change
- Allowed portals: private
- Request method: PATCH
- URL:
https://www.brainstem.org/api/private/modules/manipulation/<id>/ - Data: JSON object with the fields to change. Lists (
projects,tags, …) and JSON payloads (details, coordinates) are replaced as a whole: read the record first and send the full list or object. - Responses:
200OK;400Bad request;403Not allowed;404Not found
Use example (Python API tool)
resp = client.save('manipulation', id='<id>', data={"notes": "new value"})
Use example (MATLAB API tool)
client.save(struct('id', '<id>', 'notes', 'new value'), 'manipulation', 'method', 'patch');
Delete
- Allowed portals: private
- Request method: DELETE
- URL:
https://www.brainstem.org/api/private/modules/manipulation/<id>/ - Responses:
204Deleted;400Still referenced by other records;403Not allowed;404Not found
Use example (Python API tool)
resp = client.delete('manipulation', id='<id>')
Use example (MATLAB API tool)
client.delete('<id>', 'manipulation');
Data model
The fields are described for the web forms on the Manipulation data model page.