Inventory API endpoint

A place where the lab keeps track of its consumable stock.

Table of contents

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

Endpoints

  • Private portal: https://www.brainstem.org/api/private/personal_attributes/inventory/ (needs a token; one record: append <id>/)
  • Public portal: https://www.brainstem.org/api/public/personal_attributes/inventory/ (read-only, public projects, no token)
  • Response keys: inventory (detail, create, update), inventories (list)
  • Permissions: object permissions on the record itself (member / manager / owner roles)
  • Deleting: also deletes the linked inventorygroupmembershipinvitation, inventorymembershipinvitation records; refused (400) while consumablestock 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 50 characters
locationstring; max 100 characters; nullable. Location of the inventory, e.g., “Room 302, Cabinet B, ESD-safe storage” or “-80°C Freezer, Bay 3, Boxes V1-V10”.
descriptionstring; nullable
is_publicboolean. Designates if the inventory is publicly available
userscomputed [read-only]
groupscomputed [read-only]

List

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

Use example (Python API tool)

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

Use example (MATLAB API tool)

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

Response example

{
    "inventories": [
        {
            "id": "<id>",
            "name": "Inventory 1",
            "location": "",
            "description": "",
            "is_public": true,
            "users": null,
            "groups": 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/personal_attributes/inventory/
  • 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('inventory', data={"name": "Inventory 1"})
record = resp.json()['inventory']

Use example (MATLAB API tool)

created = client.save(struct('name', 'Inventory 1'), 'inventory');
record = created.inventory;

Detail

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

Use example (Python API tool)

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

Use example (MATLAB API tool)

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

Response example

{
    "inventory": {
        "id": "<id>",
        "name": "Inventory 1",
        "location": "",
        "description": "",
        "is_public": true,
        "users": null,
        "groups": null
    }
}

Change

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

Use example (MATLAB API tool)

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

Delete

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

Use example (Python API tool)

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

Use example (MATLAB API tool)

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

Custom actions

ActionRequest
leavePOST /api/private/personal_attributes/inventory/<id>/leave/

Data model

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