Navigation in Business Central APIs

-

Introduction


Business Central provides us a standard set of API pages which we can use for performing CRUD Operations on records.

In addition to this it also provides us with “Containments” feature, which lets us fetch records related to a certain record.

Pre-requisites

  • Business Central onCloud or On-Premise.
  • Postman (For Testing)

References

Using Containments and Associations - Business Central | Microsoft Docs

Usage

Go to Web Services.

Click on Actions and download the Metadata for that Web Services.



In case of the “Sales Order API”, the actual sub-page is named salesOrderLines, so the endpoint for Navigation would be {ParentServiceName}{SubPageName} which in this case would be salesOrderssalesOrderLines.



We can see the same in the Metadata document as well.



Use the following format for calling the Containment endpoint - salesOrders(Document ID)/salesOrderssalesOrderLines.



This returns an array, which contains the list of that particular Sales Order’s Lines.

You can create these associations in your own APIs as well by adding a subpage to your API page or Web Service.

Conclusion

Thus we saw how we can use Navigation in Business Central APIs to directly access sub-page data in APIs.

Happy Coding!

Comments

Post a Comment

Popular posts from this blog

Using Notifications in Business Central via AL

-
Image
Introduction Notifications in Business Central are alerts that appears in the Notification bar based on User actions. Notifications stack up from top to bottom, lasting until the user dismisses them, including those from sub-pages.  Validation errors are prioritized and shown before other notifications. We can use this to alert the user regarding something without taking all the user's notification towards it, in the way messages or errors do. They also have the option to allow Users to make a corrective action by embedding the action button directly into the notification. Let's see how it works. Source Code Pre-requisites Business Central OnPrem/Cloud. References Notification - Business Central Docs Configuration Here, for an example, I've created one simple page which takes two inputs. 1. The message that is to be shown in the notification. 2. The message to be shown after the User clicks on the action embedded in the notification.     And I have two actions which I'l...
Read more

Actionable Error Messages in Business Central

-
Image
Introduction Error handling is an important concept in every technical field.  It helps programs deal with unexpected problems and mistakes smoothly.  It makes sure software works reliably and doesn't crash unexpectedly.  Error handling also helps developers find and fix issues quickly, making the software better for users. Plus, it gives users clear messages when something goes wrong, making their experience smoother. It shows that the team has considered the scenario and has measures in place for it indicating a well designed solution. Microsoft has an amazing document which lists the things to keep in mind for writing resilient code. In Business Central, we have try functions to handle errors and error function to show those errors to the Users.  In this blog, we'll learn how we can enhance the error messages so that the Users can resolve the errors themselves or at the very least we can point them towards where the error is. Pre-requisites Business Central OnPrem...
Read more

Configure Gmail SMTP service in Business Central without "Allow Less Secure" setting

-
Image
 Introduction Business Central has great email features like sending email, editing it with Rich Text, adding attachments, etc, but to send emails, you'll need to connect it with services like Outlook or Gmail. There is no outlook side configuration that is to be done if you are using Microsoft Outlook however if you are using Google's Gmail then there's a litte change that has happened on the configuration end. Starting May, 2022, Google has removed the "Allow Less Secure Apps" settings from the Google Accounts, which was essential is using Gmail to send emails from Business Central. However, to replace that we have "App Passwords" which we can use instead. Also, just something to keep in mind, Google is going to remove this from the "Google Workspace" accounts as well by Sept, 2024 so it would be wise for you to migrate your configurations to use app passwords. Reference 1.  How to Setup Email in Business Central 2.  Google Support - Less sec...
Read more