Behavioral category API endpoint

A shared two-level grouping of behavioral paradigms by cognitive domain.

Table of contents

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

Endpoints

• Private portal: https://www.brainstem.org/api/private/taxonomies/behavioralcategory/ (needs a token; one record: append <id>/)
• Public portal: https://www.brainstem.org/api/public/taxonomies/behavioralcategory/ (read-only, public projects, no token)
• Response keys: behavioral_category (detail, create, update), behavioral_categories (list)
• Permissions: see the permissions page
• Uniqueness: name unique across BrainSTEM
• Deleting: refused (400) while behavioralparadigm, behavioralparadigmapproval 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 100 characters. Category name (e.g., ‘Spatial Learning’, ‘Motor Function’)
description	string; max 2000 characters. Description of what this category encompasses
parent	behavioralcategory id; nullable. Parent category for hierarchical organization (max 2 levels)
comments	string

List

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

Use example (Python API tool)

resp = client.load('behavioralcategory', load_all=True)
records = resp['behavioral_categories']

Use example (MATLAB API tool)

resp = client.load('behavioralcategory', 'load_all', true);
records = resp.behavioral_categories;

Response example

{
    "behavioral_categories": [
        {
            "id": "<id>",
            "name": "Behavioral category 1",
            "description": "",
            "parent": "<behavioralcategory-id>",
            "comments": ""
        }
    ],
    "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/taxonomies/behavioralcategory/
• 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('behavioralcategory', data={"name": "Behavioral category 1"})
record = resp.json()['behavioral_category']

Use example (MATLAB API tool)

created = client.save(struct('name', 'Behavioral category 1'), 'behavioralcategory');
record = created.behavioral_category;

Detail

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

Use example (Python API tool)

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

Use example (MATLAB API tool)

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

Response example

{
    "behavioral_category": {
        "id": "<id>",
        "name": "Behavioral category 1",
        "description": "",
        "parent": "<behavioralcategory-id>",
        "comments": ""
    }
}

Change

• Allowed portals: private
• Request method: PATCH
• URL: https://www.brainstem.org/api/private/taxonomies/behavioralcategory/<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('behavioralcategory', id='<id>', data={"name": "Behavioral category 1 (renamed)"})

Use example (MATLAB API tool)

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

Delete

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

Use example (Python API tool)

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

Use example (MATLAB API tool)

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

Data model

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