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

Get Portlets

Retrieves list of all Portlets in the specified webapp.

Namespace

/bea/wlp/api

HTTP Method

GET

URI

/bea/wlp/api/portlet/list

Parameters

Parameter	Type	Description	Allowed Values	Default Value
webapp (required)	String	The webapp to list Portlets under.
format	String	The format of the results.	xml json	xml
categoryId	Integer	Specifying a portlet category ID will return the list of portlets associated with that portlet category.
max	Integer	The maximum number of Portlets to return.		50
start	Integer	The starting index for returned Portlets.		0
locale	String	The locale to use for the title and/or descriptions of the returned Portlets. Must be of the format: lang-country-variant ie. [nn], [nn-nn], or [nn-nn-nnnn].		Preferred locale from request.
filterOn	String	The case-sensitive filter string to use to match title of the returned Portlets.
sortOn	String	The sort order to use for returned titles.	ASCENDING DESCENDING UNSORTED

Input Example

/bea/wlp/api/portlet/list?webapp=myWebApp&max=2&locale=en-us

Return Example

<rsp>
    <portlet_summaries>
        <portlet_summary>
            <label>weather_1</label>
            <title>Weather Portlet</title>
            <icon>weather.gif</icon>
            <description>Current weather.</description>
        </portlet_summary>
        <portlet_summary>
            <label>news_1</label>
            <title>News Portlet</title>
            <icon>news.gif</icon>
            <description>Current news.</description>
        </portlet_summary>
    </portlet_summaries>
</rsp>

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