get_variants
Fetch variant records and optional genotypes from indexed VCF/BCF files overlapping a specified genomic interval. Filter by samples or PASS status to obtain relevant variants for locus-specific analysis.
Instructions
Variant records and optional genotypes overlapping an interval (VCF/BCF). Not implemented in this build: returns error code 'unsupported' (E4).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| file | Yes | ||
| samples | No | ||
| interval | Yes | ||
| pass_only | No | ||
| max_records | No | Lower the record limit. | |
| include_genotypes | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| data | No | ||
| error | No | Set when status is error. | |
| errors | No | Per-source failures in partial results. | |
| limits | No | ||
| status | Yes | ||
| warnings | No | ||
| operation | Yes | ||
| provenance | No | ||
| truncation | No | ||
| source_status | No | ||
| schema_version | No | 1 |