Link Search Menu Expand Document

Subject model

Table of contents

  1. Introduction
  2. Fields
    1. Action data fields
    2. Subject state change data fields
  3. Permissions
  4. Subject API access

Introduction

The subject model describes your animal subject through a set of standard fields. There is flexibility built through a rich text description field, extra fields, and tags. Actions and Subject state change provides modular construction that can describe procedures and other things performed on your subject based on three modules:

  1. Actions: Surgical procedures and other actions performed on the environment (e.g.: probe implantations, virus injections, and optic fiber implants)
  2. Subject state changes: Any state change performed on a subject (e.g.: perfusion of the brain, lesion, creation of brain slices)

Fields

FieldDescription
NameName of the subject (required; maximum length: 100 characters; must be unique)
ProjectsProjects the subject belongs to (required)
SexSex of the animal: (Male, Female, or Unknown; required)
StrainThe strain of the subject(required)
DescriptionA rich text description of the subject
Genetic lineGenetic line of the subject. Could also be wild type (string; maximum length: 100 characters)
Birth dateBirth date of the animal subject (e.g. “2023-03-22”)
Death dateDeath date of the animal subject (e.g. “2023-03-25”)
TagsTags for the subject. Tags are great for organizational purpose, to quickly label a subject and can be used as a filter afterwards.
Name used in repositoryUse this field if you have another name of your subject (string; maximum length: 100 characters)
Extra fieldsAllows you to add extra fields to the subject. The values can be a string or a numeric value.

Action data fields

Please see the dedicated page describing the [Action data model].

Subject state change data fields

Please see the dedicated page describing the [Subject state change data model].

Permissions

Subjects inherit permissions from projects associated with them. Actions, Subject state changes, Subject logs and action logs all inherit permissions through the subject.

Visit the [permissions page] to learn more.

Subject API access

The API allows for programmable access to subjects. Learn more about the subjects’ fields and data structure on the Subject API page.