Relationships

How resources connect, as the queries that follow each link. A forward step reads ids on the record you already have; a reverse step asks the next resource for records pointing back. Collect ids, de-duplicate them and pass them on with filter{<field>.in}.

Table of contents

1. Single-hop routes
2. Questions with several branches
3. Delete behaviour

Single-hop routes

From → to	How
anatomicalregion → experimentalinterface	GET /api/private/modules/experimentalinterface/?filter{target_regions.in}=<ids>
anatomicalregion → procedure	GET /api/private/modules/procedure/?filter{target_regions.in}=<ids>
anatomicalregion → specimenprocedure	GET /api/private/modules/specimenprocedure/?filter{target_regions.in}=<ids>
anatomicalregion → specimenset	GET /api/private/stem/specimenset/?filter{target_regions.in}=<ids>
behavior → behavioralassay	read behavioralassay on each behavior record (one id)
behavior → session	read session on each behavior record (one id)
behavior → setup	read setup on each behavior record (one id)
behavior → subject	read subjects on each behavior record (list of ids)
behavioralassay → behavior	GET /api/private/modules/behavior/?filter{behavioralassay.in}=<ids>
behavioralassay → behavioralparadigm	read behavioral_paradigm on each behavioralassay record (one id)
behavioralparadigm → behavioralassay	GET /api/private/personal_attributes/behavioralassay/?filter{behavioral_paradigm.in}=<ids>
cohort → subject	read subjects on each cohort record (list of ids)
collection → session	read sessions on each collection record (list of ids)
consumable → consumablestock	GET /api/private/modules/consumablestock/?filter{consumable.in}=<ids>
consumable → materialusage	GET /api/private/modules/materialusage/?filter{consumable.in}=<ids>
consumablestock → consumable	read consumable on each consumablestock record (one id)
consumablestock → materialusage	GET /api/private/modules/materialusage/?filter{consumable_stock.in}=<ids>
dataacquisition → equipment	read equipment on each dataacquisition record (list of ids)
dataacquisition → experimentalinterface	read interfaces on each dataacquisition record (list of ids)
dataacquisition → session	read session on each dataacquisition record (one id)
epoch → session	GET /api/private/stem/session/?filter{epochs.in}=<ids>
equipment → dataacquisition	GET /api/private/modules/dataacquisition/?filter{equipment.in}=<ids>
equipment → experimentalinterface	GET /api/private/modules/experimentalinterface/?filter{equipment.in}=<ids>
equipment → setup	read setup on each equipment record (one id)
experimentalinterface → anatomicalregion	read target_regions on each experimentalinterface record (list of ids)
experimentalinterface → dataacquisition	GET /api/private/modules/dataacquisition/?filter{interfaces.in}=<ids>
experimentalinterface → equipment	read equipment on each experimentalinterface record (list of ids)
experimentalinterface → manipulation	GET /api/private/modules/manipulation/?filter{interfaces.in}=<ids>
experimentalinterface → materialusage	GET /api/private/modules/materialusage/?filter{experimental_interface.in}=<ids>
experimentalinterface → specimenset	read specimen_set on each experimentalinterface record (one id)
experimentalinterface → subject	read subject on each experimentalinterface record (one id)
manipulation → experimentalinterface	read interfaces on each manipulation record (list of ids)
manipulation → session	read session on each manipulation record (one id)
materialusage → consumable	read consumable on each materialusage record (one id)
materialusage → consumablestock	read consumable_stock on each materialusage record (one id)
materialusage → experimentalinterface	read experimental_interface on each materialusage record (one id)
materialusage → procedure	read procedure on each materialusage record (one id)
materialusage → specimenprocedure	read specimen_procedure on each materialusage record (one id)
procedure → anatomicalregion	read target_regions on each procedure record (list of ids)
procedure → materialusage	GET /api/private/modules/materialusage/?filter{procedure.in}=<ids>
procedure → procedurelog	GET /api/private/modules/procedurelog/?filter{procedure.in}=<ids>
procedure → subject	read subject on each procedure record (one id)
procedurelog → procedure	read procedure on each procedurelog record (one id)
project → session	GET /api/private/stem/session/?filter{projects.in}=<ids>
project → specimenset	GET /api/private/stem/specimenset/?filter{projects.in}=<ids>
project → subject	GET /api/private/stem/subject/?filter{projects.in}=<ids>
session → behavior	GET /api/private/modules/behavior/?filter{session.in}=<ids>
session → collection	GET /api/private/stem/collection/?filter{sessions.in}=<ids>
session → dataacquisition	GET /api/private/modules/dataacquisition/?filter{session.in}=<ids>
session → epoch	read epochs on each session record (list of ids)
session → manipulation	GET /api/private/modules/manipulation/?filter{session.in}=<ids>
session → project	read projects on each session record (list of ids)
session → specimenset	read specimen_sets on each session record (list of ids)
session → subject	read subjects on each session record (list of ids)
setup → behavior	GET /api/private/modules/behavior/?filter{setup.in}=<ids>
setup → equipment	GET /api/private/modules/equipment/?filter{setup.in}=<ids>
setup → setuptype	read setup_type on each setup record (one id)
setuptype → setup	GET /api/private/personal_attributes/setup/?filter{setup_type.in}=<ids>
species → subject	GET /api/private/stem/subject/?filter{species.in}=<ids>
specimen → specimenset	read specimen_set on each specimen record (one id)
specimenlog → specimenset	read specimen_set on each specimenlog record (one id)
specimenprocedure → anatomicalregion	read target_regions on each specimenprocedure record (list of ids)
specimenprocedure → materialusage	GET /api/private/modules/materialusage/?filter{specimen_procedure.in}=<ids>
specimenprocedure → specimenset	read specimen_set on each specimenprocedure record (one id)
specimenset → anatomicalregion	read target_regions on each specimenset record (list of ids)
specimenset → experimentalinterface	GET /api/private/modules/experimentalinterface/?filter{specimen_set.in}=<ids>
specimenset → project	read projects on each specimenset record (list of ids)
specimenset → session	GET /api/private/stem/session/?filter{specimen_sets.in}=<ids>
specimenset → specimen	GET /api/private/stem/specimen/?filter{specimen_set.in}=<ids>
specimenset → specimenlog	GET /api/private/modules/specimenlog/?filter{specimen_set.in}=<ids>
specimenset → specimenprocedure	GET /api/private/modules/specimenprocedure/?filter{specimen_set.in}=<ids>
specimenset → subject	read subject on each specimenset record (one id)
strain → subject	GET /api/private/stem/subject/?filter{strain.in}=<ids>
subject → behavior	GET /api/private/modules/behavior/?filter{subjects.in}=<ids>
subject → cohort	GET /api/private/stem/cohort/?filter{subjects.in}=<ids>
subject → experimentalinterface	GET /api/private/modules/experimentalinterface/?filter{subject.in}=<ids>
subject → procedure	GET /api/private/modules/procedure/?filter{subject.in}=<ids>
subject → project	read projects on each subject record (list of ids)
subject → session	GET /api/private/stem/session/?filter{subjects.in}=<ids>
subject → species	read species on each subject record (one id)
subject → specimenset	GET /api/private/stem/specimenset/?filter{subject.in}=<ids>
subject → strain	read strain on each subject record (one id)
subject → subjectlog	GET /api/private/modules/subjectlog/?filter{subject.in}=<ids>
subjectlog → subject	read subject on each subjectlog record (one id)

