Equipment API endpoint

A device installed in a setup, such as an amplifier, a camera or a laser.

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/equipment/ (needs a token; one record: append <id>/)
  • Public portal: https://www.brainstem.org/api/public/modules/equipment/ (read-only, public projects, no token)
  • Response keys: equipment (detail, create, update), equipment (list)
  • Permissions: inherited through setup (from setup)
  • Schema payload: type selects a Equipment type; send its fields in details. type_schema_version is set by the server; do not send it.
  • Schema payload: coordinates_system selects a Coordinates type; send its fields in coordinates_details. coordinates_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.

FieldDescription
idUUID string [read-only]
namestring [required]; max 100 characters. Name of the equipment, e.g., “Ephys amplifier” or “Ceiling mounted camera”.
typeone of the Equipment types [required]
notesstring; max 500 characters; nullable
setupsetup id [required]; nestable
date_timedatetime; nullable
consumableconsumable id; nullable
hardwaredevicehardwaredevice id; nullable
detailsJSON object
coordinates_systemone of the Coordinates types [required]
coordinates_detailsJSON object
type_schema_versionstring [set by the server]
coordinates_schema_versionstring [set by the server]

List

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

Use example (Python API tool)

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

Use example (MATLAB API tool)

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

Response example

{
    "equipment": [
        {
            "id": "<id>",
            "name": "Equipment 1",
            "type": "Amplifier",
            "notes": "",
            "setup": "<setup-id>",
            "date_time": "2024-03-22T10:30:00Z",
            "consumable": "<consumable-id>",
            "hardwaredevice": "<hardwaredevice-id>",
            "details": {
                "...": "see the schema of the selected type"
            },
            "coordinates_system": "",
            "coordinates_details": {
                "...": "see the schema of the selected type"
            },
            "type_schema_version": "set by the server",
            "coordinates_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/equipment/
  • 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('equipment', data={"name": "Equipment 1", "type": "Amplifier", "setup": "<setup-id>", "details": {"...": "see the schema of the selected type"}, "coordinates_system": "External_XYZ_Euler", "coordinates_details": {"...": "the fields of the selected Coordinates type"}})
record = resp.json()['equipment']

Use example (MATLAB API tool)

created = client.save(struct('name', 'Equipment 1', 'type', 'Amplifier', 'setup', '<setup-id>', 'details', struct(), 'coordinates_system', 'External_XYZ_Euler', 'coordinates_details', struct()), 'equipment');  % struct() stands for the fields of the selected type
record = created.equipment;

Detail

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

Use example (Python API tool)

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

Use example (MATLAB API tool)

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

Response example

{
    "equipment": {
        "id": "<id>",
        "name": "Equipment 1",
        "type": "Amplifier",
        "notes": "",
        "setup": "<setup-id>",
        "date_time": "2024-03-22T10:30:00Z",
        "consumable": "<consumable-id>",
        "hardwaredevice": "<hardwaredevice-id>",
        "details": {
            "...": "see the schema of the selected type"
        },
        "coordinates_system": "",
        "coordinates_details": {
            "...": "see the schema of the selected type"
        },
        "type_schema_version": "set by the server",
        "coordinates_schema_version": "set by the server"
    }
}

Change

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

Use example (MATLAB API tool)

client.save(struct('id', '<id>', 'name', 'Equipment 1 (renamed)'), 'equipment', 'method', 'patch');

Delete

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

Use example (Python API tool)

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

Use example (MATLAB API tool)

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

Data model

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