Get Shells

Retrieves list of all Shells in the specified webapp.

Namespace

/bea/wlp/api

HTTP Method

GET

URI

/bea/wlp/api/shell/list

Parameters

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

Return Example

<rsp>
   <shells>
      <shell_details>
         <title>Header-Footer Shell</title>
         <description>A header and footer is included in this shell.</description>
         <markupName>headerFooter</markupName>
         <created_date>2007-12-06 14:33:52.0</created_date>
         <modified_date>2007-12-06 14:33:52.0</modified_date>
      </shell_details>
      <shell_details>
         <title>Left-Pane-Header-Footer Shell</title>
         <description>A header, footer and left pane included in this shell.</description>
         <markupName>leftPaneHeaderFooter</markupName>
         <created_date>2007-12-06 14:33:52.0</created_date>
         <modified_date>2007-12-06 14:33:52.0</modified_date>
      </shell_details>
   </shells>
</rsp>