Questions with several branches

session → anatomicalregion

Where a session’s recordings or manipulations were targeted, through the interfaces they used. For specimen sessions the set’s own target regions apply.

• session>dataacquisition → dataacquisition>experimentalinterface → experimentalinterface>anatomicalregion
• session>manipulation → manipulation>experimentalinterface → experimentalinterface>anatomicalregion
• session>specimenset → specimenset>anatomicalregion

session → behavioralparadigm

Behavioral paradigms run in a session.

• session>behavior → behavior>behavioralassay → behavioralassay>behavioralparadigm

session → consumable

Which probe designs, viruses or reagents a session’s recordings used, through interface materials.

• session>dataacquisition → dataacquisition>experimentalinterface → experimentalinterface>materialusage → materialusage>consumable
• session>dataacquisition → dataacquisition>experimentalinterface → experimentalinterface>materialusage → materialusage>consumablestock → consumablestock>consumable
• session>manipulation → manipulation>experimentalinterface → experimentalinterface>materialusage → materialusage>consumable
• session>manipulation → manipulation>experimentalinterface → experimentalinterface>materialusage → materialusage>consumablestock → consumablestock>consumable

session → setuptype

Setup types used in a session: behavior setups, or the setups of recording equipment.

• session>behavior → behavior>setup → setup>setuptype
• session>dataacquisition → dataacquisition>equipment → equipment>setup → setup>setuptype

session → species

Species of the animals in a session, directly or through the subject a specimen set came from.

• session>subject → subject>species
• session>specimenset → specimenset>subject → subject>species

subject → anatomicalregion

Regions targeted on a subject: by its procedures, its interfaces, or specimen sets taken from it.

• subject>procedure → procedure>anatomicalregion
• subject>experimentalinterface → experimentalinterface>anatomicalregion
• subject>specimenset → specimenset>anatomicalregion

subject → consumable

Materials used on a subject: in its procedures or built into its interfaces.

