Brapi Get Study
brapi_get_studyFetch a single study by DbId with program, trial, and location fully resolved. Response includes cheap observation/observation-unit/variable counts as drill-down signals.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| alias | No | Connection alias registered via brapi_connect. Omit to read the connection registered under alias `default` — i.e. a prior brapi_connect call that did not specify an alias. Calls that used a non-default alias must pass that same alias here. | |
| studyDbId | Yes | Study identifier. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| alias | No | Alias of the registered BrAPI connection the call used. | |
| error | No | Present when the call failed. Absent on success. | |
| study | No | Canonical study record as returned by `/studies/{id}`. | |
| trial | No | Resolved trial record (when the study has a trialDbId and the FK lookup succeeded). | |
| program | No | Resolved program record (when the study has a programDbId and the FK lookup succeeded). | |
| location | No | Resolved location record (when the study has a locationDbId and the FK lookup succeeded). | |
| warnings | No | Advisory messages — failed FK lookups, missing counts. | |
| variableCount | No | Total observation variables (traits) measured in this study. Omitted (with a warning) when the upstream server cannot scope the count to the study — never reported as the server-wide total. | |
| observationCount | No | Total observations recorded against this study. Omitted (with a warning) when the upstream server cannot scope the count to the study — never reported as the server-wide total. | |
| observationUnitCount | No | Total observation units (plots, plants, samples) in this study. |