Get Menus

Retrieves list of all Menus in the specified webapp.

Namespace

/bea/wlp/api

HTTP Method

GET

URI

/bea/wlp/api/menu/list

Parameters

Parameter
Type
Description
Allowed Values
Default Value
webapp (required)
String
The webapp to list Menus under.
format
String
The format of the results.
xml
json
xml
max
Integer
The maximum number of Menus to return.
50
start
Integer
The starting index for returned Menus.
0
locale
String
The locale to use for the titles and descriptions of the returned Menus. Must be of the format: lang-country-variant ie. [nn], [nn-nn], or [nn-nn-nnnn].
Preferred locale from request.

Input Example

/bea/wlp/api/menu/list?webapp=myWebApp&locale=en-us

Return Example

<rsp>
   <menus>
      <menu_details>
         <title>Multi Level Menu</title>
         <description>This menu can navigate across many nested books.</description>
         <markupName>multiLevelMenu</markupName>
         <created_date>2007-12-06 14:33:50.0</created_date>
         <modified_date>2007-12-06 14:33:50.0</modified_date>
      </menu_details>
      <menu_details>
         <title>Single Level Menu</title>
         <description>This menu provides a single level of tabs used to navigate across pages.</description>
         <markupName>singleLevelMenu</markupName>
         <created_date>2007-12-06 14:33:50.0</created_date>
         <modified_date>2007-12-06 14:33:50.0</modified_date>
      </menu_details>
   </menus>
</rsp>