BC V22 W1 On-Prem - API v2.0 - Standard endpoints not found

(0) Share

Report

Posted on by Community member

Hi guys

First time integrating with Business Central. It's an on-prem installation for which the implementation is in progress, was V16 initially but then upgraded to V22 W1 during the development cycle. Development was done to create a general journal, integrate lines to it, and then post the journal. On V16 we were able to query things like customers, currencies, journals, i.e. standard available endpoints as per API (v2.0) for Dynamics 365 Business Central - Business Central | Microsoft Learn, however since upgrading to V22 these standard endpoints no longer seem to be available / accessible.

1. We can query companies or a specific company as below, and results are returned.

2. However when trying to go down any further like querying the customers for a specific company as below, we're getting a 404 not found.

From what I've been able to find it doesn't seem like specific endpoints, e.g. company(guid)/currencies, can be enabled / disabled for the API, can only turn the whole API off of on via configuration, and unless I'm missing something obvious the format of the URL is also correct.

Why would we be receiving 404's when calling endpoints like customers, currency, journals, etc. but companies are being returned as per the first screenshot?

All responses (4)

Answers (1)

Verified answer

Community member 11 on at

Like (0)

Report

BC V22 W1 On-Prem - API v2.0 - Standard endpoints not found

Thanks to @YUN ZHU for pointing me in the right direction.

Okey, so seems that the API v2.0 is an extension / app of some sort (please correct me if I'm wrong), which needs to be installed, the extension / app's name is "_Exclude_APIV2_".

Using the Business Central Administration Shell I:

1. Ran the Get-NAVAppInfo -ServerInstance <ServerInstance> command to get a list of all the extension / app's published to the instance to confirm that the extension exists on the environment, which it did.
2. Ran the Install-NAVApp -ServerInstance <ServerInstance> -Name "_Exclude_APIV2_" command to install the extension.
3. Calling the .../api/v2.0/$metadata endpoint now shows all the expected endpoints and doing calls like .../api/v2.0/companies(guidhere)/customers or journals returns the expected results instead of the 404 received previously.

Note that if the required extension is not listed in the results from step 1, seems that the Publish-NAVApp -ServerInstance <ServerInstanceName> -Path "<PathToExtensionFile>" command needs to be run first to publish the extension / app to the specific instance.
Community member 11 on at

Like (0)

Report

BC V22 W1 On-Prem - API v2.0 - Standard endpoints not found

Hi, I checked the "2000000153 - NAV App Installed App" table on the environment and the result is as below. As those API entries are not displayed on our new V22 environment, does that mean the API v2.0 is not installed on the new environment, or does their absence mean they are installed?

Apologies if these are stupid questions, I'm not familiar with Business Central.

Just some additional context, I did check the $metadata as well, see the result. From what I can see the standard endpoints, customers, currency, etc. are not listed, but they were definitely there in V16 before the upgrade as we were calling them.
Suggested answer

YUN ZHU 75,802 Super User 2024 Season 2 on at

Like (0)

Report

BC V22 W1 On-Prem - API v2.0 - Standard endpoints not found

Hi, you can use table 2000000153 “NAV App Installed App” to see if the following extensions have been installed in your environment. It seems that these two extensions were uninstalled during the upgrade process.

Hope this helps.

Thanks.

ZHU
Suggested answer

gdrenteria 13,011 Most Valuable Professional on at

Like (0)

Report

BC V22 W1 On-Prem - API v2.0 - Standard endpoints not found

Hi

Maybe this can help

Troubleshooting web service errors (OData, API, and SOAP) - Business Central | Microsoft Learn

Codeunit API’s in Business Central – Kauffmann @ Dynamics 365 Business Central

Troubleshooting OData/API calls - Business Central | Microsoft Learn

Best Regards

Gerardo