Material usage template API endpoint

A reusable template that prefills a new material usage.

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/materialusagetemplate/ (needs a token; one record: append <id>/)
  • Public portal: https://www.brainstem.org/api/public/modules/materialusagetemplate/ (read-only, public projects, no token)
  • Response keys: materialusagetemplate (detail, create, update), materialusagetemplates (list)
  • Permissions: inherited through procedure_template.projects or specimen_procedure_template.projects or experimental_interface_template.projects (from project)
  • Schema payload: type selects a MaterialUsage type; send its fields in details_json (responses return them as details). details_schema_version is set by the server; do not send it.

Form-only inputs (sent on create or update, not returned in responses):

  • source [required]. Choices: inventory, catalog, manual. Choose a consumable or enter the planned material manually. A template plans the product, not the lot. Choose the consumable stock when you apply this template to a record.

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; max 100 characters
projectslist of project ids
procedure_templateproceduretemplate id; nullable
specimen_procedure_templatespecimenproceduretemplate id; nullable
experimental_interface_templateexperimentalinterfacetemplate id; nullable
consumableconsumable id; nullable
consumable_suppliercomputed. Optional: narrow the catalog list to one supplier.
manual_sourceJSON object [write-only]
typeone of the MaterialUsage types [required]
type_displaycomputed [read-only]
stage_templatemodules.procedurestagetemplate id; nullable
ordernumber [required]
detailsJSON object [read-only]
notesstring; max 500 characters
details_schema_versionstring [set by the server]
source_tiercomputed [read-only]
source_tier_displaycomputed [read-only]
source_identitycomputed [read-only]
summarycomputed [read-only]
detail_summarycomputed [read-only]
created_atdatetime [read-only]; nullable
updated_atdatetime [read-only]
useruser id [read-only]
user_displaycomputed [read-only]

List

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

Use example (Python API tool)

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

Use example (MATLAB API tool)

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

Response example

{
    "materialusagetemplates": [
        {
            "id": "<id>",
            "name": "Material usage template 1",
            "projects": [
                "<project-id>"
            ],
            "procedure_template": "<proceduretemplate-id>",
            "specimen_procedure_template": "<specimenproceduretemplate-id>",
            "experimental_interface_template": "<experimentalinterfacetemplate-id>",
            "consumable": "<consumable-id>",
            "consumable_supplier": null,
            "type": "SiliconProbe",
            "type_display": null,
            "stage_template": "<procedurestagetemplate-id>",
            "order": 1,
            "details": {
                "...": "see the schema of the selected type"
            },
            "notes": "",
            "details_schema_version": "set by the server",
            "source_tier": null,
            "source_tier_display": null,
            "source_identity": null,
            "summary": null,
            "detail_summary": null,
            "created_at": "2024-03-22T10:30:00Z",
            "updated_at": "2024-03-22T10:30:00Z",
            "user": "<user-id>",
            "user_display": 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/materialusagetemplate/
  • 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('materialusagetemplate', data={"type": "ActiveAgent", "order": 1, "details_json": {"...": "the fields of the selected MaterialUsage type"}, "source": "catalog", "consumable": "<consumable-id>"})
record = resp.json()['materialusagetemplate']

Use example (MATLAB API tool)

created = client.save(struct('type', 'ActiveAgent', 'order', 1, 'details_json', struct(), 'source', 'catalog', 'consumable', '<consumable-id>'), 'materialusagetemplate');  % struct() stands for the fields of the selected type
record = created.materialusagetemplate;

Detail

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

Use example (Python API tool)

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

Use example (MATLAB API tool)

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

Response example

{
    "materialusagetemplate": {
        "id": "<id>",
        "name": "Material usage template 1",
        "projects": [
            "<project-id>"
        ],
        "procedure_template": "<proceduretemplate-id>",
        "specimen_procedure_template": "<specimenproceduretemplate-id>",
        "experimental_interface_template": "<experimentalinterfacetemplate-id>",
        "consumable": "<consumable-id>",
        "consumable_supplier": null,
        "type": "SiliconProbe",
        "type_display": null,
        "stage_template": "<procedurestagetemplate-id>",
        "order": 1,
        "details": {
            "...": "see the schema of the selected type"
        },
        "notes": "",
        "details_schema_version": "set by the server",
        "source_tier": null,
        "source_tier_display": null,
        "source_identity": null,
        "summary": null,
        "detail_summary": null,
        "created_at": "2024-03-22T10:30:00Z",
        "updated_at": "2024-03-22T10:30:00Z",
        "user": "<user-id>",
        "user_display": null
    }
}

Change

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

Use example (MATLAB API tool)

client.save(struct('id', '<id>', 'name', 'Material usage template 1 (renamed)'), 'materialusagetemplate', 'method', 'patch');

Delete

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

Use example (Python API tool)

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

Use example (MATLAB API tool)

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