Move Book on Page

Moves a Book on a Page, to a location specified by placeholder and position indices. The Page is identified by its definition label, included as the last part of the URI path.

Namespace

/bea/wlp/api

HTTP Method

POST

URI

/bea/wlp/api/page/move/book/{page defintion 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 move on the Page.
placeholder
Integer
The destination placeholder within the Page to move the Book to.
0
position
Integer
The position within the placeholder to move the Book to.
0
scope (required)
String
The scope at which to perform the move operation, one of to 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, 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/move/book/page_1?book=myBook&webapp=myWebapp&portal=myPortal&desktop=myDesktop&placeholder=1&position=0&scope=admin

Return Example

<rsp/>