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.
/bea/wlp/api
POST
/bea/wlp/api/book/move/bookorpage/{book definition label}
|
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 (starts with zero). After the moved Book or Page is given this position the entire position array must be normalized to ensure it is still zero-based and that it is contiguous with no missing positions. Therefore, the moved Book or Page will use this position and previously existing Books and Pages at and beyond this position will have their position incremented by one. After the position incrementing, the positions will be normalized to shift the lowest position to a zero value and shift any positions necessary to make them contiguous.
| ||
|
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 only. If username is specified, any operation will be done as an administrator (and will require admin privileges), affecting the specified username's customized Book instance. If username is omitted, any operation will be done as the logged-in user, affecting their own 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
|
/bea/wlp/api/book/move/bookorpage/book_1?label=myBook&webapp=myWebapp&desktop=myDesktop&scope=admin&position=2
<rsp/>
Copyright 2011, Oracle. All rights reserved.