Cohort subject API endpoint

Table of contents

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

Endpoints

• Private portal: https://www.brainstem.org/api/private/stem/cohortsubject/ (needs a token; one record: append <id>/)
• Public portal: https://www.brainstem.org/api/public/stem/cohortsubject/ (read-only, public projects, no token)
• Response keys: cohort_subject (detail, create, update), cohort_subjects (list)
• Permissions: see the permissions page
• Uniqueness: cohort, subject 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	number [read-only]
subject_name	computed [read-only]
subject	subject id [required]
cohort	cohort id [required]
order	number; nullable

List

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

Use example (Python API tool)

resp = client.load('cohortsubject', load_all=True)
records = resp['cohort_subjects']

Use example (MATLAB API tool)

resp = client.load('cohortsubject', 'load_all', true);
records = resp.cohort_subjects;

Response example

{
    "cohort_subjects": [
        {
            "id": 1,
            "subject_name": null,
            "subject": "<subject-id>",
            "cohort": "<cohort-id>",
            "order": 1
        }
    ],
    "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/cohortsubject/
• 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('cohortsubject', data={"subject": "<subject-id>", "cohort": "<cohort-id>"})
record = resp.json()['cohort_subject']

Use example (MATLAB API tool)

created = client.save(struct('subject', '<subject-id>', 'cohort', '<cohort-id>'), 'cohortsubject');
record = created.cohort_subject;

Detail

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

Use example (Python API tool)

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

Use example (MATLAB API tool)

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

Response example

{
    "cohort_subject": {
        "id": 1,
        "subject_name": null,
        "subject": "<subject-id>",
        "cohort": "<cohort-id>",
        "order": 1
    }
}

Change

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

Use example (MATLAB API tool)

client.save(struct('id', '<id>', 'order', 1), 'cohortsubject', 'method', 'patch');

Delete

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

Use example (Python API tool)

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

Use example (MATLAB API tool)

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