Update Portlet Preference

Creates or updates a Portlet preference on a Portlet definition or instance, depending on scope.

Namespace

/bea/wlp/api

HTTP Method

POST

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 create/update 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 create/update.
pref_value (required)
String
The value(s) of the Portlet preference to create/update.
multivalued
Boolean
Whether this Portlet preference may contain multiple values.
true
modifiable
Boolean
Whether this Portlet preference may be modified by visitors.
true
cascade
Boolean
For 'library' or 'admin' scope, whether the operation should affect just the Portlet definition or admin instance, or if it should cascade to all derived Portlet instances.
false

Input Example

/bea/wlp/api/portlet_prefs/item/portlet_123?webapp=myWebApp&scope=visitor&portal=myPortal&desktop=myDesktop&pref_name=color&pref_value=red&pref_value=blue

Return Example

<rsp/>