Setup type API endpoint
A shared classification of experimental preparations, such as head-fixed or freely moving.
Table of contents
Endpoints
- Private portal:
https://www.brainstem.org/api/private/taxonomies/setuptype/(needs a token; one record: append<id>/) - Public portal:
https://www.brainstem.org/api/public/taxonomies/setuptype/(read-only, public projects, no token) - Response keys:
setup_type(detail, create, update),setup_types(list) - Permissions: see the permissions page
- Uniqueness:
nameunique across BrainSTEM - Deleting: refused (400) while
behavioralassay,setuprecords point to it
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] |
name | string [required]; max 200 characters |
description | string; max 2000 characters |
category | one of I, E, A, HA, RA, FA, U [required] |
biological_preparation | string [read-only] |
physiological_state | string [read-only] |
constraint_level | string [read-only] |
comments | string |
List
- Allowed portals: private, public
- Request method: GET
- URL:
https://www.brainstem.org/api/private/taxonomies/setuptype/ - Responses:
200OK;401Not authenticated;403Not allowed
Use example (Python API tool)
resp = client.load('setuptype', load_all=True)
records = resp['setup_types']
Use example (MATLAB API tool)
resp = client.load('setuptype', 'load_all', true);
records = resp.setup_types;
Response example
{
"setup_types": [
{
"id": "<id>",
"name": "Setup type 1",
"description": "",
"category": "I",
"biological_preparation": "",
"physiological_state": "",
"constraint_level": "",
"comments": ""
}
],
"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/taxonomies/setuptype/ - 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('setuptype', data={"name": "Setup type 1", "category": "I"})
record = resp.json()['setup_type']
Use example (MATLAB API tool)
created = client.save(struct('name', 'Setup type 1', 'category', 'I'), 'setuptype');
record = created.setup_type;
Detail
- Allowed portals: private, public
- Request method: GET
- URL:
https://www.brainstem.org/api/private/taxonomies/setuptype/<id>/ - Responses:
200OK;403Not allowed;404Not found
Use example (Python API tool)
resp = client.load('setuptype', id='<id>')
record = resp.json()['setup_type']
Use example (MATLAB API tool)
out = client.load('setuptype', 'id', '<id>');
record = out.setup_type;
Response example
{
"setup_type": {
"id": "<id>",
"name": "Setup type 1",
"description": "",
"category": "I",
"biological_preparation": "",
"physiological_state": "",
"constraint_level": "",
"comments": ""
}
}
Change
- Allowed portals: private
- Request method: PATCH
- URL:
https://www.brainstem.org/api/private/taxonomies/setuptype/<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('setuptype', id='<id>', data={"name": "Setup type 1 (renamed)"})
Use example (MATLAB API tool)
client.save(struct('id', '<id>', 'name', 'Setup type 1 (renamed)'), 'setuptype', 'method', 'patch');
Delete
- Allowed portals: private
- Request method: DELETE
- URL:
https://www.brainstem.org/api/private/taxonomies/setuptype/<id>/ - Responses:
204Deleted;400Still referenced by other records;403Not allowed;404Not found
Use example (Python API tool)
resp = client.delete('setuptype', id='<id>')
Use example (MATLAB API tool)
client.delete('<id>', 'setuptype');
Data model
The fields are described for the web forms on the Setup type data model page.
Usage notes
categorycodes:IIn Vitro,EEx Vivo,AAnesthetized In Vivo,HAHead-Fixed Awake,RARestrained Awake,FAFreely Moving Awake,UUnknown. The Setup types data model page explains each category.