Experimental interface template API endpoint

A reusable template that prefills a new experimental interface.

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/experimentalinterfacetemplate/ (needs a token; one record: append <id>/)
  • Public portal: https://www.brainstem.org/api/public/modules/experimentalinterfacetemplate/ (read-only, public projects, no token)
  • Response keys: experimentalinterfacetemplate (detail, create, update), experimentalinterfacetemplates (list)
  • Permissions: inherited through projects (from project)
  • Schema payload: type selects a ExperimentalInterface type; send its fields in details. type_schema_version is set by the server; do not send it.
  • Schema payload: coordinates selects a Coordinates type; send its fields in coordinates_json. coordinates_schema_version is set by the server; do not send it.
  • Deleting: also deletes the linked materialusagetemplate records

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]
namestring [required]; max 255 characters
projectslist of project ids
notesstring; max 500 characters; nullable
typeone of the ExperimentalInterface types [required]
type_displaycomputed [read-only]
persistenceone of chronic, session, transient [required]
material_usage_templateslist of materialusagetemplate ids [read-only]
materialscomputed [read-only]
equipmentlist of equipment ids
target_regionslist of anatomicalregion ids
target_regions_displaycomputed [read-only]
coordinatesone of the Coordinates types [required]; nullable
target_typeone of subject, specimen_set [required]. What interfaces built from this template attach to. An interface derives this from whichever target it was given and then locks it, so a template that did not carry it left the choice to be guessed at the one moment it could no longer be corrected.
allowed_target_typescomputed [read-only]
fallback_coordinatescomputed [read-only]
coordinates_jsonJSON object; nullable
coordinates_schema_versionstring [set by the server]
detailsJSON object
type_schema_versionstring [set by the server]
updated_atdatetime [read-only]
created_atdatetime [read-only]; nullable
useruser id [read-only]
user_displaycomputed [read-only]
summarycomputed [read-only]

List

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

Use example (Python API tool)

resp = client.load('experimentalinterfacetemplate', load_all=True)
records = resp['experimentalinterfacetemplates']

Use example (MATLAB API tool)

resp = client.load('experimentalinterfacetemplate', 'load_all', true);
records = resp.experimentalinterfacetemplates;

Response example

{
    "experimentalinterfacetemplates": [
        {
            "id": "<id>",
            "name": "Experimental interface template 1",
            "projects": [
                "<project-id>"
            ],
            "notes": "",
            "type": "SiliconProbe",
            "type_display": null,
            "persistence": "chronic",
            "material_usage_templates": [
                "<materialusagetemplate-id>"
            ],
            "materials": null,
            "equipment": [
                "<equipment-id>"
            ],
            "target_regions": [
                "<anatomicalregion-id>"
            ],
            "target_regions_display": null,
            "coordinates": "External_XYZ_Euler",
            "target_type": "subject",
            "allowed_target_types": null,
            "fallback_coordinates": null,
            "coordinates_json": {
                "...": "see the schema of the selected type"
            },
            "coordinates_schema_version": "set by the server",
            "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/experimentalinterfacetemplate/
  • 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('experimentalinterfacetemplate', data={"name": "Experimental interface template 1", "type": "AuditoryStimulator", "persistence": "chronic", "coordinates": "Stereotaxic_BregmaBrainSurface", "target_type": "subject", "details": {"...": "see the schema of the selected type"}, "coordinates_json": {"...": "the fields of the selected Coordinates type"}})
record = resp.json()['experimentalinterfacetemplate']

Use example (MATLAB API tool)

created = client.save(struct('name', 'Experimental interface template 1', 'type', 'AuditoryStimulator', 'persistence', 'chronic', 'coordinates', 'Stereotaxic_BregmaBrainSurface', 'target_type', 'subject', 'details', struct(), 'coordinates_json', struct()), 'experimentalinterfacetemplate');  % struct() stands for the fields of the selected type
record = created.experimentalinterfacetemplate;

Detail

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

Use example (Python API tool)

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

Use example (MATLAB API tool)

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

Response example

{
    "experimentalinterfacetemplate": {
        "id": "<id>",
        "name": "Experimental interface template 1",
        "projects": [
            "<project-id>"
        ],
        "notes": "",
        "type": "SiliconProbe",
        "type_display": null,
        "persistence": "chronic",
        "material_usage_templates": [
            "<materialusagetemplate-id>"
        ],
        "materials": null,
        "equipment": [
            "<equipment-id>"
        ],
        "target_regions": [
            "<anatomicalregion-id>"
        ],
        "target_regions_display": null,
        "coordinates": "External_XYZ_Euler",
        "target_type": "subject",
        "allowed_target_types": null,
        "fallback_coordinates": null,
        "coordinates_json": {
            "...": "see the schema of the selected type"
        },
        "coordinates_schema_version": "set by the server",
        "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/experimentalinterfacetemplate/<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('experimentalinterfacetemplate', id='<id>', data={"name": "Experimental interface template 1 (renamed)"})

Use example (MATLAB API tool)

client.save(struct('id', '<id>', 'name', 'Experimental interface template 1 (renamed)'), 'experimentalinterfacetemplate', 'method', 'patch');

Delete

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

Use example (Python API tool)

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

Use example (MATLAB API tool)

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