Laboratory API endpoint
Table of contents
Endpoints
- Private portal:
https://www.brainstem.org/api/private/users/laboratory/(needs a token; one record: append<id>/) - Public portal:
https://www.brainstem.org/api/public/users/laboratory/(read-only, public projects, no token) - Response keys:
laboratory(detail, create, update),laboratories(list) - Permissions: see the permissions page
- Uniqueness:
groupunique across BrainSTEM
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] |
group | group id [required]; nullable |
principal_investigators | list of user ids [required] |
description | string; max 500 characters |
website | string; max 200 characters |
department | string; max 100 characters |
institution | string [required]; max 100 characters |
city | string; max 100 characters |
country | string; max 100 characters |
List
- Allowed portals: private, public
- Request method: GET
- URL:
https://www.brainstem.org/api/private/users/laboratory/ - Responses:
200OK;401Not authenticated;403Not allowed
Use example (Python API tool)
resp = client.load('laboratory', load_all=True)
records = resp['laboratories']
Use example (MATLAB API tool)
resp = client.load('laboratory', 'load_all', true);
records = resp.laboratories;
Response example
{
"laboratories": [
{
"id": "<id>",
"group": "<group-id>",
"principal_investigators": [
"<user-id>"
],
"description": "",
"website": "",
"department": "",
"institution": "",
"city": "",
"country": ""
}
],
"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/users/laboratory/ - 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('laboratory', data={"group": "<group-id>", "principal_investigators": ["<user-id>"], "institution": "<institution>"})
record = resp.json()['laboratory']
Use example (MATLAB API tool)
created = client.save(struct('group', '<group-id>', 'principal_investigators', {{'<user-id>'}}, 'institution', '<institution>'), 'laboratory');
record = created.laboratory;
Detail
- Allowed portals: private, public
- Request method: GET
- URL:
https://www.brainstem.org/api/private/users/laboratory/<id>/ - Responses:
200OK;403Not allowed;404Not found
Use example (Python API tool)
resp = client.load('laboratory', id='<id>')
record = resp.json()['laboratory']
Use example (MATLAB API tool)
out = client.load('laboratory', 'id', '<id>');
record = out.laboratory;
Response example
{
"laboratory": {
"id": "<id>",
"group": "<group-id>",
"principal_investigators": [
"<user-id>"
],
"description": "",
"website": "",
"department": "",
"institution": "",
"city": "",
"country": ""
}
}
Change
- Allowed portals: private
- Request method: PATCH
- URL:
https://www.brainstem.org/api/private/users/laboratory/<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('laboratory', id='<id>', data={"description": "new value"})
Use example (MATLAB API tool)
client.save(struct('id', '<id>', 'description', 'new value'), 'laboratory', 'method', 'patch');
Delete
- Allowed portals: private
- Request method: DELETE
- URL:
https://www.brainstem.org/api/private/users/laboratory/<id>/ - Responses:
204Deleted;400Still referenced by other records;403Not allowed;404Not found
Use example (Python API tool)
resp = client.delete('laboratory', id='<id>')
Use example (MATLAB API tool)
client.delete('<id>', 'laboratory');