Delete Portlet Preference

Deletes a Portlet Preference on a Portlet definition or instance, depending on scope.

Namespace

/bea/wlp/api

HTTP Method

DELETE

URI

/bea/wlp/api/portlet_prefs/item/{portlet definition or instance label}

Parameters

Parameter
Type
Description
Allowed Values
Default Value
webapp (required)
String
The webapp that contains the Portlet.
scope
String
The scope at which to delete the Portlet preference.
library
admin
visitor
library
portal
String
For 'admin' or 'visitor' scope, the Portal the Portlet instance is contained in.
desktop
String
For 'admin' or 'visitor' scope, the Desktop the Portlet instance is contained in.
username
String
For 'visitor' scope, the username of the owner of the customized Portlet instance.
pref_name (required)
String
The name of the Portlet preference to delete.
cascade
Boolean
For 'library' or 'admin' scope, whether the delete should affect just the Portlet definition or admin instance, or if it should remove the preference from all derived Portlet instances.
false

Input Example

/bea/wlp/api/portlet_prefs/item/portlet_123?webapp=myWebApp&scope=library&pref_name=color&cascade=true

Return Example

<rsp/>