Skip to main content

Understanding and How to use APIs Business Central - 2

Introduction:
In my last blog post (Business Central API -1 ) on Creating API in Business Central, we discussed all the commonly used properties of the page, query, and controls like field and data-item.
In today's blog, we will be diving deeply into the validation of the data passed through the API endpoint, how it enters into the source tables and is manipulated to be inserted/modified into single or multiple tables.
Also, I will be demonstrating how APIs are to be used.

Pre-requisites:

Books & References:
  • API V1 from Business Central On-Premise DVD
  • API(V1.0) for Business Central (Click Here)
  • API(Beta) for Business Central (Click Here)

Theory:
Understanding API in Business Central
1. BINDSUBSCRIPTIONS: Use to trigger IntegrationEvent for the Codeunit stated in parameters whenever the function calling BINDSUBSCRIPTION is invoked.

2. Actions through OData API: Actions in API is basically a function called through to API to call some actions passing the current record as parameter

3. Parsing JSON strings to actual records: Parsing  JSON string is used generally where EDM is used. For Eg: While passing payment method on Customer, we pass one or more JSON arrays thus this value is passed as a parameter on the field. To convert JSON array to actual field values on the table, we parse the JSON string.

4. General functions on Validate Trigger: Whenever a data is passed on the field on any page, you can use OnValidate trigger on the field to invoke a code to perform a set of procedures. This can ideally used in creation of No. in a Number Series. Whenever we pass a record, we don't know the next No. in Number Series. Thus NAV/ BC should automatically insert the record with appropriate No.

5. Using Codeunits for achieving the functionality:
There are few Codeunits present in C/AL  which can be used to Install/Uninstall extensions through API. In Business Central Extensions you are not allowed to use such functions but are accessible through C/AL Development Environment.

Demonstration:
How to use APIs in Business Central

1. Viewing List of APIs:

List of Companies:

2. Filtering Records in API:
Text Filtering 


DateTime Filtering

3. Selecting Records in API:






Conclusion:
I think everyone agrees that to write an APIs, you've to be creative while adding or modifying the data. Thus, to sum up, we've seen the key components in  implementation of APIs in Business Central.Also, I have demonstrated how to use APIs. In my next blog, I'll be giving an example which consists of scenarios for API creation and explain the details of all the code used in this blog.

Comments

  1. Hello, you mention that you've been parsing JSON strings to actual records. Where can I found an example for that?

    Thanks in advance

    ReplyDelete
  2. Hi Marcos,

    It is in my upcoming blog on APIs.
    If you want to know how to Parse JSON String, then refer https://www.olisterr.tech/2020/01/how-to-integrate-source-control-using.html
    where I get the response from request and save the hash value.

    ReplyDelete

Post a Comment

Let me know your comments below. I'll try my best to answer your comment

Popular posts from this blog

Something went wrong. An Error occurred - Error Resolution

Introduction: With the installation of NAV 2018 or BC On-premise, I have observed that when creating New Server Instance and New WebServer Instance, you will get the error 'Something went wrong. An Error occurred '. I referred to the community questions below but didn't find my resolution. Hence, I decided to write this blog. Pre-requisites: Microsoft Dynamics Business Central - On-Premise / NAV 2018 Understanding of Business Central Authentication  Books & References: https://community.dynamics.com/nav/f/microsoft-dynamics-nav-forum/261301/nav-2018-web-client-an-error-has-occurred https://community.dynamics.com/business/f/dynamics-365-business-central-forum/421987/error-something-went-wrong-an-error-has-occurred-azure-ad-tenant Demonstration: 1. Creation of NAVServerInstance: In order to create NAVServerInstance, you can either add the Server Instance through Business Central Administration or Powershell command. Add Instance - Business Central Administration Add Insta

Setting up OAuth Authentication for Business Central Web Services / APIs

Introduction: After upgrading Business Central to version 17 (Wave2 2020), I found that there was an error telling me that WebService Key is going to be deprecated soon. Web Service Access Key is deprecated. Hence, I decided to explore and probably make it easier through this blog. Pre- requisites : Admin Access to Office 365 Admin Access to Azure Demonstration: 1. App Registration on Azure Portal: To enable OAuth authentication for any apps in Azure Active Directory, you will need to perform App Registration and set up the permissions and security details. i.) Register the App: Search for 'App Registration' on the Azure Portal. Click on New Registration Type in the App Names, Account Types and Redirect URI. Registering Application ii.) Setup API Permissions: Go to API Permissions > Add Permissions > Business Central App > Select Delegated Permissions > Select Other Permissions and Financials > Add Permissions Button. Setup API Permissions iii.) Setup Client Secr

How to Upgrade Data from Microsoft Dynamics NAV to Microsoft Dynamics Business Central On Premise - Part 2

 Introduction: Now that the first step of the problem preprocessing of the NAV Database to make it ready to be migrated to BC is done(refer Part 1 ), we can now proceed further with connecting the database in Business Central On-Premise. Pre- requisites : Microsoft Dynamics 365 Business Central Microsoft Dynamics for NAV Microsoft SQL Server Management Studio (SSMS) Powershell ISE Understand NAV to BC Upgrade Considerations -  Click here Understand Upgrade Path -  Click here Books & References: https://docs.microsoft.com/en-us/dynamics365/business-central/dev-itpro/upgrade/upgrade-considerations#online https://docs.microsoft.com/en-us/dynamics365/business-central/dev-itpro/upgrade/upgrade-paths https://www.sauravdhyani.com/2018/10/msdyn365bc-data-upgrade-to-microsoft.html https://olisterr.blogspot.com/2022/03/how-to-upgrade-data-from-microsoft.html https://docs.microsoft.com/en-us/dynamics365/business-central/dev-itpro/upgrade/upgrade-permissions Demonstration: 1. Install Business