Removal of legacy Tracker API endpoints in v42

Implementation - Implémentation App Transition and Version Upgrades
, ,
1

Dear DHIS2 community,

As part of the continuous improvement of DHIS2, version 42 officially removes the legacy Tracker API that has existed in parallel with the new Tracker API endpoints since 2.36. If you’re upgrading to v42 or planning ahead, this is an important change that might impact your scripts, custom apps and integrations.

This change can affect your configuration as all use of individual (Tracker and Event) data must from v42 onwards use the new Tracker API. The legacy Tracker API is no longer available and integrations, scripts, or third-party tools relying on the legacy API endpoints will no longer function after an upgrade to v42.

:white_check_mark: What should you do?

Before upgrading to v42, make sure to:

  1. Review your scripts, tools and integrations: Check if any of them are still using the following legacy API endpoints:
  api/trackedEntityInstance
  api/enrollments
  api/events
  api/relationships

           Note that since the new Tracker API has existed in parallel with the legacy
           Tracker API since 2.36, you can also adapt and test your scripts and tools on
           older versions without needing to upgrade. Core apps like web Capture and
           Android Capture have been using the new Tracker API since 2.39.

  1. Update your code: If you find any legacy API usage, migrate to the new Tracker API with help from this migration guide: Migrating to new tracker endpoints
  2. Check with app developers: If you’re using custom or third-party apps, confirm they’ve been updated to use the new APIs.

:hammer_and_wrench: Why the change?

This cleanup helps ensure better performance, consistency, and maintainability across DHIS2. The new Tracker API is more robust, more performant, offers better validation, consistency in property names, better error handling, and is documented using the OpenAPI specification.

:books:Useful resources

:megaphone: We want to hear from you!

We know the legacy Tracker API has been used for a variety of tools, scripts and apps across DHIS2 implementations. Please reply in this thread or add a ticket in Jira if you:

  • Have API payloads that are now broken or behave differently
  • Encounter issues when testing your scripts and tools in version v42
  • Are unsure how to migrate a specific payload

Your feedback helps improve documentation, guides, and support for other implementers going through the same transition.

Thank you for being part of the DHIS2 community and helping make the platform stronger for everyone.

— The DHIS2 Core Team

5 Likes