Viewing REST Data in RAD Studio Data Explorer



How to view REST data in RAD Studio Data Explorer using the CData ODBC Driver for REST.

Embarcadero RAD Studio provides a development environment for Delphi and C++Builder applications. With the CData ODBC Driver for REST, you gain access to live REST data within RAD Studio, abstracting the data into tables, views, and stored procedures that can be used to both retrieve and update REST data. This article will walk through connecting to REST using the Data Explorer.

Configure a Connection to REST

If you have not already, first specify connection properties in an ODBC DSN (data source name). This is the last step of the driver installation. You can use the Microsoft ODBC Data Source Administrator to create and configure ODBC DSNs.

See the Getting Started chapter in the data provider documentation to authenticate to your data source: The data provider models REST APIs as bidirectional database tables and XML/JSON files as read-only views (local files, files stored on popular cloud services, and FTP servers). The major authentication schemes are supported, including HTTP Basic, Digest, NTLM, OAuth, and FTP. See the Getting Started chapter in the data provider documentation for authentication guides.

After setting the URI and providing any authentication values, set Format to "XML" or "JSON" and set DataModel to more closely match the data representation to the structure of your data.

The DataModel property is the controlling property over how your data is represented into tables and toggles the following basic configurations.

  • Document (default): Model a top-level, document view of your REST data. The data provider returns nested elements as aggregates of data.
  • FlattenedDocuments: Implicitly join nested documents and their parents into a single table.
  • Relational: Return individual, related tables from hierarchical data. The tables contain a primary key and a foreign key that links to the parent document.

See the Modeling REST Data chapter for more information on configuring the relational representation. You will also find the sample data used in the following examples. The data includes entries for people, the cars they own, and various maintenance services performed on those cars.

Connecting to REST Data Using Data Explorer

You can create a simple application for displaying REST data by utilizing the CData FireDAC Components for REST and a new VCL Forms Application:

  1. Open the Data Explorer in RAD Studio and expand FireDAC.
  2. Right-click the ODBC Data Source node in the Data Explorer.
  3. Click Add New Connection.
  4. Enter a name for the connection.
  5. In the FireDAC Connection Editor that appears, set the DataSource property to the name of the ODBC DSN for REST.
  6. Back in the Data Explorer, expand the tables for the connection.
  7. Create a new VCL Forms application and drag a table (for example: people) onto the form.

  8. Select the peopleTable object on the form and set the Active property to true.
  9. Right-click on the object, bind visually, and link everything (*) to a new control (TStringGrid).

  10. Arrange the TStringGrid on the form and run the application to see the people data.

Related Articles

Below you can find other articles for using the CData ODBC Driver with RAD Studio, Delphi, and C++ Builder.

Ready to get started?

Download a free trial of the REST ODBC Driver to get started:

 Download Now

Learn more:

REST Icon REST ODBC Driver

The REST ODBC Driver is a powerful tool that allows you to connect with live REST web services, directly from any applications that support ODBC connectivity.

Access REST services like you would any standard database - read, write, and update etc. through a standard ODBC Driver interface.