Link Search Menu Expand Document

Action Log API endpoint

Table of contents

  1. Fields
  2. List view
  3. Add
  4. Detail
  5. Change
  6. Delete
  7. Add entry
  8. Change entry
  9. Remove entry

Fields

FieldDescription
idUUID identificator formatted as a string
typestring [required]. See options below
descriptionstring [max length: 500]
procedurerelated procedure ID formatted as a string [required]
entrieslist of log entries [read-only]. See entries format below

These are the available type options for Action Log:

  • Impedances
  • LinearDisplacement

Each entry in the entries list is a dictionary with the following fields:

FieldDescription
date_timestring containing date and time (e.g. “2023-05-05T06:20:00Z”) [required]
notesstring
detailsJSON object. See accepted schemas below

A detailed list of the accepted schemas for the details field, related to each type, can be found in

List view

  • Allowed portals: public, private, super
  • Request method: GET
  • URL: https://www.brainstem.org/api/private/modules/actionlog
  • Data: None
  • Responses: 200 OK; 403 Not allowed; 404 Not found

Use example (using Python API)

resp = client.load_model('actionlog')

Response example

{'action_logs': [
    {
        'id': '6a24ec67-59df-4da2-beae-c138102e69b1',
        'type': 'Impedances',
        'description': None,
        'procedure': '6a7c4ef9-f633-4b60-aa21-21d274ebab17',
        'entries': [
            {'date_time': '2023-05-05T06:20:00Z',
             'notes': None,
             'details': {'impedances': 3.0, 'phases': None, 'channels': ''}},
            {'date_time': '2023-04-05T07:10:00Z',
             'notes': 'aa',
             'details': {'impedances': 2.0, 'phases': None, 'channels': ''}},
            {'date_time': '2023-03-26T13:20:00Z',
             'notes': None,
             'details': {'impedances': 1.0, 'phases': None, 'channels': ''}},
            {'date_time': '2023-03-13T07:10:00Z',
             'notes': None,
             'details': {'impedances': 2.0, 'phases': None, 'channels': ''}}
        ],
        'links': {'entries': 'entries/'}
    },
    {
        'id': '88331276-e142-45ec-ae63-45a513881ed7',
        'type': 'LinearDisplacement',
        'description': None,
        'procedure': '61da7e53-1066-42de-a1a2-3db96bb7cba2',
        'entries': [
            {'date_time': '2023-04-05T13:45:00Z',
             'notes': None,
             'details': {'displacement': 9.0}},
            {'date_time': '2023-03-31T09:05:00Z',
             'notes': None,
             'details': {'displacement': 7.0}}
        ],
        'links': {'entries': 'entries/'}
    }
]}

Add

  • Allowed portals: private, super
  • Request method: POST
  • URL: https://www.brainstem.org/api/private/modules/actionlog
  • Data: JSON dictionary containing at least the required fields.
  • Responses: 201 OK; 400 Bad request; 403 Not allowed; 404 Not found

Use example (using Python API)

resp = client.save_model("actionlog",  data={
    "type": "LinearDisplacement",
    "procedure": "61da7e53-1066-42de-a1a2-3db96bb7cba2"})

Response example

{'action_log': {
    'id': '43d3d060-4606-4e95-bd7e-79dcb910cf27',
    'type': 'LinearDisplacement',
    'description': None,
    'procedure': '61da7e53-1066-42de-a1a2-3db96bb7cba2',
    'entries': []}
}

Detail

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

Use example (using Python API)

resp = client.load_model('actionlog', id='43d3d060-4606-4e95-bd7e-79dcb910cf27')

Response example

{'action_log': {
    'id': '43d3d060-4606-4e95-bd7e-79dcb910cf27',
    'type': 'LinearDisplacement',
    'description': None,
    'procedure': '61da7e53-1066-42de-a1a2-3db96bb7cba2',
    'entries': []}
}

