Calling the API
Version 25.3.9411
Version 25.3.9411
Calling the API
CData API Server exposes an API that allows integration with other applications. This API contains web services that are secure and remotely accessible from any application, browser, or smart device. The table resources in this API use JSON-formatted OData as the default REST protocol for accessing data. You can access the API as standard OData (XML/Atom or JSON), and it supports standard OData syntax for filtering and other operations such as querying related data from additional tables using OData expansions, or computing data using aggregations.
The following topics describe common tasks you can perform with API Server:
- Discovery covers ways in which you can access the APIs.
- Accessing Table Resources describes the HTTP methods used to perform CRUD operations on the tables exposed by API Server.
- Invoking Stored Procedures covers how to execute actions on the server.
- Filtering Table Resources explains how to filter and sort the data returned from your tables.
- Search covers API Server search functionality.
- Expand explains how to create requests that return data from a record and its related entities.
- Data Aggregation describes how to use the OData
$applykeyword to aggregate and transform data. - Server Responses is a list of common server responses and descriptions.
- Additional Formats covers the other web service formats API Server supports.