Behavioral assay API endpoint

The lab’s own implementation of a behavioral paradigm: how the task is actually run.

Table of contents

1. Endpoints
2. Fields
3. List
4. Add
5. Detail
6. Change
7. Delete
8. Custom actions
9. Data model

Endpoints

• Private portal: https://www.brainstem.org/api/private/personal_attributes/behavioralassay/ (needs a token; one record: append <id>/)
• Public portal: https://www.brainstem.org/api/public/personal_attributes/behavioralassay/ (read-only, public projects, no token)
• Response keys: behavioralassay (detail, create, update), behavioralassays (list)
• Permissions: object permissions on the record itself (member / manager / owner roles)
• Deleting: also deletes the linked behavioralassaygroupmembershipinvitation, behavioralassaymembershipinvitation records; refused (400) while behavior records point to it

Fields

[required] fields must be sent on create; [read-only] fields are returned but cannot be set. A nestable relation can be traversed in filters (filter{field.other}) and sideloaded with include[]=field.*; other relations can only be compared with ids (filter{field}=<id>). See the query syntax.

Field	Description
id	UUID string [read-only]
name	string [required]; max 50 characters
description	string; nullable
setup_type	setuptype id [required]; nullable
behavioral_paradigm	behavioralparadigm id [required]. Link to the shared behavioral paradigm taxonomy
licenses	list of license ids; nestable. Licenses that authorize this behavioral assay
is_public	boolean. Designates if the behavioral assay is publicly available
users	computed [read-only]
groups	computed [read-only]

List

• Allowed portals: private, public
• Request method: GET
• URL: https://www.brainstem.org/api/private/personal_attributes/behavioralassay/
• Responses: 200 OK; 401 Not authenticated; 403 Not allowed

Use example (Python API tool)

resp = client.load('behavioralassay', load_all=True)
records = resp['behavioralassays']

Use example (MATLAB API tool)

resp = client.load('behavioralassay', 'load_all', true);
records = resp.behavioralassays;

Response example

{
    "behavioralassays": [
        {
            "id": "<id>",
            "name": "Behavioral assay 1",
            "description": "",
            "setup_type": "<setuptype-id>",
            "behavioral_paradigm": "<behavioralparadigm-id>",
            "licenses": [
                "<license-id>"
            ],
            "is_public": true,
            "users": null,
            "groups": null
        }
    ],
    "meta": {
        "page": 1,
        "per_page": 100,
        "total_results": 1,
        "total_pages": 1
    }
}

Add

• Allowed portals: private
• Request method: POST
• URL: https://www.brainstem.org/api/private/personal_attributes/behavioralassay/
• Data: JSON object with at least the required fields
• Responses: 201 Created; 400 Bad request (validation errors per field); 403 Not allowed

Use example (Python API tool)

resp = client.save('behavioralassay', data={"name": "Behavioral assay 1", "setup_type": "<setuptype-id>", "behavioral_paradigm": "<behavioralparadigm-id>"})
record = resp.json()['behavioralassay']

Use example (MATLAB API tool)

created = client.save(struct('name', 'Behavioral assay 1', 'setup_type', '<setuptype-id>', 'behavioral_paradigm', '<behavioralparadigm-id>'), 'behavioralassay');
record = created.behavioralassay;

Detail

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

Use example (Python API tool)

resp = client.load('behavioralassay', id='<id>')
record = resp.json()['behavioralassay']

Use example (MATLAB API tool)

out = client.load('behavioralassay', 'id', '<id>');
record = out.behavioralassay;

Response example

{
    "behavioralassay": {
        "id": "<id>",
        "name": "Behavioral assay 1",
        "description": "",
        "setup_type": "<setuptype-id>",
        "behavioral_paradigm": "<behavioralparadigm-id>",
        "licenses": [
            "<license-id>"
        ],
        "is_public": true,
        "users": null,
        "groups": null
    }
}

Change

• Allowed portals: private
• Request method: PATCH
• URL: https://www.brainstem.org/api/private/personal_attributes/behavioralassay/<id>/
• Data: JSON object with the fields to change. Lists (projects, tags, …) and JSON payloads (details, coordinates) are replaced as a whole: read the record first and send the full list or object.
• Responses: 200 OK; 400 Bad request; 403 Not allowed; 404 Not found

Use example (Python API tool)

resp = client.save('behavioralassay', id='<id>', data={"name": "Behavioral assay 1 (renamed)"})

Use example (MATLAB API tool)

client.save(struct('id', '<id>', 'name', 'Behavioral assay 1 (renamed)'), 'behavioralassay', 'method', 'patch');

Delete

• Allowed portals: private
• Request method: DELETE
• URL: https://www.brainstem.org/api/private/personal_attributes/behavioralassay/<id>/
• Responses: 204 Deleted; 400 Still referenced by other records; 403 Not allowed; 404 Not found

Use example (Python API tool)

resp = client.delete('behavioralassay', id='<id>')

Use example (MATLAB API tool)

client.delete('<id>', 'behavioralassay');

Custom actions

Action	Request
leave	POST /api/private/personal_attributes/behavioralassay/<id>/leave/

Data model

The fields are described for the web forms on the Behavioral assay data model page.