Get Layouts

Retrieves list of all Layouts in the specified webapp.

Namespace

/bea/wlp/api

HTTP Method

GET

URI

/bea/wlp/api/layout/list

Parameters

Parameter
Type
Description
Allowed Values
Default Value
webapp (required)
String
The webapp to list Layouts under.
format
String
The format of the results.
xml
json
xml
max
Integer
The maximum number of Layouts to return.
50
start
Integer
The starting index for returned Layouts.
0
locale
String
The locale to use for the titles and descriptions of the returned Layouts. 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/layout/list?webapp=myWebApp&max=2&start=2&locale=en-us

Return Example

<rsp>
   <layouts>
      <layout_details>
         <title>One Column Flow Layout</title> 
         <description>This layout uses the flowLayout control to create one column in which placeables flow vertically.</description> 
         <markup_name>oneColumnFlowLayout</markup_name> 
         <icon_uri>/framework/markup/layout/singlecolumn.gif</icon_uri> 
         <html_layout_uri>/framework/markup/layout/singlecolumn.html.txt</html_layout_uri> 
         <created_date>2007-12-04 14:58:37.0</created_date> 
         <modified_date>2007-12-04 14:58:37.0</modified_date> 
      </layout_details>
      <layout_details>
         <title>Two Column Flow Layout</title> 
         <description>This layout uses the flowLayout control to create two columns in which placeables flow vertically.</description> 
         <markup_name>twoColumnFlowLayout</markup_name> 
         <icon_uri>/framework/markup/layout/twocolumn.gif</icon_uri> 
         <html_layout_uri>/framework/markup/layout/twocolumn.html.txt</html_layout_uri> 
         <created_date>2007-12-04 14:58:37.0</created_date> 
         <modified_date>2007-12-04 14:58:37.0</modified_date> 
      </layout_details>
   </layouts>
</rsp>