execute_rma_query
Query the Allen Brain API for arbitrary data models like Specimen or SectionDataSet using RMA criteria. Filter, include related objects, and paginate results.
Instructions
Executes a generic RMA (RESTful Model Access) query against the Allen Brain API. Useful for querying arbitrary data models like 'Specimen', 'SectionDataSet', 'Structure', etc.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| model | Yes | The top-level data model to query, e.g., 'Specimen', 'SectionDataSet'. | |
| criteria | No | RMA criteria clause to filter objects, e.g., '[is_cell_specimen$eq\'true\']'. | |
| include | No | RMA include clause to return associated objects, e.g., 'donor(organism)'. | |
| only | No | List of fields to include in the response (RMA only clause). | |
| except | No | List of fields to exclude from the response (RMA except clause). | |
| numRows | No | Maximum number of rows to return (default is 50). | |
| startRow | No | Pagination start row (default is 0). |