13 July 2019

Understanding Microsoft Business Central Custom API Endpoints

This is the third blog post about the Microsoft Business Central APIs and I suggest you go through below blog posts first if you haven't read them yet.

Part 01: Getting Started with Dynamics 365 Business Central APIs
Part 02: Understanding Microsoft Business Central Out-Of-The-Box API Endpoints

If you want to access custom developed API then this blog post will give you the details of how the API endpoint will be. 

** from this point onwards "https://api.businesscentral.dynamics.com" will be referred to as "{BaseURL}

Tenant version is below 14.1:

{BaseURL}/v1.0/<your tenant domain>/<environment name>/api/<api publisher>/<api group>/<api version>

Tenant version is 14.1 or above:

{BaseURL}/v2.0/<your tenant domain>/<environment name>/api/<api publisher>/<api group>/<api version>

You might be wondering from where the "api publisher", "api group" and "api version" are coming from. These values are defined during the development of the custom API.

Below is a custom developed API page and these values are defined as properties of the page.

Below are the endpoints to access above mentioned custom API.
Tenant version is below 14.1:

{BaseURL}/v1.0/<your tenant domain>/<environment name>/api/tc/iot/beta/companies/<companyID>/outdoortempentries

Tenant version is 14.1 or above:


{BaseURL}/v2.0/<your tenant domain>/<environment name>/api/tc/iot/beta/companies(<companyID>)/outdoortempentries

Please provide your feedback with a comment. 
Thank you and Regards,
Tharanga Chandrasekara

No comments:

Post a Comment