BrAPI Endpoints Covered by brapiR2

brapiR2 wraps 49 of the 138 retrieval endpoints the BrAPI v2.1 specification defines, across 32 of its 37 top-level entities. This topic lists them by module, with the function that wraps each one.

Details

Each function's own help page names its endpoint, links to the specification, and lists the query parameters that endpoint accepts. brapi_endpoints() is a different thing: it asks a particular server which endpoints it implements, which is usually a smaller set again.

Core module

GET /lists

brapi_lists()

GET /lists/{listDbId}

brapi_list()

GET /locations

brapi_locations()

GET /locations/{locationDbId}

brapi_location()

GET /people

brapi_people()

GET /programs

brapi_programs()

GET /programs/{programDbId}

brapi_program()

GET /seasons

brapi_seasons()

GET /serverinfo

brapi_endpoints(), brapi_ping(), brapi_server_info()

GET /studies

brapi_studies()

GET /studies/{studyDbId}

brapi_study()

GET /trials

brapi_trials()

GET /trials/{trialDbId}

brapi_trial()

Germplasm module

GET /attributes

brapi_germplasm_attributes()

GET /crosses

brapi_crosses()

GET /crossingprojects

brapi_crossing_projects()

GET /germplasm

brapi_germplasm()

GET /germplasm/{germplasmDbId}

brapi_germplasm_detail()

GET /pedigree

brapi_germplasm_pedigree(), brapi_germplasm_progeny(), brapi_pedigree()

POST /search/germplasm

brapi_search_germplasm()

POST /search/pedigree

brapi_search_pedigree()

GET /seedlots

brapi_seed_lots()

Phenotyping module

GET /events

brapi_events()

GET /images

brapi_images()

GET /methods

brapi_methods()

GET /observations

brapi_observations()

GET /observationunits

brapi_observation_units()

GET /ontologies

brapi_ontologies()

GET /ontologies/{ontologyDbId}

brapi_ontology()

GET /scales

brapi_scales()

POST /search/observations

brapi_search_observations()

POST /search/variables

brapi_search_variables()

GET /traits

brapi_traits()

GET /variables

brapi_observation_variables()

Genotyping module

GET /allelematrix

brapi_allele_matrix()

GET /calls

brapi_calls()

GET /callsets

brapi_call_sets()

GET /maps

brapi_maps()

GET /maps/{mapDbId}

brapi_map()

GET /maps/{mapDbId}/linkagegroups

brapi_map_linkage_groups()

GET /markerpositions

brapi_marker_positions()

GET /references

brapi_references()

GET /referencesets

brapi_reference_sets()

GET /samples

brapi_samples()

POST /search/calls

brapi_search_calls()

POST /search/markerpositions

brapi_search_marker_positions()

POST /search/variants

brapi_search_variants()

GET /variants

brapi_variants()

GET /variantsets

brapi_variant_sets()

Not covered

Common Crop Names, Germplasm Attribute Values, Planned Crosses, Plates and Vendor Samples have no wrapper. POST and PUT write endpoints are out of scope by design. brapi_get() and brapi_post_search() reach anything not wrapped here.