About the Control Web Service

The Control Web Service provides an interface that lets you create and manage Endeca data store instances.

Overview

The Control Web Service is declared in control.wsdl. You can access the Control Web Service at the following URL:
http://localhost:<port>/ws/control?wsdl
where the localhost and port are the host and port of the running Oracle Endeca Server.
The namespace for the Control Web Service is similar to the following example and reflects the version of the service:
http://www.endeca.com/endeca-server/control/1/0
This namespace is included in the WSDL document for the Web service.

Operation and request overview

A request to the Control Web Service depends on the operation. The request types and their operations are:
Request Type Operation Response Type
attachDataStoreRequest attachDataStore attachDataStoreResponse
createDataStoreRequest createDataStore createDataStoreResponse
dataStoreStatusRequest dataStoreStatus dataStoreStatusResponse
detachDataStoreRequest detachDataStore detachDataStoreResponse
listDataStoresRequest listDataStores listDataStoresResponse
startDataStoreRequest startDataStore startDataStoreResponse
stopDataStoreRequest stopDataStore stopDataStoreResponse
usageRequest usage usageResponse
versionRequest version versionResponse

The operations are described in greater detail in Operations in the Control Web Service.

The Control Web Service does not support outer transactions, and therefore does not support the OuterTransactionId element that specifies the ID of an outer transaction in a request.

Response

The response types are listed in the table above. Data is returned by the dataStoreStatusResponse, listDataStoresResponse, usageResponse, and versionResponse responses.

If any operation does not succeed, the Web service transaction returns a SOAP fault with an appropriate error message and the operation is not applied. The SOAP fault will look like this example:
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:Body>
      <soap:Fault>
         <faultcode>soap:Server</faultcode>
         <faultstring>Cannot perform this operation while the data store is STOPPED</faultstring>
         <detail>
            <controlFault xmlns="http://www.endeca.com/endeca-server/control/1/0"/>
         </detail>
      </soap:Fault>
   </soap:Body>
</soap:Envelope>

In this example, the faultstring informs the user that the operation (which is a stopDataStore in this case) cannot be performed because the Endeca data store is already stopped.