Behavior API endpoint
Records which behavioral assay the subjects of a session performed, and in which setup.
Table of contents
Endpoints
- Private portal:
https://www.brainstem.org/api/private/modules/behavior/(needs a token; one record: append<id>/) - Public portal:
https://www.brainstem.org/api/public/modules/behavior/(read-only, public projects, no token) - Response keys:
behavior(detail, create, update),behaviors(list) - Permissions: inherited through
session→projects(fromproject) - Deleting: clears the link on
epochrecords
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] |
session | session id [required]; nestable |
subjects | list of subject ids [required]; nestable |
setup | setup id [required] |
behavioralassay | behavioralassay id [required] |
notes | string; max 500 characters; nullable |
order | number; nullable. Determines the order Behaviors are listed within a Session’s ‘Behaviors’ tab. |
List
- Allowed portals: private, public
- Request method: GET
- URL:
https://www.brainstem.org/api/private/modules/behavior/ - Responses:
200OK;401Not authenticated;403Not allowed
Use example (Python API tool)
resp = client.load('behavior', load_all=True)
records = resp['behaviors']
Use example (MATLAB API tool)
resp = client.load('behavior', 'load_all', true);
records = resp.behaviors;
Response example
{
"behaviors": [
{
"id": "<id>",
"session": "<session-id>",
"subjects": [
"<subject-id>"
],
"setup": "<setup-id>",
"behavioralassay": "<behavioralassay-id>",
"notes": "",
"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/behavior/ - 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('behavior', data={"session": "<session-id>", "subjects": ["<subject-id>"], "setup": "<setup-id>", "behavioralassay": "<behavioralassay-id>"})
record = resp.json()['behavior']
Use example (MATLAB API tool)
created = client.save(struct('session', '<session-id>', 'subjects', {{'<subject-id>'}}, 'setup', '<setup-id>', 'behavioralassay', '<behavioralassay-id>'), 'behavior');
record = created.behavior;
Detail
- Allowed portals: private, public
- Request method: GET
- URL:
https://www.brainstem.org/api/private/modules/behavior/<id>/ - Responses:
200OK;403Not allowed;404Not found
Use example (Python API tool)
resp = client.load('behavior', id='<id>')
record = resp.json()['behavior']
Use example (MATLAB API tool)
out = client.load('behavior', 'id', '<id>');
record = out.behavior;
Response example
{
"behavior": {
"id": "<id>",
"session": "<session-id>",
"subjects": [
"<subject-id>"
],
"setup": "<setup-id>",
"behavioralassay": "<behavioralassay-id>",
"notes": "",
"order": 1
}
}
Change
- Allowed portals: private
- Request method: PATCH
- URL:
https://www.brainstem.org/api/private/modules/behavior/<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('behavior', id='<id>', data={"notes": "new value"})
Use example (MATLAB API tool)
client.save(struct('id', '<id>', 'notes', 'new value'), 'behavior', 'method', 'patch');
Delete
- Allowed portals: private
- Request method: DELETE
- URL:
https://www.brainstem.org/api/private/modules/behavior/<id>/ - Responses:
204Deleted;400Still referenced by other records;403Not allowed;404Not found
Use example (Python API tool)
resp = client.delete('behavior', id='<id>')
Use example (MATLAB API tool)
client.delete('<id>', 'behavior');
Data model
The fields are described for the web forms on the Behavior data model page.