Using the Administration Web Service

The Administration Web Service contains administrative operations for creating a snapshot, listing running jobs and canceling jobs that have been scheduled but have not started in a specific data store.

For example, createSnapshotOperation($name, $path) creates a snapshot of the Oracle Endeca Server's data store state as a tree of hard links under $name in directory $path.

Operation description

The Administration Web Service takes as its input parameters to the functions it contains and performs the requested operations.

Request

The input to the Administration Web Service depends on the function. For example:
  • To create the data store snapshot, specify a name and a directory path to the snapshot file.
  • To list or cancel jobs, use the operations for listing or canceling jobs.

Response

The Administration Web Service returns:
  • An <operation successful> response element if there are no problems.
  • A <fault> element if an exception was thrown internally.

Operations

The Administration Web Service contains the following operations:
Operation Description
createSnapshotOperation Create a snapshot representing a consistent view of the state of the data store at a specific point in time. As an argument, specify the name for a snapshot, such as NewSnapshot, and an absolute path to the snapshot directory in the URI format, such as file:///mydirectory/home/snapshots/.
getVersionOperation List the version of the Oracle Endeca Server and the versions of the Dgraph processes powering each of the data stores (if the Dgraph processes for these data stores are currently running). The data store should not be specified.

In addition to using this operation directly in a request, you can also obtain the version by issuing a version command on the Oracle Endeca Server. For details on this command, see version command.

listJobsOperation List the jobs that are currently running in a specific data store, such as queries, updating operations or administrative services.

In addition to using this operation directly in a request, you can also obtain the results of this operation by issuing a list-jobs <datastore-name> command on the Oracle Endeca Server. For details on this command, see list-jobs command.

cancelJobOperation Cancel a job that has been scheduled to run but has not been started, by specifying a job ID obtained from the listJobsOperation request.

Example

The following examples show the Administration Web Service request and response bodies for creating a snapshot.

To access the Administration Web Service, send a SOAP request to the following URL:
http://localhost:<port>/ws/admin/datastore?wsdl
specifying the host and port of the Oracle Endeca Server and the data store that has been created and is running on it.
This example shows the Post body of the Administration Web Service request that creates a snapshot:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
					xmlns:admin="http://www.endeca.com/MDEX/admin/1/0">
<soapenv:Header/>
<soapenv:Body>
	<admin:request>
		<admin:createSnapshotOperation path=
"file:///mydirectory/home/snapshots/" name="NewSnapshot" />
	</admin:request>
</soapenv:Body>
</soapenv:Envelope>
This example shows the response body of the Administration Web Service request:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
	<soapenv:Header/>
	<soapenv:Body>
		<admin:response xmlns:admin="http://www.endeca.com/MDEX/admin/1/0">
			<admin:createSnapshotSuccess/>
		</admin:response>
	</soapenv:Body>
</soapenv:Envelope>
Note: For more information about the operations used in the Administration Web Service, see the Administration API section of the Oracle Endeca Server API Reference.