STEM API endpoints

The STEM app holds the core records of a study: projects, the subjects and specimen sets studied in them, the sessions in which data was recorded, and the cohorts, collections, breedings and epochs that organize them. Permissions for every other record derive from these.

Resources

Resource	What it is	Portals
project	Groups the subjects, sessions and specimens of a study and sets who can see and edit them.	private, public
subject	An animal in a study, described by its species, strain, sex and the procedures and logs recorded for it.	private, public
session	One experimental session, described by the behaviors, data acquisition and manipulations that took place in it.	private, public
specimenset	Tissue or cultures prepared together, such as a slice series or a well plate, usually taken from a subject.	private, public
specimen	One item of a specimen set, such as a single slice, section or well.	private, public
cohort	A named subgroup of a project’s subjects, for an analysis or an experimental group.	private, public
collection	A named subgroup of a project’s sessions, for an analysis or a figure.	private, public
breeding	A breeding pair, the dam and the sire, with the litters it produced.	private, public
epoch	A stretch of a session, such as a baseline or a stimulation block, with the behavior, data acquisition and manipulations recorded in it.	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
cohortsubject	Cohort subject records.	private, public
collectionsession	Collection session records.	private, public
projectgroupmembershipinvitation	Table to store invitations for groups to join a project. When any user in the group accepts / rejects the invitation, this record will be deleted.	private
projectmembershipinvitation	Table to store invitations for members to join a project. When the user accepts / rejects the invitation, this record will be deleted.	private
sessiondatastorage	Session data storage records.	private, public

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