Breeding API Overview

Supported Calls
Call URL (https://www.crop-diversity.org/mgis/brapi/v1/)Call nameVersionProxy/aggregationSupported methodsDescriptionFeatures
/Aboutn/aREADAbout Breeding API Drupal implementation
/tokenAuthentication1.1LOGIN, LOGOUTUser authentication in OAuth2 style
/calls/callNameCall Search1.1READList supported Breeding API calls
/cropsCrops1.1READ, FILTERINGList supported crops
/commonCropNamesCmmon Crop Names1.2READ, FILTERINGList the common crop names for the crops available in the database server.
/mapsGenome MapProxiedGigwa - Musa Acuminata GWAS Panel - GBS - genome V1n/aGet list of maps
/maps/{mapDbId}Genome Map DetailsProxiedGigwa - Musa Acuminata GWAS Panel - GBS - genome V1n/aGet map details
/germplasmGermplasm1.1READ, FILTERINGGermplasm list
MCPD: yes
MCPD-version: V.2.1
/germplasm/germplasmDbIdGermplasm Details1.1CREATE, READ, UPDATE, DELETEGermplasm details by germplasmDbId
MCPD: yes
MCPD-version: V.2.1
/search/germplasmSearch Germplasm1.2READ, FILTERINGSearch for a set of germplasm based on some criteria, returning a search results id
/search/germplasm/{searchResultsDbId}Get Germplasm Search Results1.2READGet results of search/germplasm call by search id
/attributesGermplasm Attribute List1.1READList attributes available
/attributes/categoriesGermplasm Attribute Category List1.1READList attribute categories available
/germplasm/germplasmDbId*/attributesGermplasm Attributes1.1READGermplasm attribute values by germplasmDbId
/germplasm/breedingmethodsGermplasm Breeding Methods1.2READGet the list of germplasm breeding methods available in a system.
/germplasm/breedingmethods/{breedingMethodDbId}Germplasm Breeding Method1.2READGet specific germplasm breeding method by identifier
/germplasm/{germplasmDbId}/mcpdGermplasm by MCPD1.2READGermplasm by Multi-Crop Passport Descriptors
/germplasm/germplasmDbId*/markerprofilesGermplasm Markerprofiles1.1READMarkerprofiles by germplasmDbId
/germplasm/germplasmDbId*/pedigreeGermplasm Pedigree1.1READPedigree by germplasmDbId
/germplasm/{germplasmDbId}/progenyGermplasm by Progeny1.2READGet the germplasmDbIds for all the Progeny of a particular germplasm
/germplasm-searchGermplasm Search1.1READ, FILTERINGGermplasm search
MCPD: yes
MCPD-version: V.2.1
/imagesImages1.2READ, FILTERINGGet/Create filtered set of image meta data
/images/{imageDbId}Images1.2CREATE, READ, UPDATEGet/Update one image meta data
/images/{imageDbId}/imagecontentImages1.2CREATE, READ, UPDATEUpdate an image with the image file content
/search/imagesSearch Images1.2READ, FILTERINGSearch for a set of images based on some criteria, returning a search results id
/search/images/{searchResultsDbId}Search Images1.2READGet results of search/images call by search id
/listsImages1.2READ, FILTERINGGet/Create filtered set of generic lists
/lists/{listDbId}Images1.2CREATE, READ, UPDATEGet/Update one generic lists
/lists/{listDbId}/itemsImages1.2READ, FILTERINGAdd new data to a specific generic lists
/locationsLocations1.1READList Locations
/locations/locationDbIdLocations Details1.1READLocations details by locationDbId
/markerprofilesMarkerprofile SearchProxiedGigwa - Musa Acuminata GWAS Panel - GBS - genome V1n/aList marker profiles
/search/markersSearch Markers1.2READ, FILTERINGSearch for a set of markers based on some criteria, returning a search results id
/search/markers/{searchResultsDbId}Get Markers Search Results1.2READGet results of search/markers call by search id
/ontologiesVariable ontology listProxiedCrop Ontologyn/aList ontologies
/variablesVariable ListProxiedCrop Ontologyn/aList variables
/variables/observationVariableDbIdVariable DetailsProxiedCrop Ontologyn/aVariable details by observationVariableDbId
/variables/datatypesVariable Data Types1.1READVariable data type list
/search/variablesSearch Germplasm1.2READ, FILTERINGSearch for a set of Observation Variables based on some criteria, returning a search results id
/search/variables/{searchResultsDbId}Get Germplasm Search Results1.2READGet results of search/variables call by search id
/traitsTrait List1.1READ, FILTERINGList all traits
/traits/traitDbIdTrait Details1.1CREATE, READ, UPDATETrait details by traitDbId
/scalesScale List1.2READ, FILTERINGList all scales
/scales/scaleDbIdScale Details1.2CREATE, READ, UPDATEGet/Update Scale details by scaleDbId
/methodsMethod List1.2READ, FILTERINGList all Methods
/methods/methodDbIdGet/Update Method Details1.2CREATE, READ, UPDATEGet/Update Method details by methodDbId
/peopleImages1.2READ, FILTERINGGet/Create filtered set of people records
/people/{personDbId}Images1.2CREATE, READ, UPDATEGet/Update one person
/phenotypes-search/csvPhenotype Search (CSV)1.2READ, FILTERINGSearch phenotypes returning a CSV formatted file
/phenotypes-search/tsvPhenotype Search (TSV)1.2READ, FILTERINGSearch phenotypes returning a TSV formatted file
/phenotypes-search/tablePhenotype Search (Table as JSON)1.2READ, FILTERINGSearch phenotypes returning JSON formatted file
/observationunitsObservation Unit List1.2READGet a set of observation units
/search/observationtablesSearch Observation Tables 1.2READ, FILTERINGSearch for a set of Observation Units based on some criteria, to be retrieved as a formatted table of results of a preferred format; returns a search results id
/search/observationtables/{searchResultsDbId}Get Observation Tables Search Results1.2READGet results of search/observationtables call by search id
/search/observationunitsSearch Observation Units1.2READ, FILTERINGGlobally search for a set of Observation Units based on some criteria, to be retrieved as JSON results;eturnsa search results id
/search/observationunits/{searchResultsDbId}Get Observation Units Search Results1.2READGet results of search/observationunits call by search id
/programsProgram List1.1READ, FILTERINGList programs
/programs/programDbIdProgram Details1.1READProgram details by programDbId
/programs-searchProgram Search1.1READ, FILTERINGSearch programs
/search/programsSearch Breeding Programs1.2READ, FILTERINGSearch for a set of breeding programs based on some criteria, returning a search results id
/search/programs/{searchResultsDbId}Get Breeding Programs Search Results1.2READGet results of search/programs call by search id
/samplesSample List1.1CREATE, READ, UPDATESample list call
/samples/sampleDbIdSample Details1.1CREATE, READ, UPDATE, DELETESample details by sampleDbId
/samples-searchSample Search1.1READ, FILTERINGSearch samples
/search/samplesSearch Samples1.2READ, FILTERINGSearch for a set of samples based on some criteria, returning a search results id
/search/samples/{searchResultsDbId}Get Samples Search Results1.2READGet results of search/samples call by search id
/studies/studyDbId*/germplasmStudy Germplasm DetailsProxiedGigwa - Musa Acuminata GWAS Panel - GBS - genome V1n/aStudy germplasm details by studyDbId
/studies/studyDbId*/layoutsPlot Layout Details1.2CREATE, READ, UPDATERetrieve plot layout details
/studies/{studyDbId}/observationunits/zipStudy Observations Zip File Upload1.2READ, FILTERINGuploading new Observations as a batched Zip File to a system
/studies/studyDbId*/observationVariablesStudy Observation Variables1.2READ, FILTERINGGet observation variables by studyDbId
/studies-searchStudy searchProxiedGigwa - Musa Acuminata GWAS Panel - GBS - genome V1n/aSearch studies
/search/studiesSearch Studies1.2READ, FILTERINGSearch for a set of Studies based on some criteria, returning a search results id
/search/studies/{searchResultsDbId}Get Studies Search Results1.2READGet results of search/studies call by search id
/studyTypesStudy Type List1.2READList study types
/observationLevelsObservation Level List1.2READList observation levels
/vendors/ordersPlate Search1.2READ, FILTERINGSubmit an new order/List current available orders to a vendor
/vendors/orders/{orderId}/platesRetrieve Order Details1.2READRetrieve the plate and sample details of an order being processed
/vendors/orders/{orderId}/resultsRetrieve Order Results1.2READRetrieve the data files generated by the vendors analysis
/vendors/orders/{orderId}/statusRetrieve Order Status1.2READRetrieve the current status of an order being processed
/vendors/platesPlate Search1.2READ, FILTERINGSubmit a new set of Sample data
/vendors/plates/{submissionId}Plate Search1.2READGet data for a submitted set of plates