Data acquisition API endpoint
One kind of data recorded in a session, such as electrophysiology, imaging or video, and where it is stored.
Table of contents
Endpoints
- Private portal:
https://www.brainstem.org/api/private/modules/dataacquisition/(needs a token; one record: append<id>/) - Public portal:
https://www.brainstem.org/api/public/modules/dataacquisition/(read-only, public projects, no token) - Response keys:
data_acquisition(detail, create, update),data_acquisitions(list) - Permissions: inherited through
session→projects(fromproject) - Schema payload:
typeselects a DataAcquisition 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] |
notes | string; max 500 characters; nullable |
session | session id [required]; nestable |
interfaces | list of experimentalinterface ids; nestable |
equipment | list of equipment ids |
type | one of the DataAcquisition types [required] |
details | JSON object |
type_schema_version | string [set by the server] |
image | string; max 100 characters |
order | number; nullable. Determines the order items are listed. |
List
- Allowed portals: private, public
- Request method: GET
- URL:
https://www.brainstem.org/api/private/modules/dataacquisition/ - Responses:
200OK;401Not authenticated;403Not allowed
Use example (Python API tool)
resp = client.load('dataacquisition', load_all=True)
records = resp['data_acquisitions']
Use example (MATLAB API tool)
resp = client.load('dataacquisition', 'load_all', true);
records = resp.data_acquisitions;
Response example
{
"data_acquisitions": [
{
"id": "<id>",
"notes": "",
"session": "<session-id>",
"interfaces": [
"<experimentalinterface-id>"
],
"equipment": [
"<equipment-id>"
],
"type": "Audio",
"details": {
"...": "see the schema of the selected type"
},
"type_schema_version": "set by the server",
"image": "",
"order": 1
}
],
"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/dataacquisition/ - 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('dataacquisition', data={"session": "<session-id>", "type": "Audio", "details": {"...": "see the schema of the selected type"}, "experimental_interfaces": ["<experimentalinterface-id>"]})
record = resp.json()['data_acquisition']
Use example (MATLAB API tool)
created = client.save(struct('session', '<session-id>', 'type', 'Audio', 'details', struct(), 'experimental_interfaces', {{'<experimentalinterface-id>'}}), 'dataacquisition'); % struct() stands for the fields of the selected type
record = created.data_acquisition;
Detail
- Allowed portals: private, public
- Request method: GET
- URL:
https://www.brainstem.org/api/private/modules/dataacquisition/<id>/ - Responses:
200OK;403Not allowed;404Not found
Use example (Python API tool)
resp = client.load('dataacquisition', id='<id>')
record = resp.json()['data_acquisition']
Use example (MATLAB API tool)
out = client.load('dataacquisition', 'id', '<id>');
record = out.data_acquisition;
Response example
{
"data_acquisition": {
"id": "<id>",
"notes": "",
"session": "<session-id>",
"interfaces": [
"<experimentalinterface-id>"
],
"equipment": [
"<equipment-id>"
],
"type": "Audio",
"details": {
"...": "see the schema of the selected type"
},
"type_schema_version": "set by the server",
"image": "",
"order": 1
}
}
Change
- Allowed portals: private
- Request method: PATCH
- URL:
https://www.brainstem.org/api/private/modules/dataacquisition/<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('dataacquisition', id='<id>', data={"notes": "new value"})
Use example (MATLAB API tool)
client.save(struct('id', '<id>', 'notes', 'new value'), 'dataacquisition', 'method', 'patch');
Delete
- Allowed portals: private
- Request method: DELETE
- URL:
https://www.brainstem.org/api/private/modules/dataacquisition/<id>/ - Responses:
204Deleted;400Still referenced by other records;403Not allowed;404Not found
Use example (Python API tool)
resp = client.delete('dataacquisition', id='<id>')
Use example (MATLAB API tool)
client.delete('<id>', 'dataacquisition');
Data model
The fields are described for the web forms on the Data acquisition data model page.