Consumable approval API endpoint

A request to add or change a shared consumable, reviewed before it takes effect.

Table of contents

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

Endpoints

• Private portal: https://www.brainstem.org/api/private/resources/consumableapproval/ (needs a token; one record: append <id>/)
• Public portal: not available
• Response keys: consumable_approval (detail, create, update), consumable_approvals (list)
• Permissions: see the permissions page
• Entry schemas: type selects a Consumable type; each log entry is validated against it.

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

• merge_to_id [required].

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.

Field	Description
id	UUID string [read-only]
name	string [required]; max 100 characters
description	string; max 2000 characters
supplier	supplier id [required]
type	one of the Consumable types [required]
details	JSON object
rrid	string; max 100 characters; nullable. Research Resource Identifier (RRID) for tracking standardized research resources
external_identifiers	JSON object; nullable. External identifiers and their source URLs from various databases (NCBI, JAX, DOI, etc.)
comments	string; nullable
instance_id	UUID string [required]; nullable
action	one of Add, Change [required]
reviewer	user id [required]; nullable
status	one of Pending, Accepted, Rejected, Cancelled, HoldForRejection, HoldForMerge, Merged, ChangesRequired [required]

List

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

Use example (Python API tool)

resp = client.load('consumableapproval', load_all=True)
records = resp['consumable_approvals']

Use example (MATLAB API tool)

resp = client.load('consumableapproval', 'load_all', true);
records = resp.consumable_approvals;

Response example

{
    "consumable_approvals": [
        {
            "id": "<id>",
            "name": "Consumable approval 1",
            "description": "",
            "supplier": "<supplier-id>",
            "type": "ImmunoReagent",
            "details": {
                "...": "see the schema of the selected type"
            },
            "rrid": "",
            "external_identifiers": {},
            "comments": "",
            "instance_id": "<id>",
            "action": "Add",
            "reviewer": "<user-id>",
            "status": "Pending"
        }
    ],
    "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/resources/consumableapproval/
• 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('consumableapproval', data={"name": "Consumable approval 1", "supplier": "<supplier-id>", "type": "ImmunoReagent", "details": {"...": "see the schema of the selected type"}, "instance_id": "<id>", "action": "Add", "reviewer": "<user-id>", "status": "Pending", "merge_to_id": "<merge_to_id>"})
record = resp.json()['consumable_approval']

Use example (MATLAB API tool)

created = client.save(struct('name', 'Consumable approval 1', 'supplier', '<supplier-id>', 'type', 'ImmunoReagent', 'details', struct(), 'instance_id', '<id>', 'action', 'Add', 'reviewer', '<user-id>', 'status', 'Pending', 'merge_to_id', '<merge_to_id>'), 'consumableapproval');  % struct() stands for the fields of the selected type
record = created.consumable_approval;

Detail

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

Use example (Python API tool)

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

Use example (MATLAB API tool)

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

Response example

{
    "consumable_approval": {
        "id": "<id>",
        "name": "Consumable approval 1",
        "description": "",
        "supplier": "<supplier-id>",
        "type": "ImmunoReagent",
        "details": {
            "...": "see the schema of the selected type"
        },
        "rrid": "",
        "external_identifiers": {},
        "comments": "",
        "instance_id": "<id>",
        "action": "Add",
        "reviewer": "<user-id>",
        "status": "Pending"
    }
}

Change

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

Use example (MATLAB API tool)

client.save(struct('id', '<id>', 'name', 'Consumable approval 1 (renamed)'), 'consumableapproval', 'method', 'patch');

Delete

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

Use example (Python API tool)

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

Use example (MATLAB API tool)

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

Custom actions

Action	Request
accept_approval	PATCH, POST /api/private/resources/consumableapproval/<id>/accept/
cancel_approval	PATCH, POST /api/private/resources/consumableapproval/<id>/cancel/
hold_for_merge_approval	PATCH, POST /api/private/resources/consumableapproval/<id>/hold_for_merge/
hold_for_rejection_approval	PATCH, POST /api/private/resources/consumableapproval/<id>/hold_for_rejection/
merge_approval	PATCH, POST /api/private/resources/consumableapproval/<id>/merge/
reject_approval	PATCH, POST /api/private/resources/consumableapproval/<id>/reject/
changes_required_approval	PATCH, POST /api/private/resources/consumableapproval/<id>/require_changes/

Approval requests are reviewed by the admin team of the taxonomy or resource. The actions move a request through its lifecycle: accept, reject, require_changes, hold_for_merge, merge (merge into an existing record given by merge_to_id) and cancel (by the submitter).