v29 BMS permissions required for using BrAPI services
- Corina Habito
Related: v29 API changes documentation
The following permissions are necessary for accessing specific services.
Method | BrAPI Calls | BMS Permission Required |
VERSION 2.0 | ||
Token |
|
|
POST | /brapi/v1/token | not applicable |
BrAPI-Germplasm |
|
|
GET | /{crop}/brapi/v2/germplasm | Full | Germplasm | Manage Germplasm | Search Germplasm |
POST | /{crop}/brapi/v2/germplasm | Full | Germplasm | Manage Germplasm |
PUT | /{crop}/brapi/v2/germplasm/{germplasmDbId} | Full | Germplasm | Manage Germplasm |
POST | /{crop}/brapi/v2/search/germplasm | Full | Germplasm | Manage Germplasm | Search Germplasm |
GET | /{crop}/brapi/v2/search/germplasm/{searchResultsDbId} | Full | Germplasm | Manage Germplasm | Search Germplasm |
POST | /{crop}/brapi/v2/search/attributevalues | Full | Germplasm | Manage Germplasm |
GET | /{crop}/brapi/v2/search/attributevalues/{searchResultsDbId} | Full | Germplasm | Manage Germplasm |
GET | /{crop}/brapi/v2/search/attribute/{searchResultsDbId} | Full | Germplasm | Manage Germplasm |
POST | /{crop}/brapi/v2/search/attributes | Full | Germplasm | Manage Germplasm |
PUT | /{crop}/brapi/v2/pedigree | Full | Germplasm | Manage Germplasm |
POST | /{crop}/brapi/v2/search/pedigree | Full | Germplasm | Manage Germplasm |
GET | /{crop}/brapi/v2/search/pedigree/{searchResultsDbId} | Full | Germplasm | Manage Germplasm |
GET | /{crop}/brapi/v2/breedingmethods | Full | Crop Management | Manage Crop Settings | Manage Studies | View Studies |
GET | /{crop}/brapi/v2/breedingmethods/{breedingMethodDbId} | Full | Crop Management | Manage Crop Settings | Manage Studies | View Studies |
GET | /{crop}/brapi/v2/seedlots/transactions | Full | Crop Management | Manage Inventory | Manage Transactions | View Transactions |
GET | /{crop}/brapi/v2/seedlots | Full | Crop Management | Manage Inventory | Manage Lots | View Lots |
BrAPI-Phenotyping |
|
|
POST | /{crop}/brapi/v2/search/variables | Full | Crop Management | Manage Ontologies |
GET | /{crop}/brapi/v2/search/variables/{searchResultsDbId} | Full | Crop Management | Manage Ontologies |
GET | /{crop}/brapi/v2/variables | Full | Crop Management | Manage Ontologies |
POST | /{crop}/brapi/v2/variables | Full | Crop Management | Manage Ontologies |
PUT | /{crop}/brapi/v2/variables/{observationVariableDbId} | Full | Crop Management | Manage Ontologies |
GET | /{crop}/brapi/v1/variables | Full | Crop Management | Manage Ontologies |
GET | /{crop}/brapi/v2/observationlevels | Full | Studies | Manage Studies | View Studies |
GET | /{crop}/brapi/v2/observationunits | Full | Studies | Manage Studies | View Studies |
POST | /{crop}/brapi/v2/observationunits | Full | Studies | Manage Studies | Manage Observation Units |
PATCH | /{crop}/brapi/v2/observationunits/{observationUnitDbId} | Full | Studies | Manage Studies | Manage Observation Units | Edit Georeference |
POST | /{crop}/brapi/v2/search/observationunits | Full | Studies | Manage Studies | View Studies |
GET | /{crop}/brapi/v2/search/observationunits/{searchResultsDbId} | Full | Studies | Manage Studies | View Studies |
GET | /{crop}/brapi/v2/observations | Full | Studies | Manage Studies | View Studies |
POST | /{crop}/brapi/v2/observations | Full | Studies | Manage Studies | Observations | Manage Confirmed Observations |
PUT | /{crop}/brapi/v2/observations | Full | Studies | Manage Studies | Observations | Manage Pending Observations |
POST | /{crop}/brapi/v2/search/observations | Full | Studies | Manage Studies | View Studies |
GET | /{crop}/brapi/v2/search/observations/{searchResultsDbId} | Full | Studies | Manage Studies | View Studies |
BrAPI-Core |
|
|
POST | /{crop}/brapi/v2/search/trials | Full | Studies | Manage Studies | View Studies |
GET | /{crop}/brapi/v2/search/trials/{searchResultsDbId} | Full | Studies | Manage Studies | View Studies |
GET | /{crop}/brapi/v2/trials | Full | Studies | Manage Studies | View Studies |
POST | /{crop}/brapi/v2/trials | Full | Studies | Manage Studies |
GET | /{crop}/brapi/v2/studies | Full | Studies | Manage Studies | View Studies |
POST | /{crop}/brapi/v2/studies | Full | Studies | Manage Studies |
GET | /{crop}/brapi/v2/studies/{studyDbId} | Full | Studies | Manage Studies | View Studies |
PUT | /{crop}/brapi/v2/studies/{studyDbId} | Full | Studies | Manage Studies |
POST | /{crop}/brapi/v2/search/studies | Full | Studies | Manage Studies | View Studies |
GET | /{crop}/brapi/v2/search/studies/{searchResultsDbId} | Full | Studies | Manage Studies | View Studies |
GET | /{crop}/brapi/v2/programs | not applicable. The API will only return the programs the user has access to. |
GET | /{crop}/brapi/v2/locations | Full | Crop Management | Manage Crop Settings | Manage Studies | View Studies |
GET | /{crop}/brapi/v2/locations/{locationDbId} | Full | Crop Management | Manage Crop Settings | Studies | Manage Studies | View Studies | Study Actions | Analyze with Decision Support | Analyze with STA BrAPP |
POST | /{crop}/brapi/v2/search/locations | Full | Crop Management | Manage Crop Settings | Manage Studies | View Studies |
GET | /{crop}/brapi/v2/search/locations/{searchResultsDbId} | Full | Crop Management | Manage Crop Settings | Manage Studies | View Studies |
GET | /{crop}/brapi/v2/lists | Full | Lists | Manage Germplasm Lists |
POST | /{crop}/brapi/v2/lists | Full | Lists | Manage Germplasm Lists |
BrAPI-Genotyping |
|
|
GET | /{crop}/brapi/v2/samples | Full | Studies | Manage Studies | Observations | View Observations | Sample Lists | Import Genotypes Options | Import Genotypes From Gigwa | Import Genotypes from File | List | Sample Lists |
GET | /{crop}/brapi/v2/samples/{sampleDbId} | Full | Studies | Manage Studies | Observations | View Observations | Sample Lists | Import Genotypes Options | Import Genotypes From Gigwa | Import Genotypes from File | List | Sample Lists |
POST | /{crop}/brapi/v2/search/samples | Full | Studies | Manage Studies | Observations | View Observations | Sample Lists | Import Genotypes Options | Import Genotypes From Gigwa | Import Genotypes from File | List | Sample Lists |
GET | /{crop}/brapi/v2/search/samples/{searchResultsDbId} | Full | Studies | Manage Studies | Observations | View Observations | Sample Lists | Import Genotypes Options | Import Genotypes From Gigwa | Import Genotypes from File | List | Sample Lists |
VERSION 1.3 | ||
Token |
|
|
POST | /brapi/v2/token | not applicable |
Calls |
|
|
GET | /brapi/v1/calls | not applicable |
GET | /{crop}/brapi/v1/calls | not applicable |
Crops |
|
|
GET | /brapi/v1/crops | not applicable |
Trials |
|
|
GET | /{crop}/brapi/v1/trials | Full | Studies | Manage Studies | View Studies |
GET | /{crop}/brapi/v1/trials/{trialDbId}/table | Full | Studies | Manage Studies | View Studies |
Images |
|
|
POST | /{cropName}/brapi/v1/images | Full | Studies | Manage Studies |
PUT | /{cropName}/brapi/v1/images/{imageDbId} | Full | Studies | Manage Studies |
PUT | /{cropName}/brapi/v1/images/{imageDbId}/imagecontent | Full | Studies | Manage Studies |
POST | /{crop}/brapi/v2/images | Full | Studies | Manage Studies |
Studies |
|
|
GET | /{crop}/brapi/v1/studies | Full | Studies | Manage Studies | View Studies |
GET | /{crop}/brapi/v1/studies/{studyDbId} | Full | Studies | Manage Studies | View Studies |
PUT | /{crop}/brapi/v1/studies/{studyDbId}/observations | Full | Studies | Manage Studies | View Studies |
GET | /{crop}/brapi/v1/studies/{studyDbId}/observationunits | Full | Studies | Manage Studies | View Studies |
GET | /{crop}/brapi/v1/studies/{studyDbId}/observationvariables | Full | Studies | Manage Studies | View Studies |
GET | /{crop}/brapi/v1/studies/{studyDbId}/table | Full | Studies | Manage Studies | View Studies |
Observations |
|
|
GET | /{crop}/brapi/v1/observationlevels | Full | Studies | Manage Studies |
Programs |
|
|
GET | /{crop}/brapi/v1/programs | not applicable. The API will only return the programs the user has access to. |
Germplasm |
|
|
GET | /{crop}/brapi/v1/germplasm | Full | Germplasm | Manage Germplasm | Search Germplasm |
GET | /{crop}/brapi/v1/germplasm/{germplasmDbId} | Full | Germplasm | Manage Germplasm | Search Germplasm |
GET | /{crop}/brapi/v1/germplasm/{germplasmDbId}/attributes | Full | Germplasm | Manage Germplasm |
GET | /{crop}/brapi/v1/germplasm/{germplasmDbId}/pedigree | Full | Germplasm | Manage Germplasm |
GET | /{crop}/brapi/v1/germplasm/{germplasmDbId}/progeny | Full | Germplasm | Manage Germplasm |
POST | /{crop}/brapi/v1/search/germplasm | Full | Germplasm | Manage Germplasm | Search Germplasm |
GET | /{crop}/brapi/v1/search/germplasm/{searchResultsDbid} | Full | Germplasm | Manage Germplasm | Search Germplasm |
GET | /{crop}/brapi/v1/studies/{studyDbId}/germplasm | Full | Germplasm | Manage Germplasm | Search Germplasm |
Locations |
|
|
GET | /{crop}/brapi/v1/locations | Full | Crop Management | Manage Crop Settings | Manage Studies | View Studies |
Samples |
|
|
GET | /{crop}/brapi/v1/samples/{sampleDbId} | Full | Studies | Manage Studies | Observations | View Observations | Sample Lists | Import Genotypes Options | Import Genotypes From Gigwa | Import Genotypes from File | List | Sample Lists |
Phenotypes |
|
|
POST | /{crop}/brapi/v1/phenotypes-search | Full | Studies | Manage Studies | Manage Observation Units | Graphical Queries |
|
|
|
Other | ||
GET | /brapi/authorize | not applicable |
POST | /token | not applicable |
GET | /{crop}/brapi/authorize | not applicable |
GET | /brapi/v2/serverinfo | not applicable |
GET | /{crop}/brapi/v2/serverinfo | not applicable |