Oracle® Secure Enterprise Search Administration API Guide 11g Release 2 (11.2.2) Part Number E23428-01 |
|
|
PDF · Mobi · ePub |
Creates all of the administrative objects of a specified type in an XML description.
See Also
SOAP Message
<createAll xmlns="http://search.oracle.com/Admin"> <creatableType xmlns=""> <objectXML xmlns=""> <decryptionKey xmlns=""> <credentials xmlns=""> <password> <userName> <controls xmlns=""> <controlName> <controlValue> <locale xmlns="">
Element Descriptions
Describes creation of one or more administrative objects. It contains these elements:
<creatableType> <objectXML> <decryptionKey> <credentials> <attachments> <controls> <locale>
Contains a creatable type:
altWord boostedUrl docServiceInstance docServicePipeline facetTree proxyLogin schedule searchAttr source sourceGroup storageArea suggLink
Contains an XML document that describes the objects. See Chapter 2, "Administration Object Types."
Use escape codes for these symbols in the embedded XML:
Symbol | Escape Code |
---|---|
< |
< |
> |
> |
" |
" |
Contains a decryption key for these object types:
identityPlugin proxyLogin source
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>
Contains the password for <userName>
.
Contains the user name of the Oracle SES administrator.
Specifies an operation control. It contains these elements:
<controlName> <controlValue>
Specifies an action for an error condition:
DUPE_METHOD
: Controls the action to take when an object already exists. For all creatable types.
IGNORE_INVALID_STATE
: Controls whether processing continues when an object cannot be overwritten because it is in an invalid state. This control is used only when DUPE_METHOD
is set to overwrite
. For clusterTree
, identityPlugin
, and schedule
only.
For DUPE_METHOD
:
error
: The operation fails with an error. (Default)
ignore
: The existing object description is kept.
overwrite
: The new description replaces the existing object description
For IGNORE_INVALID_STATE
:
true
: Continue processing with the next object.
false
: Stop processing with an error and roll back all changes. (Default)
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 InvalidStateFault
Example
This example creates all of the alternate word pairs defined in the object XML (omitted):
<createAll xmlns="http://search.oracle.com/Admin"> <creatableType xmlns="">altWord</creatableType> <objectXML xmlns=""> <!-- XML object descriptions appear here--> </objectXML> <controls xmlns=""> <controlName>DUPE_METHOD</controlName> <controlValue>overwrite</controlValue> </controls> <credentials xmlns=""> <password>password</password> <userName>admin username</userName> </credentials> </createAll>
The response shows that three alternate word pairs were created successfully.
<ns2:createAllResponse xmlns:ns2="http://search.oracle.com/Admin"> <statusList> <objectKey> <adminKeyPairs> <keyName>keyword</keyName> <keyValue>oses</keyValue> </adminKeyPairs> <adminKeyPairs> <keyName>altKeyword</keyName> <keyValue>Oracle Secure Enterprise Search</keyValue> </adminKeyPairs> </objectKey> <objectType>altWord</objectType> <statusCode>CREATE_SUCCEEDED</statusCode> </statusList> <statusList> <objectKey> <adminKeyPairs> <keyName>keyword</keyName> <keyValue>text</keyValue> </adminKeyPairs> <adminKeyPairs> <keyName>altKeyword</keyName> <keyValue>Oracle Text</keyValue> </adminKeyPairs> </objectKey> <objectType>altWord</objectType> <statusCode>CREATE_SUCCEEDED</statusCode> </statusList> <statusList> <objectKey> <adminKeyPairs> <keyName>keyword</keyName> <keyValue>rac</keyValue> </adminKeyPairs> <adminKeyPairs> <keyName>altKeyword</keyName> <keyValue>Real Application Clusters</keyValue> </adminKeyPairs> </objectKey> <objectType>altWord</objectType> <statusCode>CREATE_SUCCEEDED</statusCode> </statusList> </ns2:createAllResponse>