Oracle Fusion Middleware REST API Reference for Oracle WebLogic Portal
10g Release 3 (10.3.4)
E14258-03

Create Page and Add to Book

Create a new Page and add it to an existing Book. The book is identified by its definition label, supplied as the last part of the URI path.

Namespace

/bea/wlp/api

HTTP Method

POST

URI

/bea/wlp/api/book/add/new/page/{book definition label}

Parameters

Parameter
Type
Description
Allowed Values
Default Value
webapp (required)
String
The webapp that contains the Book and new Page.
format
String
The format of the results.
xml
json
xml
page
String
The optional definition label for the new Page. If no label is specified, a unique label will be generated.
position
Integer
The position within the Menu for the newly created Page. If this is set to -1, the new Page will be appended to the end of the Book's Menu.
0
title (required)
String
The title for the new Page.
description
String
The description for the new Page.
locale
String
The locale to use for the title and description of the new Page. Must be of the format: lang-country-variant ie. [nn], [nn-nn], or [nn-nn-nnnn].
Preferred locale from request.
layout
String
The markup name of the Layout to use for the new Page.
twoColumnFlowLayout
theme
String
The optional markup name of the Theme to use for the new Page.
scope
String
The scope of the add Page operation. If the scope is 'library', the Page will be added to the library definition of the Book, if 'admin', to the admin instance of the Book, and if 'visitor', to an individual user's customized instance of the Book.
library
admin
visitor
library
portal
String
For 'admin' or 'visitor' scope, the Portal that contains the Book.
desktop
String
For 'admin' or 'visitor' scope, the Desktop that contains the 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.
is_public
Boolean
Whether or not the new Page should be public.
false
hidden
Boolean
Whether or not the new Page 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

Input Example

/bea/wlp/api/book/add/new/page/book_1?webapp=myWebApp&page=newPage_1&title=My%20New%20Title&desktop=d1&portal=myPortal&layout=layout_1&theme=alert&is_public=true&hidden=false&position=0

Return Example

<rsp>
    <definition_label>newPage_1</definition_label>
</rsp>
Oracle Fusion Middleware REST API Reference for Oracle WebLogic Portal
10g Release 3 (10.3.4)
E14258-03

Copyright 2011, Oracle. All rights reserved.