Okapi Okapi

/v2.0/{}/{}/api/v1.0/* → version retirement

Business Central API

Deprecated, no date

Business Central API has deprecated API v1.0 without a shutdown date. This deprecation affects all calls matching /v2.0/{}/{}/api/v1.0/*. Once the version is removed, these calls will fail.


Calls it hits

  • /v2.0/{}/{}/api/v1.0/*

What to use instead of these calls

Call API v2.0 instead using /api/v2.0/ in the same URL. Follow Microsoft's Transitioning from API v1.0 to API v2.0 guide to handle renamed fields and SystemId keys.

In Business Central API's words

We're making the API (v1.0) obsolete in 2024 release wave 1 (to be removed in 2026 release wave 1). The API (v1.0) will be removed in 2026 release wave 1.

Business Central API, Announcement

Facts

API
Business Central API api.businesscentral.dynamics.com
Kind
Version retirement
Announced
April 1, 2024
Takes effect
No date given yet
Calls after that day
Fail
Source
Announcement
Last updated
Verified
, against Business Central API's own pages

Questions

When does this change take effect?

Business Central API deprecated /v2.0/{}/{}/api/v1.0/* without giving a shutdown date yet.

Do these calls still work?

Yes, they still work: Business Central API has not given a shutdown date yet.

How do I find the calls this hits in my code?

Okapi reads your repository, finds the calls this change hits and opens a pull request with the fix. It never commits to your branches: every change comes as a pull request you review.


More from Business Central API 3

  1. No date /v2.0/{}/api/v1.0/*Version retirement Deprecated, no date
  2. No date /v2.0/{}/production/api/v1.0/*Version retirement Deprecated, no date
  3. No date /v2.0/{}/sandbox/api/v1.0/*Version retirement Deprecated, no date

Is your code calling this?

Okapi finds the calls this change hits in your repo and opens the pull request with the fix.

Add to GitHub