Procedure template API endpoint

A reusable template that prefills a new procedure.

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/proceduretemplate/ (needs a token; one record: append <id>/)
  • Public portal: https://www.brainstem.org/api/public/modules/proceduretemplate/ (read-only, public projects, no token)
  • Response keys: proceduretemplate (detail, create, update), proceduretemplates (list)
  • Permissions: inherited through projects (from project)
  • Schema payload: type selects a Procedure 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.
  • 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 100 characters
projectslist of project ids
typeone of the Procedure types [required]
type_displaycomputed [read-only]
notesstring; max 500 characters; nullable
date_timedatetime; nullable
protocolprotocol id; nullable; nestable
licenseslist of license ids; nestable. Licenses authorizing this specific procedure
equipmentlist of equipment ids
detailsJSON object
equipment_setupcomputed
target_regionslist of anatomicalregion ids
target_regions_atlascomputed
target_regions_displaycomputed [read-only]
coordinates_systemone of the Coordinates types [required]
coordinates_detailsJSON object
type_schema_versionstring [set by the server]. Schema version for type_json field
coordinates_schema_versionstring [set by the server]. Schema version for coordinates_json field
updated_atdatetime [read-only]
created_atdatetime [read-only]; nullable
useruser id [read-only]
user_displaycomputed [read-only]
summarycomputed [read-only]
materialscomputed [read-only]
stagescomputed [read-only]

List

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

Use example (Python API tool)

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

Use example (MATLAB API tool)

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

Response example

{
    "proceduretemplates": [
        {
            "id": "<id>",
            "name": "Procedure template 1",
            "projects": [
                "<project-id>"
            ],
            "type": "Analgesic",
            "type_display": null,
            "notes": "",
            "date_time": "2024-03-22T10:30:00Z",
            "protocol": "<protocol-id>",
            "licenses": [
                "<license-id>"
            ],
            "equipment": [
                "<equipment-id>"
            ],
            "details": {
                "...": "see the schema of the selected type"
            },
            "equipment_setup": null,
            "target_regions": [
                "<anatomicalregion-id>"
            ],
            "target_regions_atlas": null,
            "target_regions_display": null,
            "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",
            "updated_at": "2024-03-22T10:30:00Z",
            "created_at": "2024-03-22T10:30:00Z",
            "user": "<user-id>",
            "user_display": null,
            "summary": null,
            "materials": null,
            "stages": 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/proceduretemplate/
  • 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('proceduretemplate', data={"name": "Procedure template 1", "type": "Anesthesia", "details": {"...": "see the schema of the selected type"}, "coordinates_system": "Stereotaxic_BregmaBrainSurface", "coordinates_details": {"...": "the fields of the selected Coordinates type"}})
record = resp.json()['proceduretemplate']

Use example (MATLAB API tool)

created = client.save(struct('name', 'Procedure template 1', 'type', 'Anesthesia', 'details', struct(), 'coordinates_system', 'Stereotaxic_BregmaBrainSurface', 'coordinates_details', struct()), 'proceduretemplate');  % struct() stands for the fields of the selected type
record = created.proceduretemplate;

Detail

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

Use example (Python API tool)

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

Use example (MATLAB API tool)

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

Response example

{
    "proceduretemplate": {
        "id": "<id>",
        "name": "Procedure template 1",
        "projects": [
            "<project-id>"
        ],
        "type": "Analgesic",
        "type_display": null,
        "notes": "",
        "date_time": "2024-03-22T10:30:00Z",
        "protocol": "<protocol-id>",
        "licenses": [
            "<license-id>"
        ],
        "equipment": [
            "<equipment-id>"
        ],
        "details": {
            "...": "see the schema of the selected type"
        },
        "equipment_setup": null,
        "target_regions": [
            "<anatomicalregion-id>"
        ],
        "target_regions_atlas": null,
        "target_regions_display": null,
        "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",
        "updated_at": "2024-03-22T10:30:00Z",
        "created_at": "2024-03-22T10:30:00Z",
        "user": "<user-id>",
        "user_display": null,
        "summary": null,
        "materials": null,
        "stages": null
    }
}

Change

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

Use example (MATLAB API tool)

client.save(struct('id', '<id>', 'name', 'Procedure template 1 (renamed)'), 'proceduretemplate', 'method', 'patch');

Delete

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

Use example (Python API tool)

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

Use example (MATLAB API tool)

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