• subject>procedure → procedure>materialusage → materialusage>consumable
• subject>procedure → procedure>materialusage → materialusage>consumablestock → consumablestock>consumable
• subject>experimentalinterface → experimentalinterface>materialusage → materialusage>consumable
• subject>experimentalinterface → experimentalinterface>materialusage → materialusage>consumablestock → consumablestock>consumable

Delete behaviour

What happens to a record when a record it points to is deleted: cascade deletes it too, protect refuses the deletion while it exists, set null clears the link.

Record	Field	Points to	On delete
anatomicalreference	species	species	protect
anatomicalregion	reference	anatomicalreference	protect
anatomicalregion	replaced_by	anatomicalregion	set null
anatomicalregion	user	user	set null
behavior	behavioralassay	behavioralassay	protect
behavior	session	session	cascade
behavior	setup	setup	protect
behavior	user	user	cascade
behavioralassay	behavioral_paradigm	behavioralparadigm	protect
behavioralassay	setup_type	setuptype	protect
behavioralassay	user	user	cascade
behavioralassaygroupmembershipinvitation	behavioralassay	behavioralassay	cascade
behavioralassaygroupmembershipinvitation	invitee	group	cascade
behavioralassaygroupmembershipinvitation	user	user	cascade
behavioralassaymembershipinvitation	behavioralassay	behavioralassay	cascade
behavioralassaymembershipinvitation	invitee	user	cascade
behavioralassaymembershipinvitation	user	user	cascade
behavioralcategory	parent	behavioralcategory	protect
behavioralcategory	user	user	cascade
behavioralcategoryapproval	parent	behavioralcategoryapproval	protect
behavioralcategoryapproval	reviewer	user	cascade
behavioralcategoryapproval	user	user	cascade
behavioralparadigm	category	behavioralcategory	protect
behavioralparadigm	user	user	cascade
behavioralparadigmapproval	category	behavioralcategory	protect
behavioralparadigmapproval	reviewer	user	cascade
behavioralparadigmapproval	user	user	cascade
breeding	father	subject	protect
breeding	mother	subject	protect
breeding	project	project	cascade
breeding	user	user	cascade
cohort	project	project	cascade
cohort	user	user	cascade
collection	project	project	cascade
collection	user	user	cascade
consumable	supplier	supplier	protect
consumable	user	user	cascade
consumableapproval	reviewer	user	cascade
consumableapproval	supplier	supplier	protect
consumableapproval	user	user	cascade
consumablestock	consumable	consumable	protect
consumablestock	inventory	inventory	protect
consumablestock	user	user	cascade
coordinatetransform	anatomical_reference	anatomicalreference	protect
dataacquisition	session	session	cascade
dataacquisition	user	user	cascade
dataacquisitiontemplate	user	user	cascade
datastorage	user	user	cascade
datastoragegroupmembershipinvitation	datastorage	datastorage	cascade
datastoragegroupmembershipinvitation	invitee	group	cascade
datastoragegroupmembershipinvitation	user	user	cascade
datastoragemembershipinvitation	datastorage	datastorage	cascade
datastoragemembershipinvitation	invitee	user	cascade
datastoragemembershipinvitation	user	user	cascade
epoch	behavior	behavior	set null
epoch	session	session	cascade
epoch	user	user	cascade
equipment	consumable	consumable	protect
equipment	hardwaredevice	hardwaredevice	protect
equipment	setup	setup	protect
equipment	user	user	cascade
experimentalinterface	source_material_usage	materialusage	set null
experimentalinterface	specimen_set	specimenset	cascade
experimentalinterface	subject	subject	cascade
experimentalinterface	user	user	cascade
experimentalinterfacetemplate	user	user	cascade
groupmembershipinvitation	authgroup	group	cascade
groupmembershipinvitation	user	user	cascade
groupmembershipinvitation	user_account_invitation	user	cascade
groupmembershiprequest	authgroup	group	cascade
groupmembershiprequest	user	user	cascade
groupmembershiprequest	user_account_request	user	cascade
hardwaredevice	supplier	supplier	protect
hardwaredevice	user	user	cascade
hardwaredeviceapproval	reviewer	user	cascade
hardwaredeviceapproval	supplier	supplier	protect
hardwaredeviceapproval	user	user	cascade
inventory	user	user	cascade
inventorygroupmembershipinvitation	inventory	inventory	cascade
inventorygroupmembershipinvitation	invitee	group	cascade
inventorygroupmembershipinvitation	user	user	cascade
inventorymembershipinvitation	inventory	inventory	cascade
inventorymembershipinvitation	invitee	user	cascade
inventorymembershipinvitation	user	user	cascade
journal	user	user	cascade
journalapproval	reviewer	user	cascade
journalapproval	user	user	cascade
laboratory	group	group	cascade
laboratory	user	user	cascade
license	regulatory_authority	regulatoryauthority	protect
license	user	user	cascade
licensegroupmembershipinvitation	invitee	group	cascade
licensegroupmembershipinvitation	license	license	cascade
licensegroupmembershipinvitation	user	user	cascade
licensemembershipinvitation	invitee	user	cascade
licensemembershipinvitation	license	license	cascade
licensemembershipinvitation	user	user	cascade
manipulation	session	session	cascade
manipulation	user	user	cascade
manipulationtemplate	user	user	cascade
materialusage	consumable	consumable	protect
materialusage	consumable_stock	consumablestock	protect
materialusage	copied_from	materialusage	set null
materialusage	experimental_interface	experimentalinterface	cascade
materialusage	procedure	procedure	cascade
materialusage	specimen_procedure	specimenprocedure	cascade
materialusage	user	user	cascade
materialusagetemplate	consumable	consumable	protect
materialusagetemplate	experimental_interface_template	experimentalinterfacetemplate	cascade
materialusagetemplate	procedure_template	proceduretemplate	cascade
materialusagetemplate	specimen_procedure_template	specimenproceduretemplate	cascade
materialusagetemplate	user	user	cascade
pendinginvitation	user	user	cascade
procedure	anatomical_reference	anatomicalreference	protect
procedure	coordinate_transform	coordinatetransform	protect
procedure	performed_by	user	set null
procedure	procedure_episode	procedureepisode	set null
procedure	protocol	protocol	protect
procedure	subject	subject	cascade
procedure	user	user	cascade
procedureepisode	protocol	protocol	protect
procedureepisode	subject	subject	protect
procedureepisode	user	user	cascade
procedureepisodetemplate	protocol	protocol	protect
procedureepisodetemplate	user	user	cascade
procedurelog	procedure	procedure	cascade
procedurelog	user	user	cascade
proceduretemplate	protocol	protocol	protect
proceduretemplate	user	user	cascade
project	user	user	cascade
projectgroupmembershipinvitation	invitee	group	cascade
projectgroupmembershipinvitation	project	project	cascade
projectgroupmembershipinvitation	user	user	cascade
projectmembershipinvitation	invitee	user	cascade
projectmembershipinvitation	project	project	cascade
projectmembershipinvitation	user	user	cascade
protocol	user	user	cascade
protocolgroupmembershipinvitation	invitee	group	cascade
protocolgroupmembershipinvitation	protocol	protocol	cascade
protocolgroupmembershipinvitation	user	user	cascade
protocolmembershipinvitation	invitee	user	cascade
protocolmembershipinvitation	protocol	protocol	cascade
protocolmembershipinvitation	user	user	cascade
publication	journal	journal	protect
publication	user	user	cascade
publicationapproval	journal	journal	protect
publicationapproval	reviewer	user	cascade
publicationapproval	user	user	cascade
regulatoryauthority	user	user	cascade
regulatoryauthorityapproval	reviewer	user	cascade
regulatoryauthorityapproval	user	user	cascade
session	user	user	cascade
setup	setup_type	setuptype	protect
setup	user	user	cascade
setupgroupmembershipinvitation	invitee	group	cascade
setupgroupmembershipinvitation	setup	setup	cascade
setupgroupmembershipinvitation	user	user	cascade
setupmembershipinvitation	invitee	user	cascade
setupmembershipinvitation	setup	setup	cascade
setupmembershipinvitation	user	user	cascade
setuptype	user	user	cascade
setuptypeapproval	reviewer	user	cascade
setuptypeapproval	user	user	cascade
species	user	user	cascade
speciesapproval	reviewer	user	cascade
speciesapproval	user	user	cascade
specimen	source_specimen	specimen	set null
specimen	specimen_set	specimenset	cascade
specimen	user	user	cascade
specimenlog	protocol	protocol	set null
specimenlog	specimen_set	specimenset	cascade
specimenlog	user	user	cascade
specimenprocedure	protocol	protocol	set null
specimenprocedure	specimen_set	specimenset	cascade
specimenprocedure	user	user	cascade
specimenproceduretemplate	protocol	protocol	set null
specimenproceduretemplate	user	user	cascade
specimenset	source_specimen_set	specimenset	set null
specimenset	subject	subject	set null
specimenset	user	user	cascade
strain	species	species	protect
strain	user	user	cascade
strainapproval	reviewer	user	cascade
strainapproval	species	species	protect
strainapproval	user	user	cascade
subject	breeding	breeding	set null
subject	species	species	protect
subject	strain	strain	protect
subject	supplier	supplier	protect
subject	user	user	cascade
subjectlog	protocol	protocol	protect
subjectlog	subject	subject	cascade
subjectlog	user	user	cascade
supplier	user	user	cascade
supplierapproval	reviewer	user	cascade
supplierapproval	user	user	cascade