Breeding API Overview

Supported Calls
Call URL (https://www.carrotomics.org/brapi/v1/)	Call name	Version	Supported methods	Description	Features
/	About	n/a	READ	About Breeding API Drupal implementation
/calls/callName	Call Search	1.2	READ	List supported Breeding API calls
/crops	Crops	1.2	READ, FILTERING	List supported crops
/commonCropNames	Common Crop Names	1.2	READ, FILTERING	List the common crop names for the crops available in the database server.
/maps	Genome Map	1.2	READ	Get list of maps
/maps/{mapDbId}	Genome Map Details	1.2	READ	Get map details
/maps/{mapDbId}/positions	Genome map data	1.2	READ	Get map data
/maps/{mapDbId}/positions/{linkageGroupName}	Genome Map Data by range on linkageGroup	1.2	READ	Get map data by range on linkageGroup
/germplasm	Germplasm	1.2	READ, FILTERING	Germplasm list	MCPD: yes MCPD-version: V.2.1
/germplasm/germplasmDbId	Germplasm Details	1.2	CREATE, READ, UPDATE, DELETE	Germplasm details by germplasmDbId	MCPD: yes MCPD-version: V.2.1
/attributes	Germplasm Attribute List	1.2	READ	List attributes available
/attributes/categories	Germplasm Attribute Category List	1.2	READ	List attribute categories available
/germplasm/germplasmDbId*/attributes	Germplasm Attributes	1.2	READ	Germplasm attribute values by germplasmDbId
/germplasm/breedingmethods	Germplasm Breeding Methods	1.2	READ	Get the list of germplasm breeding methods available in a system.
/germplasm/breedingmethods/{breedingMethodDbId}	Germplasm Breeding Method	1.2	READ	Get specific germplasm breeding method by identifier
/germplasm/germplasmDbId*/markerprofiles	Germplasm Markerprofiles	1.2	READ	Markerprofiles by germplasmDbId
/germplasm/germplasmDbId*/pedigree	Germplasm Pedigree	1.2	READ	Pedigree by germplasmDbId
/germplasm/{germplasmDbId}/progeny	Germplasm by Progeny	1.2	READ	Get the germplasmDbIds for all the Progeny of a particular germplasm
/germplasm-search	Germplasm Search	1.2	READ, FILTERING	Germplasm search	MCPD: yes MCPD-version: V.2.1
/images	Images	1.3	READ, FILTERING	Get/Create filtered set of image meta data
/images/{imageDbId}	Images	1.3	CREATE, READ, UPDATE	Get/Update one image meta data
/images/{imageDbId}/imagecontent	Images	1.3	CREATE, READ, UPDATE	Update an image with the image file content
/search/images	Search Images	1.3	READ, FILTERING	Search for a set of images based on some criteria, returning a search results id
/search/images/{searchResultsDbId}	Search Images	1.3	READ	Get results of search/images call by search id
/locations	Locations	1.2	READ	List Locations
/locations/locationDbId	Locations Details	1.2	READ	Locations details by locationDbId
/allelematrices	Allele Matrices	1.2	READ	List allele matrices
/allelematrices-search	MarkerProfile Allele Matrix	1.2	READ, FILTERING	Search allele matrices
/markerprofiles	Markerprofile Search	1.2	READ	List marker profiles
/markerprofiles/{markerprofileDbId}	Marker profiles	1.2	READ	Alleles by markerprofileDbId
/markers/markerDbId	Marker Details	1.2	READ	Markers details by markerDbId
/markers-search	Markers Search	1.2	READ, FILTERING	Search markers
/ontologies	Variable ontology list	1.2	READ	List ontologies
/variables	Variable List	1.2	READ	List variables
/variables/observationVariableDbId	Variable Details	1.2	READ	Variable details by observationVariableDbId
/variables/datatypes	Variable Data Types	1.2	READ	Variable data type list
/variables-search	Variable Search	1.2	READ, FILTERING	Search variables
/traits	Trait List	1.2	READ, FILTERING	List all traits
/traits/traitDbId	Trait Details	1.2	CREATE, READ, UPDATE	Trait details by traitDbId
/phenotypes-search/csv	Phenotype Search (CSV)	1.2	READ, FILTERING	Search phenotypes returning a CSV formatted file
/phenotypes-search/tsv	Phenotype Search (TSV)	1.2	READ, FILTERING	Search phenotypes returning a TSV formatted file
/phenotypes-search/table	Phenotype Search (Table as JSON)	1.2	READ, FILTERING	Search phenotypes returning JSON formatted file
/samples	Sample List	1.2	CREATE, READ, UPDATE	Sample list call
/samples/sampleDbId	Sample Details	1.2	CREATE, READ, UPDATE, DELETE	Sample details by sampleDbId
/samples-search	Sample Search	1.2	READ, FILTERING	Search samples
/studies/studyDbId	Study Details	1.2	READ	Studies details by studyDbId
/studies/studyDbId*/germplasm	Study Germplasm Details	1.2	READ	Study germplasm details by studyDbId
/studies/studyDbId*/layout	Plot Layout Details	1.2	CREATE, READ, UPDATE	Retrieve plot layout details
/studies/studyDbId*/observations	Observations Details	1.2	CREATE, READ, UPDATE	Get observation units by observation variable by studyDbId
/studies/studyDbId*/observationunits	Observation Units Details	1.2	CREATE, READ, UPDATE	Get all observation units by studyDbId
/studies/{studyDbId}/observationunits/zip	Study Observations Zip File Upload	1.2	READ, FILTERING	uploading new Observations as a batched Zip File to a system
/studies/studyDbId*/observationVariables	Study Observation Variables	1.2	READ, FILTERING	Get observation variables by studyDbId
/studies/studyDbId*/observationvariables	Study Observation Variables	1.2	READ, FILTERING	Get observation variables by studyDbId
/studies/studyDbId*/table	Study Observation Units as a Table	1.2	READ, FILTERING	Retrieve study observation units as table
/studies-search	Study search	1.2	READ, FILTERING	Search studies
/studyTypes	Study Type List	1.2	READ	List study types
/observationLevels	Observation Level List	1.2	READ	List observation levels
/observationlevels	Observation Level List	1.2	READ	List observation levels
/seasons	Season List	1.2	READ	List seasons
/trials	Trial List	1.2	READ	Retrieve a filtered list of Trials. A Trial is a collection of studies
/trials/trialDbId	Trial Details	1.2	READ	Get Trial By trialDbId
/vendors/vendorPlateDbId*/{vendorPlateDbId}	Plate Details	1.2	READ, FILTERING	Get plate details by vendorPlateId
/vendors/specifications	Vendor Specifications	1.2	READ	Get vendor specifications