Collection API endpoint

A named subgroup of a project’s sessions, for an analysis or a figure.

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/stem/collection/ (needs a token; one record: append <id>/)
• Public portal: https://www.brainstem.org/api/public/stem/collection/ (read-only, public projects, no token)
• Response keys: collection (detail, create, update), collections (list)
• Permissions: inherited through project (from project)
• Uniqueness: name, project unique together

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
project	project id [required]
sessions	list of session ids [required]
description	string; nullable
tags	list of strings; filter with filter{tags.name}=<name>

List

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

Use example (Python API tool)

resp = client.load('collection', load_all=True)
records = resp['collections']

Use example (MATLAB API tool)

resp = client.load('collection', 'load_all', true);
records = resp.collections;

Response example

{
    "collections": [
        {
            "id": "<id>",
            "name": "Collection 1",
            "project": "<project-id>",
            "sessions": [
                "<session-id>"
            ],
            "description": "",
            "tags": []
        }
    ],
    "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/stem/collection/
• 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('collection', data={"name": "Collection 1", "project": "<project-id>", "sessions": ["<session-id>"]})
record = resp.json()['collection']

Use example (MATLAB API tool)

created = client.save(struct('name', 'Collection 1', 'project', '<project-id>', 'sessions', {{'<session-id>'}}), 'collection');
record = created.collection;

Detail

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

Use example (Python API tool)

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

Use example (MATLAB API tool)

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

Response example

{
    "collection": {
        "id": "<id>",
        "name": "Collection 1",
        "project": "<project-id>",
        "sessions": [
            "<session-id>"
        ],
        "description": "",
        "tags": []
    }
}

Change

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

Use example (MATLAB API tool)

client.save(struct('id', '<id>', 'name', 'Collection 1 (renamed)'), 'collection', 'method', 'patch');

Delete

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

Use example (Python API tool)

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

Use example (MATLAB API tool)

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

Data model

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