Select Entities By Layer
analysis_select_by_layerRead-only
Select all entities on a specified layer and return their handles. Compact mode provides a columnar summary with total entity counts and truncation flags.
Instructions
Get all entities on a specific layer. Returns entity list with handles.
Capped at MAX_LIST_LIMIT (default 5000). The plain list cannot say it was
capped — the warning goes to the log stream, which most clients never show
the model — so use compact=True when the count matters: its total is the
layer's real population and truncated states whether the cap fired.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| fields | No | Project to these fields, in this order (e.g. ['handle','type','layer']); 'properties.<key>' reaches one nested value. Omit for the full record; an unknown name errors and lists the valid ones. | |
| compact | No | Return a columnar {fields, rows, count, offset, total, truncated, next_offset} envelope instead of dicts: much cheaper per row, and the only shape that reports truncation. | |
| layer_name | Yes | Layer name to select entities from |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |