Manipulation API endpoint

A perturbation applied during a session, such as optogenetic or electrical stimulation.

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/modules/manipulation/ (needs a token; one record: append <id>/)
  • Public portal: https://www.brainstem.org/api/public/modules/manipulation/ (read-only, public projects, no token)
  • Response keys: manipulation (detail, create, update), manipulations (list)
  • Permissions: inherited through session → 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.

Form-only inputs (sent on create or update, not returned in responses):

  • experimental_interfaces [required].

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.

FieldDescription
idUUID string [read-only]
typeone of the Manipulation types [required]
notesstring; max 500 characters; nullable
interfaceslist of experimentalinterface ids; nestable
equipmentlist of equipment ids
sessionsession id [required]; nestable
detailsJSON object
ordernumber; nullable. Determines the order items are listed.
type_schema_versionstring [set by the server]. Schema version for type_json field

List

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

Use example (Python API tool)

resp = client.load('manipulation', load_all=True)
records = resp['manipulations']

Use example (MATLAB API tool)

resp = client.load('manipulation', 'load_all', true);
records = resp.manipulations;

Response example

{
    "manipulations": [
        {
            "id": "<id>",
            "type": "DeepBrainStimulation",
            "notes": "",
            "interfaces": [
                "<experimentalinterface-id>"
            ],
            "equipment": [
                "<equipment-id>"
            ],
            "session": "<session-id>",
            "details": {
                "...": "see the schema of the selected type"
            },
            "order": 1,
            "type_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/manipulation/
  • 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('manipulation', data={"type": "AuditoryStimulation", "session": "<session-id>", "details": {"...": "see the schema of the selected type"}, "experimental_interfaces": ["<experimentalinterface-id>"]})
record = resp.json()['manipulation']

Use example (MATLAB API tool)

created = client.save(struct('type', 'AuditoryStimulation', 'session', '<session-id>', 'details', struct(), 'experimental_interfaces', {{'<experimentalinterface-id>'}}), 'manipulation');  % struct() stands for the fields of the selected type
record = created.manipulation;

Detail

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

Use example (Python API tool)

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

Use example (MATLAB API tool)

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

Response example

{
    "manipulation": {
        "id": "<id>",
        "type": "DeepBrainStimulation",
        "notes": "",
        "interfaces": [
            "<experimentalinterface-id>"
        ],
        "equipment": [
            "<equipment-id>"
        ],
        "session": "<session-id>",
        "details": {
            "...": "see the schema of the selected type"
        },
        "order": 1,
        "type_schema_version": "set by the server"
    }
}

Change

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

Use example (MATLAB API tool)

client.save(struct('id', '<id>', 'notes', 'new value'), 'manipulation', 'method', 'patch');

Delete

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

Use example (Python API tool)

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

Use example (MATLAB API tool)

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

Data model

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