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

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

Thanks in advance
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.

Popular posts from this blog

Creating APIs in Business Central - 1

Introduction:
While writing a blog on Automated Testing in Business Central, I was going through sample apps provided by Microsoft and realized that the complexity is nowhere close to what examples Microsoft has provided on docs.microsoft.com. In this blog, I will try to explain how APIs work and how to be creative with the implementation. Also, an API which were in beta are finally out with version V1.0 in the April 2019 release let's see some important key things from development aspects.
This blog is going to be theoretical one kindly bear with me.


Pre-requisites:
Microsoft Dynamics Business Central (SaaS)VS Code(https://code.visualstudio.com/download)AL Language Extension(https://tinyurl.com/yyvzxwkb)API V1 from Business Central On-Premise DVD
Books & References:
API V1 from Business Central On-Premise DVDAPI(V1.0) for Business Central (Click Here)API(Beta) for Business Central (Click Here)
Solution:

Key Requirements:
API source table must have an Id(GUID) field per record for m…

How Business Central Modern Client Reverse Compatibility With NAV Can Help You Improve Your Work.

Introduction: Today, I was playing around with Business Central Modern Client (Windows App).
Out of curiosity I was trying to login to one of my NAV 2017 through SSO.
Pre-requisites: Microsoft Dynamics NAV with SSO configured
Microsoft Dynamics Business Central
Demonstration: 1. Business Central App - Main Page:

Clicking on locally hosted service and putting in the credentials configured for NAV 2017 SSO, we get.
Still skeptical when Business Central login into NAV.

2. Business Central App - Reverse compatible with NAV 2017:


Well well well...
Look whose here.
NAV disguised as  Dynamics 365 for Financials.

I think we all agree that Business Central Modern Client is a WebApp version of Busines Central Online. Basically just like browser in an App.
The difference is that it can connect to NAV as it is just like a browser.

3. Does Business Central Modern Client follow DynamicsNAV protocol?:
Well, it simply does not.
It would be amazing  if it did, as it would mean that we could deal with runni…

Generic way of Attaching Documents on any Record of the Page in Microsoft Dynamics Business Central - Template Code

Problem Statement: In Microsoft Business Central, there is a way to attach attachments only on Documents or Master Table records. But, what if this requirement is for other tables such as Opportunities, custom tables, etc. Introduction: I have seen many developers afraid to touch the attachment-related customization as it seems complicated.
Well, I have found a solution and here it goes.
In this blog, I'm attempting to create a generic template for code that needs to have an attachment feature on any table that you like using AL Code.
This means that you simply cannot copy-paste the same code for all the tables but a simple change in variable sub-type will ease your work significantly
Pre-requisites:Microsoft Dynamics Business CentralVS CodeAl Language ExtensionSource Code:https://github.com/olisterr/Generic-Attachment-Template Demonstration:1. How it works:
Document Attachment is a table which stores a few things that help in tracking information related to the attachment

The main u…