Manipulation interface 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/modules/manipulationinterface/ (needs a token; one record: append <id>/)
• Public portal: https://www.brainstem.org/api/public/modules/manipulationinterface/ (read-only, public projects, no token)
• Response keys: manipulationinterface (detail, create, update), manipulationinterfaces (list)
• Permissions: see the permissions page
• Uniqueness: manipulation, interface 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]
manipulation	manipulation id [required]
interface	experimentalinterface id [required]
interface_name	computed [read-only]
order	number; nullable
metadata_json	JSON object; nullable
metadata_schema_version	string; max 20 characters

List

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

Use example (Python API tool)

resp = client.load('manipulationinterface', load_all=True)
records = resp['manipulationinterfaces']

Use example (MATLAB API tool)

resp = client.load('manipulationinterface', 'load_all', true);
records = resp.manipulationinterfaces;

Response example

{
    "manipulationinterfaces": [
        {
            "id": 1,
            "manipulation": "<manipulation-id>",
            "interface": "<experimentalinterface-id>",
            "interface_name": null,
            "order": 1,
            "metadata_json": {},
            "metadata_schema_version": "set by the server"
        }
    ],
    "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/manipulationinterface/
• 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('manipulationinterface', data={"manipulation": "<manipulation-id>", "interface": "<experimentalinterface-id>"})
record = resp.json()['manipulationinterface']

Use example (MATLAB API tool)

created = client.save(struct('manipulation', '<manipulation-id>', 'interface', '<experimentalinterface-id>'), 'manipulationinterface');
record = created.manipulationinterface;

Detail

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

Use example (Python API tool)

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

Use example (MATLAB API tool)

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

Response example

{
    "manipulationinterface": {
        "id": 1,
        "manipulation": "<manipulation-id>",
        "interface": "<experimentalinterface-id>",
        "interface_name": null,
        "order": 1,
        "metadata_json": {},
        "metadata_schema_version": "set by the server"
    }
}

Change

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

Use example (MATLAB API tool)

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

Delete

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

Use example (Python API tool)

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

Use example (MATLAB API tool)

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