SOAP API - deleteUserSettings

Request

Uses the deleteUserSettingsRequestelement (from the UserSettingsService schema)

Parameter notes

storageKey: Identifies the key used to persist data on the server. Must be created using the storageKey attribute in the saveUserSettings operation.

If the restrictUserSettings property in the de.properties file is set to false, there are no restrictions on what you can pass in the storageKey attribute.

However, if the restrictUserSettings property in the de.properties file is set to true (the default), and you are passing a GUID in the storageKey attribute, it must be the GUID of the calling user. This prevents the user from deleting user settings for other users.

For additional information about the restrictUserSettings property, see "Configuration of the TIBCO ActiveMatrix BPM Directory Engine" in TIBCO® BPM Enterprise Administration.

Note: A System Administrator (that is, a user holding the "All System Actions" privilege) can delete the user settings for any user, even if the restrictUserSettings property is set to true.

Response

Returns a deleteUserSettingsRsponseelement (from the UserSettingsService schema).

Example

Request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:user="http://usersettingsservice.api.de.n2.tibco.com">
   <soapenv:Header/>
   <soapenv:Body>
      <user:deleteUserSettingsRequest>
         <storageKey>configStore</storageKey>
      </user:deleteUserSettingsRequest>
   </soapenv:Body>
</soapenv:Envelope>

Response:

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
   <SOAP-ENV:Header/>
   <SOAP-ENV:Body>
      <deleteUserSettingsResponse xmlns="http://usersettingsservice.api.de.n2.tibco.com">
         <empty xmlns="">0</empty>
      </deleteUserSettingsResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>