Modules API endpoints
The Modules app holds what was done and recorded: procedures and specimen procedures with their material usages and procedure episodes, the experimental interfaces they create (implants, windows, fibers), data acquisition, manipulations and behaviors in sessions, logs followed over time, equipment, consumable stock, and reusable templates for each of them.
Resources
| Resource | What it is | Portals |
|---|---|---|
procedure | Something done to a subject, such as a surgery, an implant or an injection, with fields that depend on its type. | private, public |
procedureepisode | Groups the procedures and welfare logs of one perioperative event, for compliance records. | private, public |
procedurelog | Measurements followed over time for one procedure, such as the impedances of an implanted probe. | private, public |
subjectlog | Records followed over time for one subject, such as weight, food and water, or housing. | private, public |
specimenprocedure | Something done to a specimen set, such as sectioning, staining or clearing. | private, public |
specimenlog | Records followed over time for a specimen set, such as temperature, pH or slice health. | private, public |
experimentalinterface | The point where hardware meets the animal or tissue, such as an implanted probe, a cranial window or a fiber. | private, public |
materialusage | One material used in a procedure, such as a drug, a virus or a probe, with its amount and its source. | private, public |
dataacquisition | One kind of data recorded in a session, such as electrophysiology, imaging or video, and where it is stored. | private, public |
manipulation | A perturbation applied during a session, such as optogenetic or electrical stimulation. | private, public |
behavior | Records which behavioral assay the subjects of a session performed, and in which setup. | private, public |
equipment | A device installed in a setup, such as an amplifier, a camera or a laser. | private, public |
consumablestock | The lab’s own stock of a consumable, such as a batch of virus or a box of probes, kept in an inventory. | private, public |
proceduretemplate | A reusable template that prefills a new procedure. | private, public |
procedureepisodetemplate | A reusable template that prefills a new procedure episode. | private, public |
specimenproceduretemplate | A reusable template that prefills a new specimen procedure. | private, public |
experimentalinterfacetemplate | A reusable template that prefills a new experimental interface. | private, public |
materialusagetemplate | A reusable template that prefills a new material usage. | private, public |
dataacquisitiontemplate | A reusable template that prefills a new data acquisition. | private, public |
manipulationtemplate | A reusable template that prefills a new manipulation. | private, public |
Supporting endpoints
Approval requests, membership invitations and link tables. Most workflows never call these directly; the main resources create and resolve them.
| Resource | What it is | Portals |
|---|---|---|
dataacquisitioninterface | Data acquisition interface records. | private, public |
episodepersonnel | Episode personnel records. | private, public |
manipulationinterface | Manipulation interface records. | private, public |
All endpoints follow https://www.brainstem.org/api/{portal}/modules/{resource}/ and support the common query parameters.