Add Book to Page

Adds an existing Book to a Page, at a specified position within a placeholder. The Page is specified by its definition label, supplied as the last part of the URI path.

Namespace

/bea/wlp/api

HTTP Method

POST

URI

/bea/wlp/api/page/add/book/{page definition label}

Parameters

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 (required)
String
The definition label of the Book to add to the Page.
placeholder
Integer
The placeholder that the Book should be placed into.
0
position
Integer
The position within the placeholder that the Book should be placed at.
0
scope
String
The scope that the Book should be added to the Page, one of the library, 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, the username of the owner of the customized Page instance.
proliferation
String
For 'library' or 'admin' scope, whether or not the move operation should be cascaded to derived Page instances.
sync
async
off
async

Input Example

/bea/wlp/api/page/add/book/page_1?book=myBook&webapp=myWebapp&portal=myPortal&desktop=myDesktop&scope=admin&placeholder=2&position=1

Return Example

<rsp/>