Inventory API endpoint
A place where the lab keeps track of its consumable stock.
Table of contents
Endpoints
- Private portal:
https://www.brainstem.org/api/private/personal_attributes/inventory/(needs a token; one record: append<id>/) - Public portal:
https://www.brainstem.org/api/public/personal_attributes/inventory/(read-only, public projects, no token) - Response keys:
inventory(detail, create, update),inventories(list) - Permissions: object permissions on the record itself (member / manager / owner roles)
- Deleting: also deletes the linked
inventorygroupmembershipinvitation,inventorymembershipinvitationrecords; refused (400) whileconsumablestockrecords 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 50 characters |
location | string; max 100 characters; nullable. Location of the inventory, e.g., “Room 302, Cabinet B, ESD-safe storage” or “-80°C Freezer, Bay 3, Boxes V1-V10”. |
description | string; nullable |
is_public | boolean. Designates if the inventory is publicly available |
users | computed [read-only] |
groups | computed [read-only] |
List
- Allowed portals: private, public
- Request method: GET
- URL:
https://www.brainstem.org/api/private/personal_attributes/inventory/ - Responses:
200OK;401Not authenticated;403Not allowed
Use example (Python API tool)
resp = client.load('inventory', load_all=True)
records = resp['inventories']
Use example (MATLAB API tool)
resp = client.load('inventory', 'load_all', true);
records = resp.inventories;
Response example
{
"inventories": [
{
"id": "<id>",
"name": "Inventory 1",
"location": "",
"description": "",
"is_public": true,
"users": null,
"groups": 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/personal_attributes/inventory/ - 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('inventory', data={"name": "Inventory 1"})
record = resp.json()['inventory']
Use example (MATLAB API tool)
created = client.save(struct('name', 'Inventory 1'), 'inventory');
record = created.inventory;
Detail
- Allowed portals: private, public
- Request method: GET
- URL:
https://www.brainstem.org/api/private/personal_attributes/inventory/<id>/ - Responses:
200OK;403Not allowed;404Not found
Use example (Python API tool)
resp = client.load('inventory', id='<id>')
record = resp.json()['inventory']
Use example (MATLAB API tool)
out = client.load('inventory', 'id', '<id>');
record = out.inventory;
Response example
{
"inventory": {
"id": "<id>",
"name": "Inventory 1",
"location": "",
"description": "",
"is_public": true,
"users": null,
"groups": null
}
}
Change
- Allowed portals: private
- Request method: PATCH
- URL:
https://www.brainstem.org/api/private/personal_attributes/inventory/<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('inventory', id='<id>', data={"name": "Inventory 1 (renamed)"})
Use example (MATLAB API tool)
client.save(struct('id', '<id>', 'name', 'Inventory 1 (renamed)'), 'inventory', 'method', 'patch');
Delete
- Allowed portals: private
- Request method: DELETE
- URL:
https://www.brainstem.org/api/private/personal_attributes/inventory/<id>/ - Responses:
204Deleted;400Still referenced by other records;403Not allowed;404Not found
Use example (Python API tool)
resp = client.delete('inventory', id='<id>')
Use example (MATLAB API tool)
client.delete('<id>', 'inventory');
Custom actions
| Action | Request |
|---|---|
leave | POST /api/private/personal_attributes/inventory/<id>/leave/ |
Data model
The fields are described for the web forms on the Inventory data model page.