Publishing pages and codeunits as OData/SOAP web service endpoints

Path: Integration > Web services > Publishing pages and codeunits as OData/SOAP web service endpoints · tier official · system service · narrative reviewed (checked by Opus)

Overview

This section explains how to expose Business Central objects as web services. The core page, Publish a Web Service, covers creating and publishing API, OData, and SOAP endpoints from the Web Services page, including URL formats and configuration options for exposed objects.

The other pages cover specific topics. One shows how to create OData V4 bound actions with the ServiceEnabled attribute and WebServiceActionContext. One explains how to handle dialogs and exceptions in web service calls with GUIALLOWED. One covers troubleshooting errors. One describes the feature key that controls SOAP publishing of Microsoft UI pages, which was deprecated and removed in version 30.0.

Start with Publish a Web Service to get an endpoint running. Then read the UI interaction page when code may show dialogs, and the troubleshooting page when calls fail. If you rely on SOAP over Microsoft pages, read the feature key page for migration guidance.

Key points

• Publish a Web Service covers API, OData, and SOAP publishing through the Web Services page, with URL formats and options such as eTag calculations and the SystemId field.
• OData V4 bound actions expose procedures as web service actions using the ServiceEnabled attribute.
• WebServiceActionContext and WebServiceActionResultCode set the operation result and entity keys in a bound action.
• GUIALLOWED lets code suppress dialogs and user interaction when it runs through a web service.
• Errors can originate from the client, network, or server, so troubleshooting has to consider all three.
• Avoid Microsoft page APIs for web services and use the stable built-in APIs instead.
• The Disable SOAP web services on Microsoft UI pages feature key was deprecated and removed in version 30.0.
• The feature key page points to REST APIs or OData V4 as alternatives to SOAP on Microsoft pages and also covers per-tenant extension support.

Learn pages

• Creating and Interacting with an OData V4 Bound Action: Document how to create and interact with an OData V4 Bound Action in AL.
• Disable SOAP web services on Microsoft UI pages feature key: Learn about the Disable SOAP web services on Microsoft UI pages feature key.
• Handling UI interaction when working with web services: Describes how UI methods can make web service calls fail.
• Publish a Web Service: Explains how to publish page, query, and codeunits as web services.
• Troubleshooting errors in OData/SOAP web services on pages, queries, and codeunits.: Learn about how to troubleshoot Business Central web service errors on OData/SOAP endpoints on pages, queries, and codeunits.

Videos, posts and code changes

Linked by a Haiku matcher with a grounding quote from the item’s summary (link/topics.ts); machine-generated.

• #11342 [29.x][ALL-E] Document Type is Quote in Document Attachment table (1173) after posting a Sales Invoice with attachmentsIntial Commit (code change): “Document attachments transferred after posting a sales invoice”

Source: Microsoft Learn (CC BY 4.0). Descriptions are Learn’s own.