Change

  • Allowed portals: private, super
  • Request method: PATCH
  • URL: https://www.brainstem.org/api/private/modules/actionlog/<id>/
  • Data: dictionary containing the fields to be updated
  • Responses: 200 OK; 400 Bad request; 403 Not allowed; 404 Not found

Use example (using Python API)

resp = client.save_model("actionlog", id="43d3d060-4606-4e95-bd7e-79dcb910cf27", data={"description": "new text"})

Response example

{'action_log': {
    'id': '43d3d060-4606-4e95-bd7e-79dcb910cf27',
    'type': 'LinearDisplacement',
    'description': "new text",
    'procedure': '61da7e53-1066-42de-a1a2-3db96bb7cba2',
    'entries': []}
}

Delete

  • Allowed portals: private, super
  • Request method: DELETE
  • URL: https://www.brainstem.org/api/private/modules/actionlog/<id>/
  • Data: None
  • Responses: 204 OK; 403 Not allowed; 404 Not found

Use example (using Python API)

resp = client.delete_model("actionlog", id="43d3d060-4606-4e95-bd7e-79dcb910cf27")

Add entry

  • Allowed portals: private, super
  • Request method: PATCH
  • URL: https://www.brainstem.org/api/private/modules/actionlog/<id>/add_entry/
  • Data: dictionary with the entry data
  • Responses: 200 OK; 400 Bad request; 403 Not allowed; 404 Not found

Use example (using Python API)

resp = client.save_model("actionlog", id="43d3d060-4606-4e95-bd7e-79dcb910cf27", options="add_entry", data={
            'date_time': '2023-04-05T13:45:00Z',
            'notes': None,
            'details': {'displacement': 9.0}
        }
)

Response example

{'action_log': {
        'id': '43d3d060-4606-4e95-bd7e-79dcb910cf27',
        'type': 'LinearDisplacement',
        'description': 'new text',
        'procedure': '61da7e53-1066-42de-a1a2-3db96bb7cba2',
        'entries': [
            {'date_time': '2023-04-05T13:45:00Z',
            'notes': None,
            'details': {'displacement': 9.0}}
        ],
        'links': {'entries': 'entries/'}
    }
}

Change entry

  • Allowed portals: private, super
  • Request method: PATCH
  • URL: https://www.brainstem.org/api/private/modules/actionlog/<id>/change_entry/
  • Data: dictionary with the entry data
  • Responses: 200 OK; 400 Bad request; 403 Not allowed; 404 Not found

Use example (using Python API)

resp = client.save_model("actionlog", id="43d3d060-4606-4e95-bd7e-79dcb910cf27", options="change_entry", data={'date_time': '2023-04-05T13:45:00Z', 'notes': 'new text'})

Response example

{'action_log': {
        'id': '43d3d060-4606-4e95-bd7e-79dcb910cf27',
        'type': 'LinearDisplacement',
        'description': 'new text',
        'procedure': '61da7e53-1066-42de-a1a2-3db96bb7cba2',
        'entries': [
            {'date_time': '2023-04-05T13:45:00Z',
            'notes': "new text",
            'details': {'displacement': 9.0}}
        ],
        'links': {'entries': 'entries/'}
    }
}

Remove entry

  • Allowed portals: private, super
  • Request method: PATCH
  • URL: https://www.brainstem.org/api/private/modules/actionlog/<id>/remove_entry/
  • Data: dictionary with the entry data
  • Responses: 200 OK; 400 Bad request; 403 Not allowed; 404 Not found

Use example (using Python API)

resp = client.save_model("actionlog", id="43d3d060-4606-4e95-bd7e-79dcb910cf27", options="remove_entry", data={'date_time': '2023-04-05T13:45:00Z'})

Response example

{'action_log': {
        'id': '43d3d060-4606-4e95-bd7e-79dcb910cf27',
        'type': 'LinearDisplacement',
        'description': 'new text',
        'procedure': '61da7e53-1066-42de-a1a2-3db96bb7cba2',
        'entries': []
    }
}