The Control Web Service provides an interface that lets you create and manage Endeca data store instances.
http://localhost:<port>/ws/control?wsdlwhere the localhost and port are the host and port of the running Oracle Endeca Server.
http://www.endeca.com/endeca-server/control/1/0This namespace is included in the WSDL document for the Web service.
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.
The response types are listed in the table above. Data is returned by the dataStoreStatusResponse, listDataStoresResponse, usageResponse, and versionResponse responses.
<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.