Breeding API endpoint

Table of contents

1. Fields
2. List view
3. Add
4. Detail
5. Change
6. Delete

Fields

Field	Description
id	UUID identificator formatted as a string
name	string [required] [max length: 100]
project	related project ID formatted as a string [required]
mother	related maternal subject ID formatted as a string [required]
father	related paternal subject ID formatted as a string [required]
description	string
tags	list of strings
birth_date	date (YYYY-MM-DD)
start_date	date (YYYY-MM-DD)
end_date	date (YYYY-MM-DD)
weaning_date	date (YYYY-MM-DD)
litter_size	positive integer
expected_genotype	string [max length: 100]

List view

• Allowed portals: public, private
• Request method: GET
• URL: https://www.brainstem.org/api/private/stem/breeding
• Data: None
• Responses: 200 OK; 403 Not allowed; 404 Not found

Use example (using Python API)

resp = client.load_model('breeding')

Response example

{'breedings': [
        {
            'id': '00000000-0000-0000-0000-000000000000',
            'name': 'B6J x PV-Cre Spring 2026',
            'project': '00000000-0000-0000-0000-000000000000',
            'mother': '00000000-0000-0000-0000-000000000000',
            'father': '00000000-0000-0000-0000-000000000000'
        }
    ]
}

Public list responses also include a meta object (pagination/filter metadata).

Add

• Allowed portals: private
• Request method: POST
• URL: https://www.brainstem.org/api/private/stem/breeding
• Data: JSON dictionary containing at least the required fields.
• Responses: 201 OK; 400 Bad request; 403 Not allowed; 404 Not found

Additional notes: both mother and father must already belong to the same project as the breeding.

Use example (using Python API)

resp = client.save_model("breeding", data={
    "name": "NewBreeding",
    "project": "00000000-0000-0000-0000-000000000000",
    "mother": "00000000-0000-0000-0000-000000000000",
    "father": "00000000-0000-0000-0000-000000000000"
})

Response example

{'breeding': {
    'id': '00000000-0000-0000-0000-000000000000',
    'name': 'NewBreeding',
    'project': '00000000-0000-0000-0000-000000000000',
    'mother': '00000000-0000-0000-0000-000000000000',
    'father': '00000000-0000-0000-0000-000000000000'
    }
}

Detail

• Allowed portals: public, private
• Request method: GET
• URL: https://www.brainstem.org/api/private/stem/breeding/<id>/
• Data: None
• Responses: 200 OK; 403 Not allowed; 404 Not found

Use example (using Python API)

resp = client.load_model('breeding', id='00000000-0000-0000-0000-000000000000')

Response example

{'breeding': {
    'id': '00000000-0000-0000-0000-000000000000',
    'name': 'NewBreeding',
    'project': '00000000-0000-0000-0000-000000000000',
    'mother': '00000000-0000-0000-0000-000000000000',
    'father': '00000000-0000-0000-0000-000000000000',
    'description': '',
    'tags': [],
    'birth_date': null,
    'start_date': null,
    'end_date': null,
    'weaning_date': null,
    'litter_size': null,
    'expected_genotype': ''
    }
}

Change

• Allowed portals: private
• Request method: PATCH
• URL: https://www.brainstem.org/api/private/stem/breeding/<id>/
• Data: dictionary containing the fields to be updated
• Responses: 200 OK; 400 Bad request; 403 Not allowed; 404 Not found

Use example (using Python API)

resp = client.save_model("breeding", id="00000000-0000-0000-0000-000000000000", data={"name": "new name"})

Response example

{'breeding': {
    'id': '00000000-0000-0000-0000-000000000000',
    'name': 'new name',
    'project': '00000000-0000-0000-0000-000000000000',
    'mother': '00000000-0000-0000-0000-000000000000',
    'father': '00000000-0000-0000-0000-000000000000'
    }
}

Delete

• Allowed portals: private
• Request method: DELETE
• URL: https://www.brainstem.org/api/private/stem/breeding/<id>/
• Data: None
• Responses: 204 OK; 403 Not allowed; 404 Not found

Use example (using Python API)

resp = client.delete_model("breeding", id="00000000-0000-0000-0000-000000000000")