---

deactivate

Deactivates an administrative object.

SOAP Message

<deactivate xmlns="http://search.oracle.com/Admin">
  <objectType xmlns="">
  <objectKey xmlns="">
    <adminKeyPairs>
      <keyName>
      <keyValue>
  <credentials xmlns="">
    <password>
    <userName>
  <locale xmlns="">

Element Descriptions 

<deactivate xmlns="http://search.oracle.com/Admin">

Describes activation of an administrative object. It contains these elements:

<objectType>
<objectKey>
<credentials>
<locale>

<objectType xmlns="">

Contains one of these object types:

identityPlugin
indexOptimizer
schedule

<objectKey xmlns="">

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:

identityPlugin
schedule

This element contains one or more <adminKeyPairs> elements.

<adminKeyPairs>

Contains these elements:

<keyName>
<keyValue>

<keyName>

Contains the case-sensitive key name of the object type, such as name.

<keyValue>

Contains the value of <keyName>, such as Web Site Schedule for the name of a schedule.

<credentials xmlns="">

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>

<password>

Contains the password for <userName>.

<userName>

Contains the user name of the Oracle SES administrator.

<locale xmlns="">

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 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" />