v27 API changes documentation

Owned by Corina Habito
Last updated: 07 Jun, 2024
2 min read

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

GET​/{cropname}/variables/filter

26.2

Added projectId parameter

POST /crops/{cropName}/files

26.2

Added projectId parameter

HEAD /crops/{cropName}/filemetadata

26.2

Added projectId parameter

DELETE /crops/{cropName}/filemetadata

26.2

Added projectId parameter

DELETE /crops/{cropName}/filemetadata/variables

26.2

Added projectId parameter

GET /crops/{cropName}/crop-parameters/{groupName}/group

26.2

Added programUUID parameter

BRAPI v1 Changes

API

Version Modified

Action

API

Version Modified

Action

GET /{crop}/brapi/v1/studies

26.5

Correct the situation where a null string ("null") is presented when there is no value available.

GET /{crop}/brapi/v1/studies/{studyDbId}

26.5

Correct the situation where a null string ("null") is presented when there is no value available.

GET /{crop}/brapi/v1/trials

26.5

Correct the situation where a null string ("null") is presented when there is no value available.

GET /{crop}/brapi/v1/locations

26.5

Correct the situation where a null string ("null") is presented when there is no value available.

GET /{crop}/brapi/v1/studies/{studyDbId}/observationvariables
GET /{crop}/brapi/v1/variables

26.5

  • Correct the situation where a null string ("null") is presented when there is no value available.

  • observationVariableName now returns the variable name instead of alias.

  • Variable alias is populated in observationVariable.synonyms[..].

  • The ontologyReference.ontologyDbId field for observationVariable should contain the ontologyDbId

BRAPI v2

 

API

Version Modified

Action

API

Version Modified

Action

GET /{crop}/brapi/v2/studies

26.5

Correct the situation where a null string ("null") is presented when there is no value available.

GET /{crop}/brapi/v2/studies/{studyDbId}

26.5

Correct the situation where a null string ("null") is presented when there is no value available.

GET /{crop}/brapi/v2/trials

26.5

Correct the situation where a null string ("null") is presented when there is no value available.

GET /{crop}/brapi/v2/search/trials/{searchResultsDbId}

26.5

Correct the situation where a null string ("null") is presented when there is no value available.

GET /{crop}/brapi/v2/locations/{locationDbId}

26.5

Correct the situation where a null string ("null") is presented when there is no value available.

GET /{crop}/brapi/v2/locations

26.5

Correct the situation where a null string ("null") is presented when there is no value available.

GET /{crop}/brapi/v2/variables
POST/GET /{crop}/brapi/v2/search/variables

26.5

  • Correct the situation where a null string ("null") is presented when there is no value available.

  • observationVariableName now returns the variable name instead of alias.

  • Variable alias is populated in observationVariable.synonyms[..].

  • The ontologyReference.ontologyDbId field for observationVariable should contain the ontologyDbId

Notes