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

Update Portlet

Updates all or part of an existing Portlet definition or instance, depending on scope.

Namespace

/bea/wlp/api

HTTP Method

POST

URI

/bea/wlp/api/portlet/item/{portlet definition or instance label}

Parameters

Parameter
Type
Description
Allowed Values
Default Value
webapp (required)
String
The webapp that contains the Portlet.
scope
String
The scope at which to update the Portlet.
library
admin
visitor
library
portal
String
For 'admin' or 'visitor' scope, the Portal the Portlet instance is contained in.
desktop
String
For 'admin' or 'visitor' scope, the Desktop the Portlet instance is contained in.
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 Portlet instance. If username is omitted, any operation will be done as the logged-in user, affecting their own Portlet instance.
title
String
The new localized title of the Portlet.
content_uri
String
The new content URI of the Portlet.
type
String
The new type of the Portlet.
jsp
jsf
jsr168
jpf
uri
struts
description
String
The new localized description of the Portlet.
backing_file
String
The optional new backing file for the Portlet.
action
String
The optional new struts or JPF action for the Portlet.
forkable
Boolean
Specifies whether the Portlet will be forkable (ie. thread safe).
fork_render
Boolean
Specifies whether the Portlet will run in its own thread during the Portal render phase.
is_public
Boolean
Specifies whether the Portlet will be visible to everyone.
cacheable
Boolean
Specifies whether the Portlet can be cached.
cache_expires
Integer
Specifies the Portlet's cache expiration time in seconds
portlet_file
String
The optional new Portlet file associated with the Portlet.
laf_dependencies_uri
String
The optional new Look and Feel dependency file associated with the new Portlet.
help_uri
String
The optional new Help mode URI of the Portlet.
edit_uri
String
The optional new Edit mode URI of the Portlet.
floatable
Boolean
Specifies whether the Portlet is able to be floated.
minimizable
Boolean
Specifies whether the Portlet is able to be minimized.
maximizable
Boolean
Specifies whether the Portlet is able to be maximized.
deletable
Boolean
Specifies whether the Portlet is able to be deleted.
theme
String
The optional new Theme of the Portlet.
locale
String
The locale to use for the new title/description of the Portlet. Must be of the format: lang-country-variant ie. [nn], [nn-nn], or [nn-nn-nnnn].
Preferred locale from request.

Input Example

/bea/wlp/api/portlet/item/portlet_123?webapp=myWebApp&scope=library&title=New%20Title&locale=en-us&maximizable=false

Return Example

<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.