Add Page to Book

Adds an existing Page to a Book. The definition label of the destination Book is specified as the last part of the URI path.

Namespace

/bea/wlp/api

HTTP Method

POST

URI

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

Parameters

Parameter
Type
Description
Allowed Values
Default Value
webapp (required)
String
The webapp that contains the destination Book.
format
String
The format of the results.
xml
json
xml
page (required)
String
The definition label of the Page to add to the Book.
position
Integer
The position within the Books Menu to add the Page.
0
scope
String
The scope level at which to perform the add operation.
library
admin
visitor
library
portal
String
For 'admin' or 'visitor' scope, the Portal that contains the destination Book.
desktop
String
For 'admin' or 'visitor' scope, the Desktop that contains the destination Book.
username
String
For 'visitor' scope, the username of the owner of the customized Book instance.
default
Boolean
Specifies whether or not the newly added Page should be the default Menu item within the Book.
proliferation
String
For 'library' or 'admin' scope, whether or not the move operation should be cascaded to derived Book instances.
sync
async
off
async

Input Example

/bea/wlp/api/book/add/page/book_1?webapp=myWebApp&page=page_1&position=-1&scope=visitor&desktop=d1&portal=myPortal&username=Bob

Return Example

<rsp/>