Skip to main content

BrAPI in GGCE

· 3 min read

GGCE from version 2023.6 provides BrAPI 2.1 and 2.0 endpoints. BrAPI 2.1 is the latest stable release of the standard. This first implementation already allows for downloading trait descriptors to Field Book app for capturing data in the field.

BrAPI is a standardized RESTful web service API specification for communicating plant (breeding) data to enable interoperability among plant (breeding) databases.

Doesn't GGCE have its own API?

GGCE provides a very extensive API that is very specific to genebanks and tightly linked to genebank operations. BrAPI defines standard endpoints that are implemented in addition to the existing APIs.

Babel Fish

BrAPI is the lingua franca that allows BrAPI clients to communicate with GGCE.

Capturing observations in the field

The primary use-case is to enable off-line capture data in the field or other remote locations using existing tools. The Field Book app is commonly used in genebanks and breeding programs and GGCE compatibility with Field Book is the main driver for our BrAPI implementation.

BrAPI in GGCE allows Field Book to download the trait descriptors, and use them to capture compatible and valid observations that are more easily loaded back to GGCE.

Bringing data back to GGCE

The current implementation does not yet allow Field Book to write observation data to GGCE. When data collection is complete, export the data from Field Book in a spreadsheet format and use the CT to upload it to GGCE.

Testing Field Book with GGCE

Get Field Book

Field Book version 5.4.11.16 and later can connect to GGCE1.
Download the updated Field Book through their Releases page.

Configure the connection to GGCE under Settings > BrAPI:

SettingValueNote
BrAPI VersionV2Select BrAPI 2.0
OIDC FlowOAuth2 Authorization CodeMake sure to select the Authorization Code option!
Base URLhttps://...ggceapi...The base URL of your GGCE API server (and not the UI)

After entering the Base URL value, hit the Authorize button. This will bring you to the login page of your GGCE. After the successful login, Field Book is ready to import data from GGCE using BrAPI.

Try it by navigating to the list of Traits, and select Import > BrAPI from the menu.

What is next?

We provided a selection BrAPI 1.3 endpoints since version 2021.2. These are now deprecated and will be removed in favor of BrAPI 2.1.

The next phase of development will enable Field Book to link observations directly to the specific inventories planted in the field, and save the data seamlessly to GGCE.

Stay tuned!