Oracle® Secure Enterprise Search Administration API Guide 11g Release 2 (11.2.2) Part Number E23428-01 |
|
|
PDF · Mobi · ePub |
Returns the XML description of an object.
See Also
SOAP Message
<export xmlns="http://search.oracle.com/Admin" <objectType xmlns=""> <objectKey xmlns=""> <adminKeyPairs> <keyName> <keyValue> <encryptionKey xmlns=""> <credentials xmlns=""> <password> <userName> <locale xmlns="">
Element Descriptions
Describes the export of an administrative object. See Table 1-2, "Universal Objects" and Table 1-3, "Creatable Object Types". This element contains these child elements:
<objectType> <objectKey> <encryptionKey> <credentials> <locale>
Contains an administration object type. See Table 1-2, "Universal Objects" and Table 1-3, "Creatable Object Types".
Describes the object key for the object. This element 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 the value that uniquely describes the object, such as Web Site Schedule.
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 description of this_proxy
proxy log-in:
<export xmlns="http://search.oracle.com/Admin"> <objectType xmlns="">proxyLogin</objectType> <objectKey xmlns=""> <adminKeyPairs> <keyName>name</keyName> <keyValue>this_proxy</keyValue> </adminKeyPairs> </objectKey> <encryptionKey xmlns="">key2encrypt</encryptionKey> <credentials xmlns=""> <password>password</password> <userName>admin username</userName> </credentials> </export>
The service response contains the XML definition:
<ns2:exportResponse 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:proxyLogins> <search:proxyLogin> <search:name>this_proxy</search:name> <search:password encrypted="true">128b6b430...</search:password> <search:useIdentityPlugin>false</search:useIdentityPlugin> </search:proxyLogin> </search:proxyLogins> </search:config> </objectXML> </objectOutput> </ns2:exportResponse>