Updates an existing Book with any of the supplied optional information about the Book. The Book to update is specified by definition label, placed at the end of the URI path.
/bea/wlp/api
POST
/bea/wlp/api/book/item/{book definition label}
Parameter
|
Type
|
Description
|
Allowed Values
|
Default Value
|
---|---|---|---|---|
webapp (required)
|
String
|
The webapp that contains the Book to update.
| ||
format
|
String
|
The format of the results.
|
xml
json |
xml
|
menu
|
String
|
The markup name of the Menu to use for the Book. If no Menu is specified, the Book will have not have a Menu.
| ||
theme
|
String
|
The optional markup name of the Theme to use for the Book.
| ||
title
|
String
|
The updated title for the Book.
| ||
description
|
String
|
The updated description for the Book.
| ||
locale
|
String
|
The locale to use for the updated title and description of the Book. Must be of the format: lang-country-variant ie. [nn], [nn-nn], or [nn-nn-nnnn].
|
Preferred locale from request.
|
|
scope
|
String
|
The scope at which to update the Book.
|
library
admin visitor |
library
|
portal
|
String
|
For 'admin' or 'visitor' scope, the Portal that contains the Book to update. This is a required parameter when updating an admin or visitor book instance.
| ||
desktop
|
String
|
For 'admin' or 'visitor' scope, the Desktop that contains the Book to update. This is a required parameter when updating an admin or visitor book instance.
| ||
username
|
String
|
For 'visitor' scope only. If username is specified, any operation will be done as an administrator (and will require admin privileges), affecting the specified username's customized Book instance. If username is omitted, any operation will be done as the logged-in user, affecting their own Book instance.
| ||
is_public
|
Boolean
|
Specifies whether or not the Book should be marked public.
| ||
hidden
|
Boolean
|
Specifies whether or not the Book should be hidden.
| ||
defaultPage
|
String
|
Sets the default page for this book. Note that a book can also act as a page. This can be a page definition or instance label, or a book definition or instance label.
|
/bea/wlp/api/book/item/book_1?webapp=myWebApp&title=My%20New%20Title&scope=visitor&desktop=d1&portal=myPortal&username=Bob
<rsp/>
Copyright 2011, Oracle. All rights reserved.