Create a new Book and add it to an existing Book. The destination Book is identified via its definition label, included as the last part of the URI path.
/bea/wlp/api
POST
/bea/wlp/api/book/add/new/book/{book definition label}
|
Parameter
|
Type
|
Description
|
Allowed Values
|
Default Value
|
|---|---|---|---|---|
|
webapp (required)
|
String
|
The webapp that contains both the destination Book and the Book to add.
| ||
|
format
|
String
|
The format of the results.
|
xml
json |
xml
|
|
book
|
String
|
The optional definition label for the new Book. If no label is specified, a unique label will be generated.
| ||
|
position
|
Integer
|
The position within the destination Book's menu to add the new Book.
|
0
|
|
|
title (required)
|
String
|
The title of the new Book.
| ||
|
description
|
String
|
A description of the new Book.
| ||
|
locale
|
String
|
The locale to use for the title and description of the new Book. Must be of the format: lang-country-variant ie. [nn], [nn-nn], or [nn-nn-nnnn].
|
Preferred locale from request.
|
|
|
menu
|
String
|
The markup name of the Menu to use for the newly created Book. If no Menu is specified, the Book will have not have a Menu.
| ||
|
theme
|
String
|
The optional markup name of the Theme to use for the newly created Book.
| ||
|
scope
|
String
|
The scope at which to perform the create add operation. Library scope adds the new Book to the library definition of a Book, admin adds it to the admin instance and visitor adds the new book to a user's Book instance.
|
library
admin visitor |
library
|
|
portal
|
String
|
For 'admin' or 'visitor' scope, the Portal that contains both Books.
| ||
|
desktop
|
String
|
For 'admin' or 'visitor' scope, the Desktop that contains both Books.
| ||
|
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.
| ||
|
is_public
|
Boolean
|
Whether or not the new Book should be public.
|
false
|
|
|
hidden
|
Boolean
|
Whether or not the new Book should be hidden.
|
false
|
|
|
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/new/book/book_1?webapp=myWebApp&book=newBook_1&title=My%20New%20Title&desktop=d1&portal=myPortal&menu=myMenu_1&theme=alert&is_public=true&hidden=false
<rsp>
<definition_label>newBook_1</definition_label>
</rsp>
Copyright 2011, Oracle. All rights reserved.