Setup type API endpoint

A shared classification of experimental preparations, such as head-fixed or freely moving.

Table of contents

  1. Endpoints
  2. Fields
  3. List
  4. Add
  5. Detail
  6. Change
  7. Delete
  8. Data model
  9. Usage notes

Endpoints

  • Private portal: https://www.brainstem.org/api/private/taxonomies/setuptype/ (needs a token; one record: append <id>/)
  • Public portal: https://www.brainstem.org/api/public/taxonomies/setuptype/ (read-only, public projects, no token)
  • Response keys: setup_type (detail, create, update), setup_types (list)
  • Permissions: see the permissions page
  • Uniqueness: name unique across BrainSTEM
  • Deleting: refused (400) while behavioralassay, setup records point to 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 200 characters
descriptionstring; max 2000 characters
categoryone of I, E, A, HA, RA, FA, U [required]
biological_preparationstring [read-only]
physiological_statestring [read-only]
constraint_levelstring [read-only]
commentsstring

List

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

Use example (Python API tool)

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

Use example (MATLAB API tool)

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

Response example

{
    "setup_types": [
        {
            "id": "<id>",
            "name": "Setup type 1",
            "description": "",
            "category": "I",
            "biological_preparation": "",
            "physiological_state": "",
            "constraint_level": "",
            "comments": ""
        }
    ],
    "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/taxonomies/setuptype/
  • 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('setuptype', data={"name": "Setup type 1", "category": "I"})
record = resp.json()['setup_type']

Use example (MATLAB API tool)

created = client.save(struct('name', 'Setup type 1', 'category', 'I'), 'setuptype');
record = created.setup_type;

Detail

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

Use example (Python API tool)

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

Use example (MATLAB API tool)

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

Response example

{
    "setup_type": {
        "id": "<id>",
        "name": "Setup type 1",
        "description": "",
        "category": "I",
        "biological_preparation": "",
        "physiological_state": "",
        "constraint_level": "",
        "comments": ""
    }
}

Change

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

Use example (MATLAB API tool)

client.save(struct('id', '<id>', 'name', 'Setup type 1 (renamed)'), 'setuptype', 'method', 'patch');

Delete

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

Use example (Python API tool)

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

Use example (MATLAB API tool)

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

Data model

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

Usage notes

  • category codes: I In Vitro, E Ex Vivo, A Anesthetized In Vivo, HA Head-Fixed Awake, RA Restrained Awake, FA Freely Moving Awake, U Unknown. The Setup types data model page explains each category.