Skip Headers
Oracle® Secure Enterprise Search Administration API Guide
11g Release 2 (11.2.1)

Part Number E17595-04
Go to Documentation Home
Go to Book List
Book List
Go to Table of Contents
Go to Feedback page
Contact Us

Go to previous page
Go to next page
PDF · Mobi · ePub


The Oracle Secure Enterprise Search Administration API Guide documents two interfaces to the Administration API: a command-line interface and a Web services interface. It also introduces the Web services Java client. The Administration API supports the same features as the Oracle SES Administration GUI, and some new features that are currently not supported by the GUI.

This preface contains these topics:


This document is intended for anyone using the Oracle SES Administration API:

Documentation Accessibility

For information about Oracle's commitment to accessibility, visit the Oracle Accessibility Program website at

Access to Oracle Support

Oracle customers have access to electronic support through My Oracle Support. For information, visit or visit if you are hearing impaired.

Related Documents

For more information about Oracle Secure Enterprise Search, refer to the following resources:

Up-to-date Release Notes are posted on Oracle Technology Network (OTN). You must register online before using OTN. Registration is free and can be done at this location:

If you have a user name and password for OTN, then you can go directly to the documentation section of OTN at this location:


The following text conventions are used in this document:

Convention Meaning
boldface Boldface type indicates graphical user interface elements associated with an action, or terms defined in text or the glossary.
italic Italic type indicates book titles, emphasis, or placeholder variables for which you supply particular values.
monospace Monospace type indicates commands within a paragraph, URLs, code in examples, text that appears on the screen, or text that you enter.

This reference presents syntax in a simple variant of Backus-Naur Form (BNF) that includes the following symbols and conventions.

Symbol or Convention Meaning
[ ] Brackets enclose optional items.
{ } Braces enclose a choice of items of which only one is required.
| A vertical bar separates alternatives.
... Ellipses indicate that the preceding syntactic element can be repeated.
/ A slash separates levels of a directory path. On Windows, use a backslash (\) instead of a slash (/).
delimiters Delimiters other than brackets, braces, vertical bars, and ellipses must be entered as shown.
italics Words appearing in italics are placeholders for which you must substitute a name or a value. Words that are not in italics are keywords and must be entered as shown.
MW_HOME MW_HOME is the top-level directory for Oracle Fusion Middleware products. This directory is called Middleware home. The Middleware home for Fusion Applications is named fusionapps. Each application is installed in its own Oracle home under MW_HOME.
ORACLE_HOME ORACLE_HOME for Oracle Secure Enterprise Search represents the path MW_HOME/ses by default; a different name can be specified during installation. It is the directory where Oracle SES is installed.