Oracle Fusion Middleware REST API Reference for Oracle WebLogic Portal
10g Release 3 (10.3.4)
E14258-03

Get Portlet Preferences

Retrieves the portlet preferences for a single Portlet, specified by definition or instance label

Namespace

/bea/wlp/api

HTTP Method

GET

URI

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

Parameters

Parameter	Type	Description	Allowed Values	Default Value
webapp (required)	String	The webapp that contains the Portlet.
format	String	The format of the results.	xml json	xml
scope	String	The scope at which to get the Portlet preferences.	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 only. If username is specified, the operation will be done as an administrator (and will require admin privileges), returning the specified username's customized Portlet instance. If username is omitted, the operation will be done as the logged-in user, returning their own Portlet instance.

Input Example

/bea/wlp/api/portlet_prefs/details/portlet_123?webapp=myWebApp

Return Example

<rsp>
    <portlet_preferences>
        <portlet_preference>
            <name>color</name>
            <multivalued>true</multivalued>
            <modifiable>true</modifiable>
            <values>
                <value>red</value>
                <value>green</value>
            </values>
        </portlet_preference>
        <portlet_preference>
            <name>variety</name>
            <multivalued>true</multivalued>
            <modifiable>true</modifiable>
            <values>
                <value>Macintosh</value>
                <value>Granny Smith</value>
                <value>Red Delicious</value>
            </values>
        </portlet_preference>
    </portlet_preferences>
</rsp>

Oracle Fusion Middleware REST API Reference for Oracle WebLogic Portal
10g Release 3 (10.3.4)
E14258-03