Oracle Endeca Server Web services

The Oracle Endeca Server is installed with a set of versioned Web services for loading, configuring, and querying the data. These Web services provide the interface to the Oracle Endeca Server.

List of Web services available for the data store on the Oracle Endeca Server

Once you install the Oracle Endeca Server and create a data store in it, you can use the following Web services to send requests:
  • Data Ingest Web Service, ingest (Documented in the Oracle Endeca Server Data Loading Guide)
  • Configuration Web Service, config (Documented in this guide)
  • Conversation Web Service, conversation (Documented in this guide)
  • Transaction Web Service, transaction (Documented in this guide)
  • Administration Web Service, admin (Documented in the Oracle Endeca Server Administrator's Guide)
In addition to these listed Web services, additional Web services are available with the Oracle Endeca Server:
  • The LQL Parser Web Service, lql_parser — a web service for parsing Endeca Query Language queries and filters. For more information on this web service, see the Oracle Endeca Server API Reference and the Oracle Endeca Server Query Language Reference.
  • The Entity Configuration Web Service, sconfig, used by Integrator and Studio to create and manage views. For more information on this web service, in the Oracle Endeca Information Discovery Studio User's Guide, see the section on creating views.
  • The Control Web Service, control, used internally by the Oracle Endeca Server commands.
Note: Each web service is assigned its own version, consisting of major and minor version. The supported versions are listed in its WSDL document. If you are planning to use web service calls directly or use client-side code created with stubs generated from a web service, ensure that you use a supported version of the web service. For detailed information on web service versions, see the section in this guide.

In addition to these listed web services, the Bulk Load Interface is also included. It does not use web services technology. Together with the Data Ingest Web Service, the Bulk Load Interface loads the records into the Oracle Endeca Server. For more information on the Bulk Load Interface, see the Oracle Endeca Server API Reference (if you are planning to use this interface directly), or the Oracle Endeca Information Discovery Integrator Components Guide (if you are planning to use components in Integrator that utilize calls to the Bulk Load Interface).

Flow for using the Web services

As you build your application, you use these Oracle Endeca Server Web services through various tools. The usage pattern is as follows:
  1. Use the Data Ingest Web Service and the Configuration Web Service to load data and configuration into the data store created on the Oracle Endeca Server.
  2. Use the Configuration Web Service to configure the record schema and Oracle Endeca Server features.
  3. Use the Conversation Web Service and the Configuration Web Service to send requests and obtain results from the Oracle Endeca Server for your data store. These results can subsequently be rendered in the front-end application used by the end users.
  4. Use the Administration Web Service to set up monitoring and backups.

How each Web service interacts with the Oracle Endeca Server

Each Web service can be described in the context of how it interacts with the Oracle Endeca Server:

Web service Function
Data Ingest Service The Data Ingest Web Service is used to load data into the Oracle Endeca Server. It serves as the basis for various batch processes, and is designed for easy integration with ETL tools.
Configuration Web Service The Configuration Web Service supports the process of refining the records schema and adjusting your configuration in the development environment.
Conversation Web Service The Conversation Web Service is used to query the Oracle Endeca Server and to provide summarizations.

Unlike the Data Ingest and Configuration Web Services, it is not used to update the Oracle Endeca Server data files.

Administration Web Service The Administration Web Service is used by IT engineers and administrators to integrate the Oracle Endeca Server and its reporting with third-party IT tools.
Transaction Web Service The Transaction Web Service controls outer transactions in the Oracle Endeca Server.