Update Book

Updates an existing Book with any of the supplied optional information about the Book. The Book to update is specified by definition label, placed at the end of the URI path.

Namespace

/bea/wlp/api

HTTP Method

POST

URI

/bea/wlp/api/book/item/{book definition label}

Parameters

Parameter
Type
Description
Allowed Values
Default Value
webapp (required)
String
The webapp that contains the Book to update.
format
String
The format of the results.
xml
json
xml
menu
String
The markup name of the Menu to use for the 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 Book.
title
String
The updated title for the Book.
description
String
The updated description for the Book.
locale
String
The locale to use for the updated title and description of the Book. Must be of the format: lang-country-variant ie. [nn], [nn-nn], or [nn-nn-nnnn].
Preferred locale from request.
scope
String
The scope at which to update the Book.
library
admin
visitor
library
portal
String
For 'admin' or 'visitor' scope, the Portal that contains the Book to update.
desktop
String
For 'admin' or 'visitor' scope, the Desktop that contains the Book to update.
username
String
For 'visitor' scope, the username of the owner of the customized Book instance.
is_public
Boolean
Specifies whether or not the Book should be marked public.
hidden
Boolean
Specifies whether or not the Book should be hidden.

Input Example

/bea/wlp/api/book/item/book_1?webapp=myWebApp&title=My%20New%20Title&scope=visitor&desktop=d1&portal=myPortal&username=Bob

Return Example

<rsp/>