Manipulation template API endpoint

A reusable template that prefills a new manipulation.

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/modules/manipulationtemplate/ (needs a token; one record: append <id>/)
• Public portal: https://www.brainstem.org/api/public/modules/manipulationtemplate/ (read-only, public projects, no token)
• Response keys: manipulationtemplate (detail, create, update), manipulationtemplates (list)
• Permissions: inherited through projects (from project)
• Schema payload: type selects a Manipulation type; send its fields in details. type_schema_version is set by the server; do not send 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 255 characters. Descriptive name for this manipulation template
projects	list of project ids
notes	string; max 500 characters; nullable
equipment	list of equipment ids
equipment_setup	computed
type	one of the Manipulation types [required]
type_display	computed [read-only]
details	JSON object
type_schema_version	string [set by the server]. Schema version for type_json field
updated_at	datetime [read-only]
created_at	datetime [read-only]; nullable
user	user id [read-only]
user_display	computed [read-only]
summary	computed [read-only]

List

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

Use example (Python API tool)

resp = client.load('manipulationtemplate', load_all=True)
records = resp['manipulationtemplates']

Use example (MATLAB API tool)

resp = client.load('manipulationtemplate', 'load_all', true);
records = resp.manipulationtemplates;

Response example

{
    "manipulationtemplates": [
        {
            "id": "<id>",
            "name": "Manipulation template 1",
            "projects": [
                "<project-id>"
            ],
            "notes": "",
            "equipment": [
                "<equipment-id>"
            ],
            "equipment_setup": null,
            "type": "DeepBrainStimulation",
            "type_display": null,
            "details": {
                "...": "see the schema of the selected type"
            },
            "type_schema_version": "set by the server",
            "updated_at": "2024-03-22T10:30:00Z",
            "created_at": "2024-03-22T10:30:00Z",
            "user": "<user-id>",
            "user_display": null,
            "summary": 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/modules/manipulationtemplate/
• 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('manipulationtemplate', data={"name": "Manipulation template 1", "type": "AuditoryStimulation", "details": {"...": "see the schema of the selected type"}})
record = resp.json()['manipulationtemplate']

Use example (MATLAB API tool)

created = client.save(struct('name', 'Manipulation template 1', 'type', 'AuditoryStimulation', 'details', struct()), 'manipulationtemplate');  % struct() stands for the fields of the selected type
record = created.manipulationtemplate;

Detail

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

Use example (Python API tool)

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

Use example (MATLAB API tool)

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

Response example

{
    "manipulationtemplate": {
        "id": "<id>",
        "name": "Manipulation template 1",
        "projects": [
            "<project-id>"
        ],
        "notes": "",
        "equipment": [
            "<equipment-id>"
        ],
        "equipment_setup": null,
        "type": "DeepBrainStimulation",
        "type_display": null,
        "details": {
            "...": "see the schema of the selected type"
        },
        "type_schema_version": "set by the server",
        "updated_at": "2024-03-22T10:30:00Z",
        "created_at": "2024-03-22T10:30:00Z",
        "user": "<user-id>",
        "user_display": null,
        "summary": null
    }
}

Change

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

Use example (MATLAB API tool)

client.save(struct('id', '<id>', 'name', 'Manipulation template 1 (renamed)'), 'manipulationtemplate', 'method', 'patch');

Delete

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

Use example (Python API tool)

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

Use example (MATLAB API tool)

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