Skip to content

B2SHARE Version 3 upgrade#

We’re pleased to announce that EUDAT B2SHARE will be upgraded to version 3 on October 28, 2025. This upcoming release offers significant improvements: introducing a modernised platform that better supports integrations and tailoring through modularity for B2SHARE service providers, enhanced functionality and user experience for researchers publishing and searching for data to reuse in their projects, and improved workflows for all users and communities for managing their data. The EUDAT B2SHARE Training instance will be upgraded on October 7, 2025.

Built on InvenioRDM#

B2SHARE v3 is built on InvenioRDM, a robust and scalable research data management framework. This upgrade brings a new backend architecture while preserving the familiar look and feel of the current platform.

  • All existing user data, including records, communities, roles, and schemas, will be migrated seamlessly from B2SHARE v2 to v3.
  • Persistent identifiers (DOI, Handle, URL) will remain unchanged and continue to resolve to the correct records.
  • New records created in B2SHARE v3 will use a new type of URL identifier.

New user interface and API#

B2SHARE v3 introduces a refreshed user interface and a new API, offering a more intuitive and efficient experience. While the general design remains familiar, users will benefit from smoother workflows and improved usability.

Updated user and API documentation will be published shortly after the release. If you have an integration with B2SHARE, keep in mind, that you have to do some updates. The API changes are major.

First-time login and registration#

After the upgrade, all users, new and existing, will be prompted to complete a mandatory registration form during their first login. This step ensures that user profiles are correctly configured for the new system. All users will also be asked to approve the service terms of use, which will also be updated. This will clarify the roles and responsibilities of researchers, communities and service provider.

New features#

Enhanced community features#

  • Communities can define publication workflows, assign roles, and manage community settings via the user interface.
  • Support for restricted records: records can be made visible only to community members.
  • Users can grant access to records to other users.

Vocabulary integration#

  • Organisations and awards can be searched using the organisation name. This will increase visibility of researcher merits and funding information for research administation.
  • For example, B2SHARE synchronises with ROR to fetch organisation data.

Changing features#

Search functionality#

  • The search interface will support preset facets for more precise filtering.

Record creation workflow#

  • Metadata entry is now consolidated into a single form, including community selection.
  • This replaces the previous two-step process used in B2SHARE v2.

OAI-PMH endpoint update#

  • B2SHARE OAI-PMH URL will change from /api/oai2d to /oai2d.

Deprecated features#

  • JSON-patch updates will no longer be supported for modifying and publishing records.

NOTE: ALL EXISTING API TOKENS WILL STOP WORKING!

The B2SHARE v3 API documentation is in progress. For now, you can check InvenioRDM api documentation for broad details https://inveniordm.docs.cern.ch/reference/rest_api_index/

Some API endpoints that are customised for B2SHARE:

GET /api/community-schema-extension/

returns a list of available community extensions

[
  {
    "community_id": "<community id>",
    "community_schema_version": <schema version number>,
    "community_slug": "<community slug>",
    "schema_id": "<schema id>",
    "section": "<ui section>"
  }
]

GET /api/community-schema-extension/<community>

returns a uuid for the latest schema of the community

{
    "uuid": "<schema uuid>
}

GET /api/community-schema-extension/schema/<uuid>

returns a schema extension
{
    "backend": [<backend schema definition>],
    "facets": {<search facets, not yet supported>},
    "search_map": {<custom search mappings, not yet supported>},
    "ui": [<ui element definitions>]
}

POST /api/records/<pid_value>/report-abuse

endpoint to submit an abuse report for a given record. pid_value is the record id. Sends a notification to b2share admins.

request body:
{
    "abuseType": "<required>",
    "message": "<required>",
    "name": "<required>",
    "affiliation": "<required>",
    "email": "<required>",
    "address": "<required>",
    "city": "<required>",
    "zip": "<required>",
    "phone": "<required>",
}

returns 201 {"status": "report submitted"}

Record related endpoint changes:

community schema metadata is stored in metadata.community_extension field in the record.
community schema extension id is stored in metadata.community_extension_schema field in the record.

B2SHARE does not use custom_fields in the record metadata.

  Last update : 30.9.2025

Last review : 30.9.2025