Skip Headers
Oracle® Secure Enterprise Search Administration API Guide
11g Release 1 (11.1.2.0.0)

E14133-02
Go to Documentation Home
Home
Go to Book List
Book List
Go to Table of Contents
Contents
Go to Feedback page
Contact Us

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

create

Creates an administrative object from an XML description.

See Also

createAll

SOAP Message

<create xmlns="http://search.oracle.com/Admin">
   <creatableType xmlns="">
   <objectKey xmlns="">
      <adminKeyPairs>
         <keyName>
         <keyValue>
   <objectXML xmlns="">
   <decryptionKey xmlns="">
   <credentials xmlns="">
      <password>
      <userName>
   <attachments xmlns="">
      <resourceName>
      <resourcePath>
   <locale xmlns="">

Element Descriptions 

<create xmlns="http://search.oracle.com/Admin">

Describes creation of an administrative object. It contains these elements:

<creatableType>
<objectKey>
<objectXML>
<decryptionKey>
<credentials>
<attachments>
<locale>
<creatableType xmlns="">

Contains a creatable type:

altWord
clusterTree
identityPlugin
proxyLogin
schedule
searchAttr
skinBundle
source
sourceGroup
sourceType
storageArea
suggLink
thesaurus
<objectKey xmlns="">

Describes the object key for the object. This element contains an <adminKeyPairs> element.

<adminKeyPairs>

Contains these elements:

<keyName>
<keyValue>
<keyName>

Contains the case-sensitive key name of the object type, such as name.

<keyValue>

Contains the value that uniquely describes the object, such as Website Schedule.

<objectXML xmlns="">

Contains an XML document that describes the object. See Chapter 2, "Administration Object Types."

Use escape codes for these symbols in the embedded XML:

Symbol Escape Code
< &lt;
> &gt;
" &quot;

<decryptionKey xmlns="">

Contains a decryption key for these object types:

identityPlugin
proxyLogin
source
<credentials xmlns="">

Provides the credentials for the Oracle SES administrator. Credentials are required only when the session is stateless. See "Providing Credentials".

This element contains these child elements:

<password>
<userName>
<password>

Contains the password for <userName>.

<userName>

Contains the user name of the Oracle SES administrator.

<attachments xmlns="">

Describes a set of files composing a skinBundle. It contains these elements:

<resourceName>
<resourcePath>
<resourceName>

Contains the relative path of the file within the skin bundle, such as assets/images/logo.gif

<resourcePath>

Contains the full local path to the attachment file, such as /home/user/skins/acme/assets/images/logo.gif.

<locale xmlns="">

Sets the language for error messages. See Table 2-2, "Product Languages" for a list of valid codes.

If you omit this element or enter an invalid code, then Oracle SES uses the default locale of the system where it is running.

SOAP Faults

AdminAPIRuntimeFault
CreatableAdminObjectFault
DependentObjectFault
InvalidInputFault

Example

This example creates an alternate word pair.

<create xmlns="http://search.oracle.com/Admin">
  <creatableType xmlns="">altWord</creatableType>
  <objectKey xmlns="">
    <adminKeyPairs>
      <keyName>keyword</keyName>
      <keyValue>oses</keyValue>
    </adminKeyPairs>
    <adminKeyPairs>
      <keyName>altKeyword</keyName>
      <keyValue>Oracle Secure Enterprise Search</keyValue>
    </adminKeyPairs>
  </objectKey>
  <objectXML xmlns="">
          
     <!-- XML object description appears here-->
          
  </objectXML>
</create>

This is the service response for a successful operation:

<ns2:createResponse xmlns:ns2="http://search.oracle.com/Admin" />