Retrieves information about a single Book, specified by definition label
/bea/wlp/api
GET
/bea/wlp/api/book/details/{book definition label}
Parameter
|
Type
|
Description
|
Allowed Values
|
Default Value
|
---|---|---|---|---|
webapp (required)
|
String
|
The webapp that contains the Book.
| ||
format
|
String
|
The format of the results.
|
xml
json |
xml
|
scope
|
String
|
The scope at which to get the Book, one of library, admin instance, or a user's own instance.
|
library
admin visitor |
library
|
portal
|
String
|
For 'admin' or 'visitor' scope, the Portal the Book instance is contained in.
| ||
desktop
|
String
|
For 'admin' or 'visitor' scope, the Desktop the Book instance is contained in.
| ||
username
|
String
|
For 'visitor' scope only. If username is specified, the operation will be done as an administrator (and will require admin privileges), returning the specified username's customized Book instance. If username is omitted, the operation will be done as the logged-in user, returning their own Book instance.
| ||
locale
|
String
|
The locale to use for the title and/or description of the returned Book. Must be of the format: lang-country-variant ie. [nn], [nn-nn], or [nn-nn-nnnn].
|
Preferred locale from request.
|
/bea/wlp/api/book/details/book_1?scope=admin&webapp=myWebapp&desktop=myDesktop&portal=myPortalPath
<rsp> <definition_label>book_1</definition_label> <title>Book One</title> <description>A book</description> <webapp>/myWebapp</webapp> <created_date>2008-01-31 12:54:47.0</created_date> <modified_date>2008-01-31 12:54:47.0</modified_date> <is_public>true</is_public> <hidden>false</hidden> <default_page>homePage</default_page></rsp>
Copyright 2011, Oracle. All rights reserved.