Get Pages

Retrieves list of all Pages in the specified webapp.

Namespace

/bea/wlp/api

HTTP Method

GET

URI

/bea/wlp/api/page/list

Parameters

Parameter
Type
Description
Allowed Values
Default Value
webapp (required)
String
The webapp to query all Pages for.
format
String
The format of the results.
xml
json
xml
max
Integer
The maximum number of Pages to return.
50
start
Integer
The starting index of the Page result set.
0
placeables
Boolean
If true, the list of Pages will be filtered based on the specified Desktop, and only Pages that are not already placed on that Desktop will be returned.
desktop
String
The Desktop used to filter the list of Pages. Only Pages that are not already placed on the Desktop will be returned.
portal
String
The Portal that contains the Desktop if placeable filtering is specified.
locale
String
The locale to use for the titles and descriptions of the returned Pages. 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/page/list?webapp=myWebapp&max=10&start=11

Return Example

<rsp>    <page_summaries>
        <page_summary>
            <definition_label>page_11</definition_label>
            <title>Page 11</title>
        </page_summary>
        <page_summary>
            <definition_label>page_42</definition_label>
            <title>Page 42</title>
            <description>The Meaning of Life.</description>
        </page_summary>
    </page_summaries>
</rsp>