Version 23.0.9145

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 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:

• Authentication explains how to authtokens to access API entities.
• Discovery covers ways in which you can access the APIs.
• Accessing Resources describes the HTTP methods used to perform CRUD operations on the resources exposed by API Server.
• Invoking Actions covers how to execute actions on the server.
• Filtering Resources explains how to filter and sort the data returned from your resources.
• 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 $apply keyword to aggregate and transform data.
• Server Responses is a list of common server responses and descriptions.
• Direct Query explains how users can send their own SQL queries to data sources.
• Additional Formats covers the other web service formats API Server supports.