v25 API changes documentation

Owned by Corina Habito
Last updated: 20 Sept, 2023

BMSAPI

The list below only contains modifications to existing APIs. New APIs introduced in this release are NOT included.

API

Version Modified

Action

API

Version Modified

Action

POST /crops/{cropName}/germplasm/batch-delete

V24.1

Modified the existing DELETE /crops/{cropName}/germplasm/

POST /{crop}/programs/{programUUID}/studies/{studyId}/datasets/{datasetId}/observation-units/drafts/acceptance

V24.2

Added instanceIds request query parameter

POST /{crop}/programs/{programUUID}/studies/{studyId}/datasets/{datasetId}/observation-units/drafts/rejection

V24.2

Added instanceIds request query parameter

POST /{crop}/programs/{programUUID}/studies/{studyId}/datasets/{datasetId}/observation-units/drafts/set-as-missing

V24.2

Added instanceIds request query parameter

GET /crops/{cropName}/germplasm/{gid}/attributes

 

V24.3

Added gid and cValueId fields in the response data

BRAPI v1 Changes

API Call

Change for v25

API Call

Change for v25

GET /brapi/authorize
POST ​/brapi​/v1​/token
POST /token
GET /{crop}/brapi/authorize
GET /brapi/v1/crops
GET /brapi/v1/calls
GET /{crop}/brapi/v1/calls
GET /{crop}/brapi/v1/studies/{studyDbId}/germplasm

Updated the permissions in 24.2 and program admin only has access to the following BrAPI v1 calls.

BRAPI v2

API Call

Action

API Call

Action

GET /brapi/v2/serverinfo
GET /{crop}/brapi/v2/serverinfo
PUT /{crop}/brapi/v2/studies/{studyDbId}
PATCH /{crop}/brapi/v2/observationunits/{observationUnitDbId}
POST /brapi/v2/token

We updated the permissions in 24.2 and program admin only has access to the following BrAPI v2 calls.

GET /{crop}/brapi/v2/observationlevels

Level names are now in lowercase to conform to the BrAPI standard.

POST /{crop}/brapi/v2/observations

  • If the observation value is “NA”, BMS saves it as “missing“. This only applies to Numerical and Categorical Observation/Trait

  • If the observation variable’s datatype is DATE, the system should expect the value in yyyy-MM-dd format to conform to the date standard standard in BrAPI

PUT /{crop}/brapi/v2/observations

  • If the observation value is “NA”, BMS saves it as “missing“. This only applies to Numerical and Categorical Observation/Trait

  • If the observation variable’s datatype is DATE, the system should expect the value in yyyy-MM-dd format to conform to the date standard standard in BrAPI

GET /{crop}/brapi/v2/variables

Added observationLevelNames to additionalInfoField

POST /{crop}/brapi/v2/images

The request body now accepts array to conform to the standard.

PUT /{crop}/brapi/v2/images/{imageDbId}

Newly implemented

PUT/{crop}/brapi/v2/images/{imageDbId}/imagecontent

Newly implemented