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

Get Portlet Categories

Retrieves list of all Portlet Categories in the specified webapp.

Namespace

/bea/wlp/api

HTTP Method

GET

URI

/bea/wlp/api/category/list

Parameters

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

Input Example

/bea/wlp/api/category/list?webapp=myWebApp&locale=en

Return Example

<rsp>
   <category_summaries>
      <category_summary>
         <id>12345</id>
         <parentId>11111</parentId>
         <title>My Category 1</title>
         <description>This is My Category 1.</description>
         <webapp>/myWebApp</webapp>
      </category_summary>
      <category_summary>
         <id>54321</id>
         <parentId>11111</parentId>
         <title>My Category 2</title>
         <description>This is My Category 2.</description>
         <webapp>/myWebApp</webapp>
      </category_summary>
   </category_summaries>
</rsp>

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