v24 API changes documentation

Owned by Mariano Crimi
Last updated: 24 Oct, 2023 by Corina Habito

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 /{crop}/sample-lists/{listId}/download

23.1

Includes PLOT_NO when exporting samples list

POST /{crop}/programs/{programUUID}/studies/{studyId}/datasets/{datasetId}/observationUnits/{observationUnitId}/observations

23.1

Adds created_by value in the phenotype_aud table

PATCH /{crop}/programs/{programUUID}/studies/{studyId}/datasets/{datasetId}/observationUnits/{observationUnitId}/observations/{observationId}

23.1

Adds updated_by value in the phenotype_aud table

PUT /{crop}/programs/{programUUID}/studies/{studyId}/datasets/{datasetId}/observationUnits/observations

23.1

Adds updated_by value in the phenotype_aud table

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

23.1

Adds created_by value in the phenotype_aud table

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

23.1

Adds created_by value in the phenotype_aud table

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

23.1

Adds created_by value in the phenotype_aud table

POST {crop}/programs/{programUUID}/studies/{studyId}/datasets/{datasetId}/observation-units/filter/set-value

23.1

Adds created_by value in the phenotype_aud table

POST /{crop}/programs/{programUUID}/studies/{studyId}/datasets/{datasetId}/observation-units/filter/delete-value

23.1

Adds created_by value in the phenotype_aud table

POST /{crop}/programs/{programUUID}/studies/{studyId}/datasets/{datasetId}/derived-variables/calculation

23.1

Adds created_by value in the phenotype_aud table

POST /{cropname}/programs/{programUUID}/studies/{studyId}/instances/{instanceId}/observations

23.1

Adds created_by value in the phenotype_aud table

PATCH /{cropname}/programs/{programUUID}/studies/{studyId}/instances/{instanceId}/observations/{observationDataId}

23.1

Adds updated_by value in the phenotype_aud table

GET /{crop}/programs/{programUUID}/studies/{studyId}/variables/types

23.1

variableTypeIds path variable is now a request query variable

GET /crops/{crop}/germplasm-lists/tree-state

23.1

Remove userId request query variable

PATCH /crops/{cropName}/name-types/{nameTypeId}

23.2

Allow update regardless if name is used or not

BRAPI v1 Changes

API Call

Action

API Call

Action

 

 

BRAPI v2

API Call

Action

API Call

Action

POST /{crop}/brapi/v2/observationunits

Modified in v23.3 so the system should automatically create the means dataset if it is not yet existing

POST /{crop}/brapi/v2/search/observations

Newly implemented in v23.3

GET /{crop}/brapi/v2/search/observations/{searchResultsDbID}

Newly implemented in v23.3

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

Newly implemented in v23.3

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

Newly implemented in v23.3

POST /{crop}/brapi/v2/search/locations

Newly implemented in v23.3

GET /{crop}/brapi/v2/search/locations/{searchResultsDbID}

Newly implemented in v23.3

POST /{crop}/brapi/v2/observations

Now supports storing of additional info field in json format

PUT /{crop}/brapi/v2/observations

Now supports updating of additional info field in json format

GET /{crop}/brapi/v2/observations

Now supports retrieval of additional info field in json format

Notes