Create a new Book and add it to an existing Page. The Page is specified by its definition label as the last part of the URI path.
/bea/wlp/api
POST
/bea/wlp/api/page/add/new/book/{page definition label}
|
Parameter
|
Type
|
Description
|
Allowed Values
|
Default Value
|
|---|---|---|---|---|
|
webapp (required)
|
String
|
The webapp that contains the Page.
| ||
|
format
|
String
|
The format of the results.
|
xml
json |
xml
|
|
book
|
String
|
The optional definition label for the new Book. If no label is specified, a unique label will be generated.
| ||
|
position
|
Integer
|
The position within the placeholder to add the newly created Book.
|
0
|
|
|
placeholder
|
Integer
|
The placeholder within the Page to add the newly created Book to.
|
0
|
|
|
title (required)
|
String
|
The title for the new Book.
| ||
|
description
|
String
|
The description for the new Book.
| ||
|
menu
|
String
|
The optional markup name of the Menu to use for the new book. If no Menu is specified, the Book will not have a Menu.
| ||
|
theme
|
String
|
The optional markup name of the theme to use for the new Book.
| ||
|
scope
|
String
|
The scope level at which to add the Book to the Page, one of the library definition, the admin instance or a visitor's customized instance.
|
library
admin visitor |
library
|
|
portal
|
String
|
For 'admin' or 'visitor' scope, the Portal that contains the Page.
| ||
|
desktop
|
String
|
For 'admin' or 'visitor' scope, the Desktop that contains the Page.
| ||
|
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 Page instance. If username is omitted, any operation will be done as the logged-in user, affecting their own Page instance.
| ||
|
is_public
|
Boolean
|
Whether or not the newly created Book should be public in the library.
| ||
|
hidden
|
Boolean
|
Whether or not the newly created Book should be hidden.
| ||
|
locale
|
String
|
The locale to use for the title and description of the new Book. Must be of the format: lang-country-variant ie. [nn], [nn-nn], or [nn-nn-nnnn].
|
Preferred locale from request.
|
|
|
proliferation
|
String
|
For 'library' or 'admin' scope, whether or not the move operation should be cascaded to derived Page instances.
|
sync
async off |
async
|
/bea/wlp/api/page/add/new/book/page_1?book=myBook&title=Book%20One&locale=en_US&is_public=true&webapp=myWebapp&portal=myPortal&desktop=myDesktop&scope=admin&placeholder=2&position=1
<rsp>
<definition_label>myBook</definition_label>
</rsp>
Copyright 2011, Oracle. All rights reserved.