Adds an existing Book to a Book. The destination Book label is specified as the last part of the URI path.
/bea/wlp/api
POST
/bea/wlp/api/book/add/book/{book definition label}
|
Parameter
|
Type
|
Description
|
Allowed Values
|
Default Value
|
|---|---|---|---|---|
|
webapp (required)
|
String
|
The webapp that contains the Book definition.
| ||
|
format
|
String
|
The format of the results.
|
xml
json |
xml
|
|
book (required)
|
String
|
The definition label of the Book to add.
| ||
|
position
|
Integer
|
The position within the Book to add the new Book. If position is -1, this will append the new Book to the end of all Books and Pages within the Book.
|
0
|
|
|
scope
|
String
|
The scope level 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 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.
| ||
|
default
|
Boolean
|
Whether or not the newly added Book should be the default 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
|
/bea/wlp/api/book/add/book/book_1?webapp=myWebApp&book=book_2&position=-1&scope=visitor&desktop=d1&portal=myPortal&username=Bob
<rsp/>
Copyright 2011, Oracle. All rights reserved.