Move Book or Page on Book

Moves an existing Book or Page on a Book to the specified position in the same Book or a new Book. The Book label that currently contains the book to move is specified as the last part of the URI path. If the 'destination' parameter is specified, the Book or Page will be moved to that destination. Otherwise it will move position within its current parent Book.

Namespace

/bea/wlp/api

HTTP Method

POST

URI

/bea/wlp/api/book/move/bookorpage/{book definition label}

Parameters

Parameter
Type
Description
Allowed Values
Default Value
webapp (required)
String
The webapp that contains the containing Book.
format
String
The format of the results.
xml
json
xml
label (required)
String
The definition label of the Book or Page to move.
destination
String
The destination Book, if it is different from the source Book.
position (required)
Integer
The new position within the Book.
scope (required)
String
The scope for the move operation, one of library, primary admin instance, or visitor instance.
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.
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/move/bookorpage/book_1?label=myBook&webapp=myWebapp&desktop=myDesktop&scope=admin&position=2

Return Example

<rsp/>