OData Web Services
The Open Data Protocol (OData) is a web protocol that is designed for querying tabular data and provides you with an alternative to SOAP-based web services. OData builds on web technologies such as HTTP and JavaScript Object Notation (JSON) to provide access to information from different applications, services, and stores. OData uses URIs for resource identification and commits to an HTTP-based, uniform interface for interacting with resources. This commitment to core Web principles allows for OData to enable a new level of data integration and interoperability across a broad range of clients, servers, services, and tools.
You can use OData web services to show Business Central data, and you can update data in a Business Central database using OData web services.
Using OData in other Microsoft products and technologies
OData is used in other Microsoft products and technologies, including the following:
- Microsoft Excel implements OData for its PowerQuery feature.
- Microsoft PowerBI can read data from OData services.
- Microsoft SharePoint can expose its list-oriented data with OData.
PowerQuery is a data analysis engine built into Microsoft Excel and Power BI that provides enhanced Business Intelligence capabilities. PowerQuery supports sharing and collaboration on user-generated business intelligence solutions in a Microsoft SharePoint Server environment. For more information about PowerQuery, see https://powerquery.microsoft.com.
Key concepts and techniques for accessing Business Central data using OData
The topics in this section describe the key concepts and techniques for accessing Business Central data from OData applications that are supported by Business Central .
| To | See |
|---|---|
| Develop fast OData clients | OData Query performance |
| Troubleshoot failed OData calls | Troubleshooting API calls |
| Expose a codeunit through OData to implement a Remote Procedure Call (RPC) | Creating and Interacting with an OData V4 Unbound Action |
| Use filter expressions in OData URIs. | Using Filter Expressions in OData URIs |
| Use FlowFilters in OData URIs. | Using FlowFilters in OData URIs |
| Use server-driven paging in OData URIs. | Server-Driven Paging in OData Web Services |
| Navigate in an OData web service application by using resource properties. | Using Containments and Associations |
| Write to the database through an OData web service that exposes a writable page. | Using OData Web Services to Modify Data |
| Use OData to obtain a service metadata (EDMX) document. | Using OData to Return or Obtain a Service Metadata (EDMX) Document |
| Use OData to obtain a JavaScript Object Notation (JSON) document. | Using OData to Return-Obtain a JSON Document |
| Learn about limitations with Business Central OData | Known OData Limitations |
| Use OData v3 to obtain an AtomPub document. | Using OData to Return or Obtain an AtomPub Document |
Enabling and Configuring OData on the Business Central Server (on-premises only)
The Business Central Server instance has several configurations settings that enable and control OData services. For more information, see OData Services Settings.
Known Limitations with Business Central OData
The Open Data Protocol (OData) implementation in Business Central does not implement all features in the OData specification. For more information, see Known OData Limitations.