v19 API changes documentation

Created by Mariano Crimi
27 Jul, 2021

BMSAPI

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

API

Version Modified

Action

API

Version Modified

Action

GET /crops/{cropName}/breedingmethods

18.1

Added method code filter and bulkingMethod field

 

 

 

 

 

 

 

BRAPI v1 Changes

API Call

Object

Field

v1.3 logic

Change for v19

API Call

Object

Field

v1.3 logic

Change for v19

GET ​/{crop}​/brapi​/v1​/trials​/{trialDbId}​/table

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

Response Field

germplasmDbId

GID

germplasmUUID

GET /{crop}​/brapi​/v1/germplasm/{germplasmDbId}/pedigree

Response Field(s)

parent1DbId

parent2DbId

GID

germplasmUUID

GET /{crop}/v1/samples/{sampleDbId}

Response Field

germplasmDbId

GID

germplasmUUID

obsUnitId replaced by observationUnitDbId

plantId replaced by plantDbId

sampleId replaced by sampleDbId

POST ​/{crop}​/brapi​/v1​/phenotypes-search

Request Body

externalReferenceID externalReferenceResource

 

 

added in the request body.

Note: This will not be supported yet as this call is in v1 version. The filtering of these details can be used in GET ​/{crop}​/brapi​/v2​/search​/observationunits​/{searchResultsDbid} which is the version 2 of this call.

Request Body

Response Body

germplasmDbId

GID

germplasmUUID

Response Body

entryType

returns as an array

returns as string

observationUnitXRef

 

 

removed field

observationTimeStamp

2021-06-14T14:34:38.000Z format

changed to 2020-09-30T10:54:20.000+08:00 format

GET​ /{crop}​/brapi​/v1​/trials

Response Body

trialDbId

 

updated from string to numeric

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

Response Body

observationTimeStamp

2021-06-14T14:34:38.000Z format

changed to 2020-09-30T10:54:20.000+08:00 format

germplasmDbId

GID

germplasmUUID

BRAPI v2

API Call

Action

API Call

Action

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

Modified in v18.1 to fix BrAPI validator errors. Updated active from string to boolean

Modified the call in v18.3 to add externalReferenceId and externalReferenceSource filters

Modified the call in v18.3 to accept germplasmUUID in request parameter instead of GID for germplasmDbId field

GET​ /{crop}​/brapi​/v2​/trials

Modified in v18.1 to fix BrAPI validator errors. Updated trialDbId from string to numeric

Modified the call in v18.3 to add externalReferenceId and externalReferenceSource filters

GET ​/{cropName}​/brapi​/v2​​/transactions

Modified in v18.1 to fix BrAPI validator errors. Changes are the following:

  • path updated to GET ​/{cropName}​/brapi​/v2​/seedlots​/transactions

  • locationId , unitId values changed from string to numeric

  • transactionTimestamp changed from yyyy-mm-dd to timestamp

GET ​/{crop}​/brapi​/v2​/serverinfo

GET ​/brapi​/v2​/serverinfo

Modified in v18.1 to fix BrAPI validator errors. Changes are the following:

  • updated search/observationunits/{searchResultsDbid/ to search/observationunits/{searchResultsDbId}

  • updated transactions to seedlots/transactions

GET /{crop}/brapi/v2/seedlots

Modified in v18.1 to fix BrAPI validator errors. Changed createdDate to timestamp instead of YYYY-MM-DD format

POST ​/{crop}​/brapi​/v2​/studies

Newly implemented 18.2

POST ​/{crop}​/brapi​/v2​/trials

Newly Implemented in v18.1

(Modified in v18.2 so it won’t automatically create an environment)

POST ​/{crop}​/brapi​/v2​/observationunits

Newly implemented 18.3

POST ​/{crop}​/brapi​/v2​/search​/observationunits

Modified the call in v18.3 to accept germplasmUUID in request body instead of GID for germplasmDbId field

GET ​/{crop}​/brapi​/v2​/search​/observationunits​/{searchResultsDbid}

 

Modified the call in v18.3

  • return germplasmUUID in response body instead of GID for germplasmDbId field

  • observationUnitPosition.entryType was changed to String type. Removed entryType field (remnant of v1.3)

GET ​/{crop}​/brapi​/v2/germplasm

Modified the call in v18.3 to accept germplasmUUID in request parameter instead of GID for parentDbId and progenyId fields

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

 

 

Modified in v18.3 to apply the following changes:

Additional fields:

  • externalReferenceID and externalReferenceResource

Changed fields:

  • observationUnitPosition.entryType changed from array to String

  • observationTimeStamp from this sample format 2021-06-14T14:34:38.000Z to this format 2020-09-30T10:54:20.000+08:00

GET ​/{crop}​/brapi​/v2​/search​/observationunits​/{searchResultsDbid}

Modified in v18.3 to apply the following changes:

Additional fields:

  • externalReferenceID and externalReferenceResource

  • observationUnitPosition.observationLevelRelationships json object with  levelCode, levelName, levelOrder for specifying experimental design variables like PLOT, BLOCK, REP (plot_no, block_no, rep_no)

  • seedLotDbId

Changed fields:

  • additionalInfo from string to  json object

  • observationUnitPosition.entryType changed from array to String

  • observationUnitPosition.blockNumber already included in observationUnitPosition.observationLevelRelationships json object

  • positionCoordinateX and Y displays null if no fieldmap available in a study

  • studyLocationDbId became locationDbId

  • studyLocation became locationName

Removed fields:

  • duplicate entryType (json path > data[0].entryType)

  • observationUnitXRef