Hardware device approval API endpoint

A request to add or change a shared hardware device, 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/hardwaredeviceapproval/ (needs a token; one record: append <id>/)
  • Public portal: not available
  • Response keys: hardwaredevice_approval (detail, create, update), hardwaredevice_approvals (list)
  • Permissions: see the permissions page
  • Entry schemas: type selects a HardwareDevice 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.

FieldDescription
idUUID string [read-only]
namestring [required]; max 100 characters
typeone of the HardwareDevice types [required]
descriptionstring; max 2000 characters
suppliersupplier id [required]
rridstring; max 100 characters; nullable. Research Resource Identifier (RRID) for tracking standardized research resources
type_jsonJSON object; nullable
external_identifiersJSON object; nullable. External identifiers and their source URLs from various databases (NCBI, JAX, DOI, etc.)
commentsstring; nullable
instance_idUUID string [required]; nullable
actionone of Add, Change [required]
revieweruser id [required]; nullable
statusone 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/hardwaredeviceapproval/
  • Responses: 200 OK; 401 Not authenticated; 403 Not allowed

Use example (Python API tool)

resp = client.load('hardwaredeviceapproval', load_all=True)
records = resp['hardwaredevice_approvals']

Use example (MATLAB API tool)

resp = client.load('hardwaredeviceapproval', 'load_all', true);
records = resp.hardwaredevice_approvals;

Response example

{
    "hardwaredevice_approvals": [
        {
            "id": "<id>",
            "name": "Hardware device approval 1",
            "type": "Amplifier",
            "description": "",
            "supplier": "<supplier-id>",
            "rrid": "",
            "type_json": {
                "...": "see the schema of the selected type"
            },
            "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/hardwaredeviceapproval/
  • 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('hardwaredeviceapproval', data={"name": "Hardware device approval 1", "type": "Amplifier", "supplier": "<supplier-id>", "instance_id": "<id>", "action": "Add", "reviewer": "<user-id>", "status": "Pending", "merge_to_id": "<merge_to_id>"})
record = resp.json()['hardwaredevice_approval']

Use example (MATLAB API tool)

created = client.save(struct('name', 'Hardware device approval 1', 'type', 'Amplifier', 'supplier', '<supplier-id>', 'instance_id', '<id>', 'action', 'Add', 'reviewer', '<user-id>', 'status', 'Pending', 'merge_to_id', '<merge_to_id>'), 'hardwaredeviceapproval');
record = created.hardwaredevice_approval;

Detail

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

Use example (Python API tool)

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

Use example (MATLAB API tool)

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

Response example

{
    "hardwaredevice_approval": {
        "id": "<id>",
        "name": "Hardware device approval 1",
        "type": "Amplifier",
        "description": "",
        "supplier": "<supplier-id>",
        "rrid": "",
        "type_json": {
            "...": "see the schema of the selected type"
        },
        "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/hardwaredeviceapproval/<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('hardwaredeviceapproval', id='<id>', data={"name": "Hardware device approval 1 (renamed)"})

Use example (MATLAB API tool)

client.save(struct('id', '<id>', 'name', 'Hardware device approval 1 (renamed)'), 'hardwaredeviceapproval', 'method', 'patch');

Delete

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

Use example (Python API tool)

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

Use example (MATLAB API tool)

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

Custom actions

ActionRequest
accept_approvalPATCH, POST /api/private/resources/hardwaredeviceapproval/<id>/accept/
cancel_approvalPATCH, POST /api/private/resources/hardwaredeviceapproval/<id>/cancel/
hold_for_merge_approvalPATCH, POST /api/private/resources/hardwaredeviceapproval/<id>/hold_for_merge/
hold_for_rejection_approvalPATCH, POST /api/private/resources/hardwaredeviceapproval/<id>/hold_for_rejection/
merge_approvalPATCH, POST /api/private/resources/hardwaredeviceapproval/<id>/merge/
reject_approvalPATCH, POST /api/private/resources/hardwaredeviceapproval/<id>/reject/
changes_required_approvalPATCH, POST /api/private/resources/hardwaredeviceapproval/<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).