This chapter describes the SOAP messages for the Oracle SES Web service. It contains this topic:
activate
create createAll
deactivate delete deleteAll deleteList
export exportAll exportList
getAllObjectKeys getAPIVersion getAllStates getState getStateList
login logout
start stop
update updateAll
Activates an administrative object. Objects that control the periodic execution of an activity must also be started: indexOptimizer and schedule.
<activate xmlns="http://search.oracle.com/Admin"> <objectType xmlns=""> <objectKey xmlns=""> <adminKeyPairs> <keyName> <keyValue> <objectXML xmlns=""> <decryptionKey xmlns=""> <credentials xmlns=""> <password> <userName> <locale xmlns="">
Element Descriptions
Describes activation of an administrative object. It contains these elements:
<objectType> <objectKey> <objectXML> <decryptionKey> <credentials> <locale>
Contains one of these object types:
clustering clusterTree identityPlugin indexOptimizer queryUIFacets resultList schedule singleSignOnSetting skinBundle suggContentProvider tagging
Describes the object key for a creatable object type:
clusterTree identityPlugin schedule singleSignOnSetting suggContentProvider
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 Website Schedule.
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 |
|---|---|
< |
< |
> |
> |
" |
" |
Contains a decryption key for identityPlugin and suggContentProvider objects.
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.
AdminAPIRuntimeFault CreatableAdminObjectFault DependentObjectFault InvalidInputFault InvalidStateFault
Creates an administrative object from an XML description.
<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
Describes creation of an administrative object. It contains these elements:
<creatableType> <objectKey> <objectXML> <decryptionKey> <credentials> <attachments> <locale>
Contains a creatable type:
altWord boostedUrl classification clusterTree identityPlugin indexProfile lexer proxyLogin schedule searchAttr skinBundle source sourceGroup sourceType storageArea suggContentProvider suggestion suggLink tag thesaurus
Describes the object key for the object. This element contains an <adminKeyPairs> element.
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 Website Schedule.
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 |
|---|---|
< |
< |
> |
> |
" |
" |
Contains a decryption key for these object types:
identityPlugin proxyLogin source suggContentProvider
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.
Describes a set of files composing a skinBundle. It contains these elements:
<resourceName> <resourcePath>
Contains the relative path of the file within the skin bundle, such as assets/images/logo.gif
Contains the full local path to the attachment file, such as /home/user/skins/acme/assets/images/logo.gif.
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.
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" />
Creates all of the administrative objects of a specified type in an XML description.
<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 classification clusterTree identityPlugin indexProfile lexer proxyLogin schedule searchAttr source sourceGroup sourceType storageArea suggContentProvider suggestion suggLink tag
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 suggContentProvider
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>
A control name:
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.
AdminAPIRuntimeFault CreatableAdminObjectFault DependentObjectFault InvalidInputFault InvalidStateFault
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>searchsys</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>
Deactivates an administrative object.
<deactivate xmlns="http://search.oracle.com/Admin"> <objectType xmlns=""> <objectKey xmlns=""> <adminKeyPairs> <keyName> <keyValue> <credentials xmlns=""> <password> <userName> <locale xmlns="">
Element Descriptions
Describes activation of an administrative object. It contains these elements:
<objectType> <objectKey> <credentials> <locale>
Contains one of these object types:
clustering clusterTree identityPlugin indexOptimizer queryUIFacets resultList schedule singleSignOnSetting skinBundle suggContentProvider tagging
Describes the object key for a creatable object type. See Chapter 2, "Administration Object Types," for format of the object keys for these object types:
clusterTree identityPlugin schedule singleSignOnSetting suggContentProvider
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 of <keyName>, such as Website Schedule for the name of a schedule.
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.
AdminAPIRuntimeFault CreatableAdminObjectFault DependentObjectFault InvalidInputFault InvalidStateFault
This example deactivates the Oracle Doc Library schedule. Any error messages are returned in Italian.
<deactivate xmlns="http://search.oracle.com/Admin">
<objectType xmlns="">schedule</objectType>
<objectKey xmlns="">
<adminKeyPairs>
<keyName>name</keyName>
<keyValue>Oracle Doc Library</keyValue>
</adminKeyPairs>
</objectKey>
<locale xmlns="">it</locale>
</deactivate>
This is the service response for a successful operation:
<ns2:deactivateResponse xmlns:ns2="http://search.oracle.com/Admin" />
Deletes an administrative object.
<delete xmlns="http://search.oracle.com/Admin"> <creatableType xmlns=""> <objectKey xmlns=""> <adminKeyPairs> <keyName> <keyValue> <credentials xmlns=""> <password> <userName> <locale xmlns="">
Element Descriptions
Describes deletion of an administrative object. It contains these elements:
classification creatableType objectKey credentials locale suggestion
Contains one of these creatable types:
altWord boostedUrl classification clusterTree docServiceManager identityPlugin indexProfile lexer proxyLogin schedule searchAttr skinBundle source sourceGroup sourceType storageArea suggContentProvider suggestion suggLink tag thesaurus
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 Website Schedule.
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.
AdminAPIRuntimeFault CreatableAdminObjectFault DependentObjectFault InvalidInputFault InvalidStateFault
This example deletes a proxy log-in named this_proxy:
<delete xmlns="http://search.oracle.com/Admin">
<creatableType xmlns="">proxyLogin</creatableType>
<objectKey xmlns="">
<adminKeyPairs>
<keyName>name</keyName>
<keyValue>this_proxy</keyValue>
</adminKeyPairs>
</objectKey>
</delete>
This is the service response for a successful operation:
<ns2:deleteResponse xmlns:ns2="http://search.oracle.com/Admin" />
Deletes all of the administrative objects of a specified type.
<deleteAll xmlns="http://search.oracle.com/Admin"> <creatableType xmlns=""> <objectKeyPattern xmlns=""> <adminKeyPairs> <keyName> <keyValue> <credentials xmlns=""> <password> <userName> <controls xmlns=""> <controlName> <controlValue> <locale xmlns="">
Element Descriptions
Describes deletion of administrative objects. It contains these elements:
<creatableType> <objectKeyPattern> <credentials> <controls> <locale>
Contains one of these creatable types:
altWord boostedUrl classification clusterTree docServiceManager identityPlugin indexProfile lexer proxyLogin schedule searchAttr skinBundle source sourceGroup sourceType storageArea suggContentProvider suggestion suggLink tag
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 case-sensitive 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.
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.
Describes an operation control. It contains these elements:
<controlName> <controlValue>
Contains these control:
IGNORE_INVALID_STATE: Controls whether processing continues when an object cannot be deleted because it is in an invalid state. For clusterTree, identityPlugin, and schedule only.
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.
AdminAPIRuntimeFault CreatableAdminObjectFault DependentObjectFault InvalidInputFault InvalidStateFault
This example deletes all schedules that match the string My%.
<deleteAll xmlns="http://search.oracle.com/Admin">
<creatableType xmlns="">schedule</creatableType>
<objectKeyPattern xmlns="">
<adminKeyPairs>
<keyName>name</keyName>
<keyValue>My%</keyValue>
</adminKeyPairs>
</objectKeyPattern>
</deleteAll>
This response confirms that the schedule named My Mail was successfully deleted:
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:deleteAllResponse xmlns:ns2="http://search.oracle.com/Admin">
<statusList>
<objectKey>
<adminKeyPairs>
<keyName>name</keyName>
<keyValue>My Mail</keyValue>
</adminKeyPairs>
</objectKey>
<objectType>schedule</objectType>
<statusCode>DELETE_SUCCEEDED</statusCode>
</statusList>
</ns2:deleteAllResponse>
</S:Body>
</S:Envelope>
Deletes a list of administrative objects of a specified type.
<deleteList xmlns="http://search.oracle.com/Admin"> <creatableType xmlns=""> <objectKeys xmlns=""> <adminKeyPairs> <keyName> <keyValue> <credentials xmlns=""> <password> <userName> <controls xmlns=""> <controlName> <controlValue> <locale xmlns="">
Element Descriptions
Describes the deletion of one or more objects. It contains these elements:
<creatableType> <objectKeys> <credentials> <controls> <locale>
Contains one of these creatable types:
altWord boostedUrl classification clusterTree docServiceManager identityPlugin indexProfile lexer proxyLogin schedule searchAttr skinBundle source sourceGroup sourceType storageArea suggContentProvider suggestion suggLink tag
Describes the key for an object. One or more <objectKeys> elements compose the list of objects to delete. 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 Website Schedule.
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.
Describes an operation control. It contains these elements:
<controlName> <controlValue>
IGNORE_NOT_FOUND: Controls the resulting action when an object in the list does not exist.
IGNORE_INVALID_STATE: Controls whether processing continues when an object cannot be deleted because it is in an invalid state. For identityPlugin and schedule only.
For IGNORE_NOT_FOUND:
true: The object is skipped and processing continues.
false: Processing stops with an error. (Default)
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.
AdminAPIRuntimeFault CreatableAdminObjectFault DependentObjectFault InvalidInputFault InvalidStateFault
This example deletes a list of three proxy log-ins:
<deleteList xmlns="http://search.oracle.com/Admin">
<creatableType xmlns="">proxyLogin</creatableType>
<objectKeys>
<adminKeyPairs>
<keyName>name</keyName>
<keyValue>this_proxy</keyValue>
</adminKeyPairs>
</objectKeys>
<objectKeys xmlns="">
<adminKeyPairs>
<keyName>name</keyName>
<keyValue>some_proxy</keyValue>
</adminKeyPairs>
</objectKeys>
<objectKeys>
<adminKeyPairs>
<keyName>name</keyName>
<keyValue>that_proxy</keyValue>
</adminKeyPairs>
</objectKeys>
<controls xmlns="">
<controlName>IGNORE_NOT_FOUND</controlName>
<controlValue>true</controlValue>
</controls>
</deleteList>
The service response indicates that this_proxy and that_proxy were deleted successfully. Processing continued after some_proxy was not found.
<ns2:deleteListResponse xmlns:ns2="http://search.oracle.com/Admin">
<statusList>
<objectKey>
<adminKeyPairs>
<keyName>name</keyName>
<keyValue>this_proxy</keyValue>
</adminKeyPairs>
</objectKey>
<objectType>proxyLogin</objectType>
<statusCode>DELETE_SUCCEEDED</statusCode>
</statusList>
<statusList>
<objectKey>
<adminKeyPairs>
<keyName>name</keyName>
<keyValue>some_proxy</keyValue>
</adminKeyPairs>
</objectKey>
<objectType>proxyLogin</objectType>
<statusCode>NOT_FOUND_IGNORED</statusCode>
</statusList>
<statusList>
<objectKey>
<adminKeyPairs>
<keyName>name</keyName>
<keyValue>that_proxy</keyValue>
</adminKeyPairs>
</objectKey>
<objectType>proxyLogin</objectType>
<statusCode>DELETE_SUCCEEDED</statusCode>
</statusList>
</ns2:deleteListResponse>
Returns the XML description of an object.
<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 Website Schedule.
The encryption key for passwords in the XML description of identityPlugin, proxyLogin, source, and suggContentProvider 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.
AdminAPIRuntimeFault CreatableAdminObjectFault DependentObjectFault InvalidInputFault InvalidStateFault
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>searchsys</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.2.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>
Returns the XML descriptions of all objects of a specified type.
<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 clusterTree identityPlugin indexProfile lexer proxyLogin schedule searchAttr singleSignOnSetting skinBundle source sourceGroup sourceType storageArea suggContentProvider suggestion suggLink tag
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, source, and suggContentProvider 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.
AdminAPIRuntimeFault CreatableAdminObjectFault DependentObjectFault InvalidInputFault InvalidStateFault
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>searchsys</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.2.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>
Returns the XML descriptions of a list of objects of a specified type.
<exportList xmlns="http://search.oracle.com/Admin"> <creatableType xmlns=""> <objectKeys xmlns=""> <adminKeyPairs> <keyName> <keyValue> <encryptionKey xmlns=""> <credentials xmlns=""> <password> <userName> <controls xmlns=""> <controlName> <controlValue> <locale xmlns="">
Element Descriptions
Describes a list of objects for export. It contains these elements:
<creatableType> <objectKeys> <encryptionKey> <credentials> <controls> <locale>
Contains a creatable object type:
altWord boostedUrl clusterTree identityPlugin indexProfile lexer proxyLogin schedule searchAttr singleSignOnSetting skinBundle source sourceGroup sourceType storageArea suggContentProvider suggestion suggLink tag
Describes the key for an object. One or more <objectKeys> elements compose the list of objects to export. 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 "Website Schedule".
The encryption key for passwords in the XML description of identityPlugin, proxyLogin, source, and suggContentProvider 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.
Describes an operation control. It contains these elements:
<controlName> <controlValue>
IGNORE_NOT_FOUND: Controls the resulting action when an object in the list does not exist.
For IGNORE_NOT_FOUND:
true: The object is skipped and processing continues.
false: Processing stops with an error. (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.
AdminAPIRuntimeFault CreatableAdminObjectFault DependentObjectFault InvalidInputFault InvalidStateFault
This example requests the XML descriptions of three proxy log-ins: this_proxy, some_proxy, and that_proxy.
<exportList xmlns="http://search.oracle.com/Admin">
<creatableType xmlns="">proxyLogin</creatableType>
<objectKeys xmlns="">
<adminKeyPairs>
<keyName>name</keyName>
<keyValue>this_proxy</keyValue>
</adminKeyPairs>
</objectKeys>
<objectKeys xmlns="">
<adminKeyPairs>
<keyName>name</keyName>
<keyValue>some_proxy</keyValue>
</adminKeyPairs>
</objectKeys>
<objectKeys xmlns="">
<adminKeyPairs>
<keyName>name</keyName>
<keyValue>that_proxy</keyValue>
</adminKeyPairs>
</objectKeys>
<encryptionKey xmlns="">key2encrypt</encryptionKey>
<controls xmlns="">
<controlName>IGNORE_NOT_FOUND</controlName>
<controlValue>true</controlValue>
</controls>
</exportList>
The following response provides the XML descriptions of this_proxy and that_proxy. It ignored the request for some_proxy, which did not exist.
<ns2:exportListResponse xmlns:ns2="http://search.oracle.com/Admin">
<objectOutput>
<objectXML><?xml version="1.0" encoding="UTF-8"?>
<search:config productVersion="11.2.2.2.0" xmlns:search="http://xmlns.oracle.com/search">
<search:proxyLogins>
<search:proxyLogin>
<search:name>this_proxy</search:name>
<search:password encrypted="true">128b6b43...</search:password>
<search:useIdentityPlugin>false</search:useIdentityPlugin>
</search:proxyLogin>
<search:proxyLogin>
<search:name>that_proxy</search:name>
<search:password encrypted="true">a625ca28...</search:password>
<search:useIdentityPlugin>false</search:useIdentityPlugin>
</search:proxyLogin>
</search:proxyLogins>
</search:config>
</objectXML>
</objectOutput>
</ns2:exportListResponse>
Returns the object keys for a specified object type.
<getAllObjectKeys xmlns="http://search.oracle.com/Admin">>> <creatableType xmlns=""> <objectKeyPattern xmlns=""> <adminKeyPairs> <keyName> <keyValue> <credentials xmlns=""> <password> <userName> <locale xmlns="">
Element Descriptions
Contains these elements:
<creatableType> <objectKeyPattern> <credentials> <locale>
Contains a creatable object type. See Table 1-3, "Creatable Object Types".
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.
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.
This example requests all suggested links with a keyword that begins with data:
<getAllObjectKeys xmlns="http://search.oracle.com/Admin">
<creatableType xmlns="">suggLink</creatableType>
<objectKeyPattern xmlns="">
<adminKeyPairs>
<keyName>keyword</keyName>
<keyValue>data%</keyValue>
</adminKeyPairs>
</objectKeyPattern>
</getAllObjectKeys>
The service response provides the object keys for the suggested link with the keyword database:
<ns2:getAllObjectKeysResponse xmlns:ns2="http://search.oracle.com/Admin">
<objectKeyList>
<adminKeyPairs>
<keyName>keyword</keyName>
<keyValue>database</keyValue>
</adminKeyPairs>
<adminKeyPairs>
<keyName>linkUrl</keyName>
<keyValue>
http://www.oracle.com/technology/products/database/oracle11g
</keyValue>
</adminKeyPairs>
</objectKeyList>
</ns2:getAllObjectKeysResponse>
Returns the version number of the Oracle SES Administration API.
<getAPIVersion xmlns="http://search.oracle.com/Admin"> <credentials xmlns=""> <password> <userName> <locale xmlns="">
Element Descriptions
Contains these elements:
<credentials> <locale>
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.
This example requests the version number of the API:
<getAPIVersion xmlns="http://search.oracle.com/Admin"/>
The service response contains the version number:
<ns2:getAPIVersionResponse xmlns:ns2="http://search.oracle.com/Admin"> <return>11.2.2.2.0</return> </ns2:getAPIVersionResponse> <ns2:getAPIVersionResponse xmlns:ns2="http://search.oracle.com/Admin"> <version>11.2.2.2.0</version> </ns2:getAPIVersionResponse>
Returns the current state of all objects of a specified type as an XML document.
<getAllStates xmlns="http://search.oracle.com/Admin"> <creatableType xmlns=""> <stateProperties xmlns=""> <objectKeyPattern xmlns=""> <adminKeyPairs> <keyName> <keyValue> <credentials xmlns=""> <password> <userName> <locale xmlns="">
Element Descriptions
Contains these elements:
<creatableType> <stateProperties> <objectKeyPattern> <credentials> <locale>
Contains one of these creatable types:
clusterTree identityPlugin schedule singleSignOnSetting skinBundle suggContentProvider
Contains a state property of the object. The response is limited to the properties listed in the <stateProperties> elements. By default, the response contains the current state of all properties. See Table 1-4, "Administrative Objects With State Properties".
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.
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.
AdminAPIRuntimeFault CreatableAdminObjectFault DependentObjectFault InvalidInputFault InvalidStateFault
This example requests the status and next crawl time for schedules with a name beginning with Ora. Any error messages are returned in Spanish.
<getAllStates xmlns="http://search.oracle.com/Admin">
<creatableType xmlns="">schedule</creatableType>
<stateProperties xmlns="">status</stateProperties>
<stateProperties xmlns="">nextCrawl</stateProperties>
<objectKeyPattern xmlns="">
<adminKeyPairs>
<keyName>name</keyName>
<keyValue>Ora%</keyValue>
</adminKeyPairs>
</objectKeyPattern>
<locale xmlns="">es</locale>
</getAllStates>
The service response describes a schedule named Oracle Doc Library. Its status is SCHEDULED, and the next crawl is Thu, 15 Oct 2009 08:00:00 GMT.
<ns2:getAllStatesResponse xmlns:ns2="http://search.oracle.com/Admin">
<objectStateXML>
<objectXML>
<?xml version="1.0" encoding="UTF-8"?>
<search:state productVersion="11.2.2.2.0" xmlns:search="http://xmlns.oracle.com/search">
<search:objectStates>
<search:objectState>
<search:objectType>schedule</search:objectType>
<search:objectKey>
<search:keyPairs>
<search:keyPair>
<search:name>name</search:name>
<search:value>Oracle Doc Library</search:value>
</search:keyPair>
</search:keyPairs>
</search:objectKey>
<search:stateProperties>
<search:stateProperty>
<search:propertyName>status</search:propertyName>
<search:propertyValues>
<search:propertyValue>
<search:value>SCHEDULED</search:value>
</search:propertyValue>
</search:propertyValues>
</search:stateProperty>
<search:stateProperty>
<search:propertyName>nextCrawl</search:propertyName>
<search:propertyValues>
<search:propertyValue>
<search:value>Thu, 15 Oct 2009 08:00:00 GMT</search:value>
</search:propertyValue>
</search:propertyValues>
</search:stateProperty>
</search:stateProperties>
</search:objectState>
</search:objectStates>
</search:state>
</objectXML>
</objectStateXML>
</ns2:getAllStatesResponse>
Returns the current state of an object as an XML document.
<getState xmlns="http://search.oracle.com/Admin"> <objectType xmlns=""> <objectKey xmlns=""> <adminKeyPairs> <keyName> <keyValue> <stateProperties xmlns=""> <credentials xmlns=""> <password> <userName> <locale xmlns="">
Element Descriptions
Contains these elements:
<objectType> <objectKey> <stateProperties> <credentials> <locale>
Contains one of these object types:
autoSuggestion clustering clusterTree identityPlugin index indexOptimizer resultList schedule singleSignOnSetting skinBundle suggContentProvider tagging
Describes the object key for a creatable 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 Website Schedule.
Contains a state property of the object. The response is limited to the properties listed in the <stateProperties> elements. By default, the response contains the current state of all properties. See Table 1-4, "Administrative Objects With State Properties".
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.
AdminAPIRuntimeFault CreatableAdminObjectFault DependentObjectFault InvalidInputFault InvalidStateFault
This example requests the current state of the index:
<getState xmlns="http://search.oracle.com/Admin"> <objectType xmlns="">index</objectType> </getState>
The service response shows that the index has an estimated fragmentation of 1.5%.
<ns2:getStateResponse xmlns:ns2="http://search.oracle.com/Admin">
<objectStateXML>
<objectXML>
<?xml version="1.0" encoding="UTF-8"?>
<search:state productVersion="11.2.2.2.0" xmlns:search="http://xmlns.oracle.com/search">
<search:objectStates>
<search:objectState>
<search:objectType>index</search:objectType>
<search:stateProperties>
<search:stateProperty>
<search:propertyName>estimatedFragmentation</search:propertyName>
<search:propertyValues>
<search:propertyValue>
<search:value>1.5</search:value>
</search:propertyValue>
</search:propertyValues>
</search:stateProperty>
</search:stateProperties>
</search:objectState>
</search:objectStates>
</search:state>
</objectXML>
</objectStateXML>
</ns2:getStateResponse>
Returns the current state of a list of objects of the same type.
<getStateList xmlns="http://search.oracle.com/Admin"> <creatableType> <objectKeys> <adminKeyPairs> <keyName> <keyValue> <stateProperties> <credentials> <password> <userName> <locale xmlns="">
Element Descriptions
Contains these elements:
<creatableType> <objectKeys> <stateProperties> <credentials> <locale>
Contains one of these creatable types:
clusterTree identityPlugin schedule singleSignOnSetting skinBundle suggContentProvider
Describes the key for an object. One or more <objectKeys> elements compose the list of objects. 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 Website Schedule.
Contains a state property of the object. The response is limited to the properties listed in the <stateProperties> elements. By default, the response contains the current state of all properties. See Table 1-4, "Administrative Objects With State Properties".
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.
AdminAPIRuntimeFault CreatableAdminObjectFault DependentObjectFault InvalidInputFault InvalidStateFault
This example requests the next crawl time for the Oracle Doc Library and SQL Script Library schedules:
<getStateList xmlns="http://search.oracle.com/Admin">
<creatableType xmlns="">schedule</creatableType>
<stateProperties xmlns="">nextCrawl</stateProperties>
<objectKeys xmlns="">
<adminKeyPairs>
<keyName>name</keyName>
<keyValue>Oracle Doc Library</keyValue>
</adminKeyPairs>
</objectKeys>
<objectKeys xmlns="">
<adminKeyPairs>
<keyName>name</keyName>
<keyValue>SQL Script Library</keyValue>
</adminKeyPairs>
</objectKeys>
<credentials xmlns="">
<password>password</password>
<userName>searchsys</userName>
</credentials>
</getStateList>
The service response provides the next scheduled crawl times:
<ns2:getStateListResponse xmlns:ns2="http://search.oracle.com/Admin">
<objectStateXML>
<objectXML>
<?xml version="1.0" encoding="UTF-8"?>
<search:state productVersion="11.2.2.2.0" xmlns:search="http://xmlns.oracle.com/search">
<search:objectStates>
<search:objectState>
<search:objectType>schedule</search:objectType>
<search:objectKey>
<search:keyPairs>
<search:keyPair>
<search:name>name</search:name>
<search:value>Oracle Doc Library</search:value>
</search:keyPair>
</search:keyPairs>
</search:objectKey>
<search:stateProperties>
<search:stateProperty>
<search:propertyName>nextCrawl</search:propertyName>
<search:propertyValues>
<search:propertyValue>
<search:value>Thu, 15 Oct 2009 08:00:00 GMT</search:value>
</search:propertyValue>
</search:propertyValues>
</search:stateProperty>
</search:stateProperties>
</search:objectState>
<search:objectState>
<search:objectType>schedule</search:objectType>
<search:objectKey>
<search:keyPairs>
<search:keyPair>
<search:name>name</search:name>
<search:value>SQL Script Library</search:value>
</search:keyPair>
</search:keyPairs>
</search:objectKey>
<search:stateProperties>
<search:stateProperty>
<search:propertyName>nextCrawl</search:propertyName>
<search:propertyValues>
<search:propertyValue>
<search:value>Wed, 07 Oct 2009 06:00:00 GMT</search:value>
</search:propertyValue>
</search:propertyValues>
</search:stateProperty>
</search:stateProperties>
</search:objectState>
</search:objectStates>
</search:state>
</objectXML>
</objectStateXML>
</ns2:getStateListResponse>
Provides the administrative credentials for a stateful session. While the client maintains the HTTP session, credentials are not required in subsequent SOAP messages.
<login xmlns="http://search.oracle.com/Admin"> <credentials xmlns=""> <password> <userName> <locale xmlns="">
Element Descriptions
Contains these elements:
<credentials> <locale>
Provides the credentials for the Oracle SES administrator. It contains these 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.
This example provides the credentials for a stateful session:
<login xmlns="http://search.oracle.com/Admin">
<credentials xmlns="">
<password>password</password>
<userName>searchsys</userName>
</credentials>
</login>
This is the service response:
<ns2:loginResponse xmlns:ns2="http://search.oracle.com/Admin" />
Starts an administrative object.
<start xmlns="http://search.oracle.com/Admin"> <objectType xmlns=""> <objectKey xmlns=""> <adminKeyPairs> <keyName> <keyValue> <credentials xmlns=""> <password> <userName> <locale xmlns="">
Element Descriptions
Describes creation of an administrative object. It contains these elements:
<objectType> <objectKey> <objectXML> <credentials> <locale>
Contains one of these types:
autoSuggestion indexOptimizer schedule
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 "Website Schedule".
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.
AdminAPIRuntimeFault CreatableAdminObjectFault DependentObjectFault InvalidInputFault InvalidStateFault
This example starts the index optimizer:
<start xmlns="http://search.oracle.com/Admin"> <objectType xmlns="">indexOptimizer</objectType> </start>
This is the service response for a successful operation:
<ns2:startResponse xmlns:ns2="http://search.oracle.com/Admin" />
The next example starts the Oracle Doc Library schedule:
<start xmlns="http://search.oracle.com/Admin">
<objectType xmlns="">schedule</objectType>
<objectKey xmlns="">
<adminKeyPairs>
<keyName>name</keyName>
<keyValue>Oracle Doc Library</keyValue>
</adminKeyPairs>
</objectKey>
</start>
Stops an administrative object.
<stop xmlns="http://search.oracle.com/Admin"> <objectType xmlns=""> <objectKey xmlns=""> <adminKeyPairs> <keyName> <keyValue> <credentials xmlns=""> <password> <userName> <locale xmlns="">
Element Descriptions
Describes creation of an administrative object. It contains these elements:
<objectType> <objectKey> <objectXML> <credentials> <locale>
Contains this object type:
schedule
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 "Website Schedule".
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.
AdminAPIRuntimeFault CreatableAdminObjectFault DependentObjectFault InvalidInputFault InvalidStateFault
This example stops the Oracle Doc Library schedule:
<stop xmlns="http://search.oracle.com/Admin">
<objectType xmlns="">schedule</objectType>
<objectKey xmlns="">
<adminKeyPairs>
<keyName>name</keyName>
<keyValue>Oracle Doc Library</keyValue>
</adminKeyPairs>
</objectKey>
</credentials>
</stop>
This is the service response for a successful operation:
<ns2:stopResponse xmlns:ns2="http://search.oracle.com/Admin" />
Sets the properties of an administrative object.
<update xmlns="http://search.oracle.com/Admin"> <objectType xmlns=""> <objectKey xmlns=""> <adminKeyPairs> <keyName> <keyValue> <objectXML xmlns=""> <decryptionKey xmlns=""> <credentials xmlns=""> <password> <userName> <attachments xmlns=""> <resourceName> <resourcePath> <controls xmlns=""> <controlName> <controlValue> <locale xmlns="">
Element Descriptions
Describes the update of an administrative object. It contains these elements:
<objectType> <objectKey> <objectXML> <objectXML> <decryptionKey> <credentials> <attachments> <controls> <locale>
Contains one of these types:
altWord autoSuggestion boostedUrl clustering clusterTree crawlerSettings facetTree index indexOptimizer indexProfile languageBasedTokenization lexer partitionConfig proxy proxyLogin queryConfig resultList schedule searchAttr singleSignOnSetting skinBundle source sourceGroup sourceType storageArea suggContent suggContentProvider suggestion suggLink tag tagging thesaurus
Describes the object key for a creatable 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 "Website Schedule".
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 |
|---|---|
< |
< |
> |
> |
" |
" |
Contains a decryption key for proxyLogin, source, and suggContentProvider objects.
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.
Describes a set of files composing a skinBundle. It contains these elements:
<resourceName> <resourcePath>
Contains the relative path of the file within the skin bundle, such as assets/images/logo.gif
Contains the full local path to the attachment file, such as /home/user/skins/holiday/assets/images/logo.gif.
Specifies an operation control. It contains these elements:
<controlName> <controlValue>
UPDATE_METHOD: Controls the method used to update the properties of an object. (Required)
For UPDATE_METHOD:
overwrite: Replaces the existing property values with the new values.
add: Adds new properties and overwrites existing properties, but does not delete existing properties that are omitted from the XML document. For clusterTree, resultList, schedule, searchAttr, source, sourceGroup, and sourceType.
remove: Removes existing properties. For clusterTree, resultList, schedule, searchAttr, source, sourceGroup, and sourceType.
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.
AdminAPIRuntimeFault CreatableAdminObjectFault DependentObjectFault InvalidInputFault InvalidStateFault
This example updates the crawler settings. The input XML document is omitted from the example.
<update xmlns="http://search.oracle.com/Admin">
<objectType xmlns="">crawlerSettings</objectType>
<objectXML xmlns="">
<!-- XML object description appears here-->
</objectXML>
<controls xmlns="">
<controlName>UPDATE_METHOD</controlName>
<controlValue>overwrite</controlValue>
</controls>
</update>
The following is the service response to a successful update:
<ns2:updateResponse xmlns:ns2="http://search.oracle.com/Admin" />
Updates all objects of a given type that are described in the XML.
<updateAll xmlns="http://search.oracle.com/Admin"> <creatableType> <objectXML xmlns=""> <decryptionKey xmlns=""> <credentials xmlns=""> <password> <userName> <controls xmlns=""> <controlName> <controlValue> <locale xmlns="">
Element Descriptions
Describes creation of an administrative object. It contains these elements:
<creatableType> <objectKey> <objectXML> <decryptionKey> <credentials> <attachments> <controls> <locale>
Contains one of these types:
altWord boostedUrl clusterTree facetTree indexProfile lexer proxyLogin schedule searchAttr singleSignOnSetting source sourceGroup sourceType suggContentProvider suggestion suggLink tag
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 |
|---|---|
< |
< |
> |
> |
" |
" |
Contains a decryption key for proxyLogin, source, and suggContentProvider objects.
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>
UPDATE_METHOD: Controls the method used to update the properties of an object.
NOT_FOUND_METHOD: Controls the action to take when an object does not exist.
IGNORE_INVALID_STATE: Controls whether processing continues when an object cannot be overwritten because it is in an invalid state. For clusterTree, schedule, and storageArea objects. This option is used only when UPDATE_METHOD is OVERWRITE.
For UPDATE_METHOD:
overwrite: Replaces the existing property values with the new values.
add: Adds new properties and overwrites existing properties, but does not delete existing properties that are omitted from the XML document. For clusterTree, schedule, searchAttr, source, sourceGroup, sourceType, and storageArea.
remove: Removes existing properties. For clusterTree, resultList, schedule, searchAttr, source, sourceGroup, sourceType, and storageArea.
For NOT_FOUND_METHOD:
create: Creates a new object from the XML description and continue processing.
error: Processing stops with an error. (Default)
ignore: Ignore the new description and continue processing.
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.
AdminAPIRuntimeFault CreatableAdminObjectFault DependentObjectFault InvalidInputFault InvalidStateFault
This example updates all of the altWord objects described in the <objectXML> element. The content of this element is not shown.
<updateAll xmlns="http://search.oracle.com/Admin">
<creatableType xmlns="">altWord</creatableType>
<objectXML xmlns="">
<!-- XML object descriptions appear here-->
</objectXML>
<controls xmlns="">
<controlName>UPDATE_METHOD</controlName>
<controlValue>OVERWRITE</controlValue>
</controls>
<controls xmlns="">
<controlName>NOT_FOUND_METHOD</controlName>
<controlValue>CREATE</controlValue>
</controls>
</updateAll>
The service response shows that two alternate keywords were updated and one was created.
<ns2:updateAllResponse 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>UPDATE_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>NOT_FOUND_CREATED</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>UPDATE_SUCCEEDED</statusCode>
</statusList>
</ns2:updateAllResponse>