Consumable API endpoint
The shared catalogue of single-use products, such as probe designs, virus constructs and reagents.
Table of contents
Endpoints
- Private portal:
https://www.brainstem.org/api/private/resources/consumable/(needs a token; one record: append<id>/) - Public portal:
https://www.brainstem.org/api/public/resources/consumable/(read-only, public projects, no token) - Response keys:
consumable(detail, create, update),consumables(list) - Permissions: see the permissions page
- Uniqueness:
nameunique across BrainSTEM - Uniqueness:
name,supplierunique together - Schema payload:
typeselects a Consumable type; send its fields indetails.type_schema_versionis set by the server; do not send it. - Deleting: refused (400) while
consumablestock,equipment,materialusage,materialusagetemplaterecords 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 100 characters |
description | string; max 2000 characters |
supplier | supplier id [required] |
type | one of the Consumable types [required] |
details | JSON object |
rrid | string; max 100 characters; nullable. Research Resource Identifier (RRID) for tracking standardized research resources |
rrid_url | string [read-only] |
external_identifiers | JSON object; nullable. External identifiers and their source URLs from various databases (NCBI, JAX, DOI, etc.) |
comments | string |
List
- Allowed portals: private, public
- Request method: GET
- URL:
https://www.brainstem.org/api/private/resources/consumable/ - Responses:
200OK;401Not authenticated;403Not allowed
Use example (Python API tool)
resp = client.load('consumable', load_all=True)
records = resp['consumables']
Use example (MATLAB API tool)
resp = client.load('consumable', 'load_all', true);
records = resp.consumables;
Response example
{
"consumables": [
{
"id": "<id>",
"name": "Consumable 1",
"description": "",
"supplier": "<supplier-id>",
"type": "ImmunoReagent",
"details": {
"...": "see the schema of the selected type"
},
"rrid": "",
"rrid_url": "",
"external_identifiers": {},
"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/resources/consumable/ - 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('consumable', data={"name": "Consumable 1", "supplier": "<supplier-id>", "type": "AdhesiveCement", "details": {"...": "see the schema of the selected type"}})
record = resp.json()['consumable']
Use example (MATLAB API tool)
created = client.save(struct('name', 'Consumable 1', 'supplier', '<supplier-id>', 'type', 'AdhesiveCement', 'details', struct()), 'consumable'); % struct() stands for the fields of the selected type
record = created.consumable;
Detail
- Allowed portals: private, public
- Request method: GET
- URL:
https://www.brainstem.org/api/private/resources/consumable/<id>/ - Responses:
200OK;403Not allowed;404Not found
Use example (Python API tool)
resp = client.load('consumable', id='<id>')
record = resp.json()['consumable']
Use example (MATLAB API tool)
out = client.load('consumable', 'id', '<id>');
record = out.consumable;
Response example
{
"consumable": {
"id": "<id>",
"name": "Consumable 1",
"description": "",
"supplier": "<supplier-id>",
"type": "ImmunoReagent",
"details": {
"...": "see the schema of the selected type"
},
"rrid": "",
"rrid_url": "",
"external_identifiers": {},
"comments": ""
}
}
Change
- Allowed portals: private
- Request method: PATCH
- URL:
https://www.brainstem.org/api/private/resources/consumable/<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('consumable', id='<id>', data={"name": "Consumable 1 (renamed)"})
Use example (MATLAB API tool)
client.save(struct('id', '<id>', 'name', 'Consumable 1 (renamed)'), 'consumable', 'method', 'patch');
Delete
- Allowed portals: private
- Request method: DELETE
- URL:
https://www.brainstem.org/api/private/resources/consumable/<id>/ - Responses:
204Deleted;400Still referenced by other records;403Not allowed;404Not found
Use example (Python API tool)
resp = client.delete('consumable', id='<id>')
Use example (MATLAB API tool)
client.delete('<id>', 'consumable');
Data model
The fields are described for the web forms on the Consumable data model page.