Oracle® Secure Enterprise Search Administration API Guide 11g Release 2 (11.2.2) Part Number E23428-01 |
|
|
PDF · Mobi · ePub |
Stops an administrative object.
SOAP Message
<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 Web Site 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.
SOAP Faults
AdminAPIRuntimeFault CreatableAdminObjectFault DependentObjectFault InvalidInputFault InvalidStateFault
Example
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" />