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

ResourceWhat it isPortals
procedureSomething done to a subject, such as a surgery, an implant or an injection, with fields that depend on its type.private, public
procedureepisodeGroups the procedures and welfare logs of one perioperative event, for compliance records.private, public
procedurelogMeasurements followed over time for one procedure, such as the impedances of an implanted probe.private, public
subjectlogRecords followed over time for one subject, such as weight, food and water, or housing.private, public
specimenprocedureSomething done to a specimen set, such as sectioning, staining or clearing.private, public
specimenlogRecords followed over time for a specimen set, such as temperature, pH or slice health.private, public
experimentalinterfaceThe point where hardware meets the animal or tissue, such as an implanted probe, a cranial window or a fiber.private, public
materialusageOne material used in a procedure, such as a drug, a virus or a probe, with its amount and its source.private, public
dataacquisitionOne kind of data recorded in a session, such as electrophysiology, imaging or video, and where it is stored.private, public
manipulationA perturbation applied during a session, such as optogenetic or electrical stimulation.private, public
behaviorRecords which behavioral assay the subjects of a session performed, and in which setup.private, public
equipmentA device installed in a setup, such as an amplifier, a camera or a laser.private, public
consumablestockThe lab’s own stock of a consumable, such as a batch of virus or a box of probes, kept in an inventory.private, public
proceduretemplateA reusable template that prefills a new procedure.private, public
procedureepisodetemplateA reusable template that prefills a new procedure episode.private, public
specimenproceduretemplateA reusable template that prefills a new specimen procedure.private, public
experimentalinterfacetemplateA reusable template that prefills a new experimental interface.private, public
materialusagetemplateA reusable template that prefills a new material usage.private, public
dataacquisitiontemplateA reusable template that prefills a new data acquisition.private, public
manipulationtemplateA 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.

ResourceWhat it isPortals
dataacquisitioninterfaceData acquisition interface records.private, public
episodepersonnelEpisode personnel records.private, public
manipulationinterfaceManipulation interface records.private, public

All endpoints follow https://www.brainstem.org/api/{portal}/modules/{resource}/ and support the common query parameters.