Retrieves list of all Books in the specified webapp. This list may be specified to be filtered, via the placeables parameter, in order to limit the results of this operation to only include Books that are suitable for placement on a particular Desktop.
/bea/wlp/api
GET
/bea/wlp/api/book/list
|
Parameter
|
Type
|
Description
|
Allowed Values
|
Default Value
|
|---|---|---|---|---|
|
webapp (required)
|
String
|
The webapp to list Books under.
| ||
|
format
|
String
|
The format of the results.
|
xml
json |
xml
|
|
max
|
Integer
|
The maximum number of Books to return.
|
50
|
|
|
start
|
Integer
|
The starting index for returned Books.
|
0
|
|
|
placeables
|
Boolean
|
If true, the list of Books will be filtered based on the specified Desktop, and only Books that are not already placed on that Desktop will be returned.
|
false
|
|
|
desktop
|
String
|
The Desktop used to filter the list of Books. Only Books that are not already placed on the Desktop will be returned.
| ||
|
portal
|
String
|
The Portal that contains the Desktop if filtering is specified.
| ||
|
locale
|
String
|
The locale to use for the titles and descriptions of the returned Books. Must be of the format: lang-country-variant ie. [nn], [nn-nn], or [nn-nn-nnnn].
|
Preferred locale from request.
|
|
|
filterOn
|
String
|
The case-sensitive filter string to use to match title of the returned Books.
| ||
|
sortOn
|
String
|
The sort order to use for returned titles.
|
ASCENDING
DESCENDING UNSORTED |
/bea/wlp/api/book/list?webapp=myWebapp
<rsp> <book_summaries>
<book_summary>
<definition_label>book_12</definition_label>
<title>Book 12</title>
</book_summary>
<book_summary>
<definition_label>book_42</definition_label>
<title>Book 42</title>
<description>The Meaning of Life.</description>
</book_summary>
</book_summaries>
</rsp>
Copyright 2011, Oracle. All rights reserved.