Oracle® Secure Enterprise Search Administration API Guide 11g Release 2 (11.2.2) Part Number E23428-01 |
|
|
PDF · Mobi · ePub |
Returns the XML descriptions of all objects of a specified type.
See Also
SOAP Message
<exportAll xmlns="http://search.oracle.com/Admin"> <creatableType xmlns=""> <objectKeyPattern xmlns=""> <adminKeyPairs> <keyName> <keyValue> <encryptionKey xmlns=""> <credentials xmlns=""> <password> <userName> <locale xmlns="">
Element Descriptions
Contains these elements:
<creatableType> <objectKeyPattern> <encryptionKey> <credentials> <locale>
Contains one of these creatable types:
altWord boostedUrl docServiceInstance docServiceManager docServicePipeline facetTree identityPlugin proxyLogin schedule searchAttr source sourceGroup sourceType storageArea suggLink
An object key that matches the objects to process. It contains one or more <adminKeyPairs>
elements.
Contains these elements:
<keyName> <keyValue>
Contains the case-sensitive key name of the object type, such as name
.
Contains a value that matches the object key of one or more objects. It can include wildcard characters:
A percent sign (%) matches zero or more characters. In a multibyte character set, it matches zero or more bytes.
An underscore (_) matches exactly one character. In a multibyte character set, it matches one byte.
The encryption key for passwords in the XML description of identityPlugin
, proxyLogin
, and source
objects. The key must be at least eight ASCII characters long and include at least one letter and one number. Multibyte characters are invalid.
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.
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 exports the XML descriptions of all alternate word pairs:
<exportAll xmlns="http://search.oracle.com/Admin"> <creatableType xmlns="">altWord</creatableType> <credentials xmlns=""> <password>password</password> <userName>admin username</userName> </credentials> </exportAll>
The service response contains the XML definitions of three alternate word pairs.
<ns2:exportAllResponse xmlns:ns2="http://search.oracle.com/Admin"> <objectOutput> <objectXML> <?xml version="1.0" encoding="UTF-8"?> <search:config productVersion="11.2.2.0.0" xmlns:search="http://xmlns.oracle.com/search"> <search:altWords> <search:altWord> <search:keyword>oses</search:keyword> <search:altKeyword>Oracle Secure Enterprise Search</search:altKeyword> <search:autoExpand>true</search:autoExpand> </search:altWord> <search:altWord> <search:keyword>rac</search:keyword> <search:altKeyword>Real Application Clusters</search:altKeyword> <search:autoExpand>false</search:autoExpand> </search:altWord> <search:altWord> <search:keyword>text</search:keyword> <search:altKeyword>Oracle Text</search:altKeyword> <search:autoExpand>false</search:autoExpand> </search:altWord> </search:altWords> </search:config> </objectXML> </objectOutput> </ns2:exportAllResponse>