Group API endpoint
A set of users, such as a lab or a team, that can be given a role as one.
Table of contents
Endpoints
- Private portal:
https://www.brainstem.org/api/private/users/group/(needs a token; one record: append<id>/) - Public portal:
https://www.brainstem.org/api/public/users/group/(read-only, public projects, no token) - Response keys:
group(detail, create, update),groups(list) - Permissions: see the permissions page
- Uniqueness:
nameunique across BrainSTEM - Deleting: also deletes the linked
behavioralassaygroupmembershipinvitation,datastoragegroupmembershipinvitation,groupmembershipinvitation,groupmembershiprequest,inventorygroupmembershipinvitation,laboratory,licensegroupmembershipinvitation,projectgroupmembershipinvitation,protocolgroupmembershipinvitation,setupgroupmembershipinvitationrecords
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 | number [read-only] |
name | string [required]; max 150 characters |
users | computed [read-only] |
List
- Allowed portals: private, public
- Request method: GET
- URL:
https://www.brainstem.org/api/private/users/group/ - Responses:
200OK;401Not authenticated;403Not allowed
Use example (Python API tool)
resp = client.load('group', load_all=True)
records = resp['groups']
Use example (MATLAB API tool)
resp = client.load('group', 'load_all', true);
records = resp.groups;
Response example
{
"groups": [
{
"id": 1,
"name": "Group 1",
"users": null
}
],
"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/group/ - 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('group', data={"name": "Group 1"})
record = resp.json()['group']
Use example (MATLAB API tool)
created = client.save(struct('name', 'Group 1'), 'group');
record = created.group;
Detail
- Allowed portals: private, public
- Request method: GET
- URL:
https://www.brainstem.org/api/private/users/group/<id>/ - Responses:
200OK;403Not allowed;404Not found
Use example (Python API tool)
resp = client.load('group', id='<id>')
record = resp.json()['group']
Use example (MATLAB API tool)
out = client.load('group', 'id', '<id>');
record = out.group;
Response example
{
"group": {
"id": 1,
"name": "Group 1",
"users": null
}
}
Change
- Allowed portals: private
- Request method: PATCH
- URL:
https://www.brainstem.org/api/private/users/group/<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('group', id='<id>', data={"name": "Group 1 (renamed)"})
Use example (MATLAB API tool)
client.save(struct('id', '<id>', 'name', 'Group 1 (renamed)'), 'group', 'method', 'patch');
Delete
- Allowed portals: private
- Request method: DELETE
- URL:
https://www.brainstem.org/api/private/users/group/<id>/ - Responses:
204Deleted;400Still referenced by other records;403Not allowed;404Not found
Use example (Python API tool)
resp = client.delete('group', id='<id>')
Use example (MATLAB API tool)
client.delete('<id>', 'group');
Custom actions
| Action | Request |
|---|---|
join_group | POST /api/private/users/group/<id>/join/ |
leave_group | POST /api/private/users/group/<id>/leave/ |
Usage notes
usersis read-only. Members join through a group membership invitation sent by a manager, or through a membership request that a manager accepts.