Add Portlet To Page

Adds a Portlet to a Page, in a specified placeholder at a specified index within the placeholder. The Page is identified by its definition label, included as the last part of the URI path.

Namespace

/bea/wlp/api

HTTP Method

POST

URI

/bea/wlp/api/page/add/portlet/{page definition label}

Parameters

Parameter
Type
Description
Allowed Values
Default Value
webapp (required)
String
The webapp that contains the Page.
portlet (required)
String
The definition label of the Portlet to add to the Page.
placeholder
Integer
The placeholder within the Page to add the Portlet to.
0
position
Integer
The position index within the placeholder to insert the Portlet at.
0
scope
String
The scope at which to perform the addition operation, either the library definition, the admin instance, or to a visitor's customized instance.
library
admin
visitor
library
desktop
String
If 'admin' or 'visitor' scope, the Desktop that contains the Page.
portal
String
If 'admin' or 'visitor' scope, the Portal that contains the Page.
username
String
For visitor scope, the username of the visitor that owns the Page instance.
proliferation
String
For 'library' or 'admin' scope, whether or not the Portlet addition operation should be cascaded to derived Page instances.
sync
async
off
async

Input Example

/bea/wlp/api/page/add/portlet/page_1?portlet=myPortlet&webapp=myWebapp&portal=myPortal&desktop=myDesktop&placeholder=1&position=2&scope=admin

Return Example

<rsp>
   <instance_label>newInstanceLabel123</instance_label>
</rsp>