Retrieves information about a single Portlet, specified by definition or instance label
/bea/wlp/api
GET
/bea/wlp/api/portlet/details/{portlet definition or instance label}
Parameter
|
Type
|
Description
|
Allowed Values
|
Default Value
|
---|---|---|---|---|
webapp (required)
|
String
|
The webapp that contains the Portlet.
| ||
format
|
String
|
The format of the results.
|
xml
json |
xml
|
scope
|
String
|
The scope at which to get 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, the username of the owner of the customized Portlet instance.
| ||
locale
|
String
|
The locale to use for the title and/or description of the returned Portlet. Must be of the format: lang-country-variant ie. [nn], [nn-nn], or [nn-nn-nnnn].
|
Preferred locale from request.
|
/bea/wlp/api/portlet/details/portlet_123?webapp=myWebApp&portal=myPortalPath&desktop=myDesktopPath&locale=en-us&scope=library
<rsp> <title>My Portlet</title> <description>My Portlet</description> <content_uri>/portlets/Portlet1/my_portlet.jsp</content_uri> <forkable>false</forkable> <fork_render>false</fork_render> <is_public>true</is_public> <cacheable>false</cacheable> <cache_expires>-1</cache_expires> <portlet_file>/portlets/Portlet1/Portlet1.portlet</portlet_file> <deleted>false</deleted> <webapp>/myWebApp</webapp> <wsrp_user_properties_mode>3</wsrp_user_properties_mode> <state_change_flag>2</state_change_flag> <requires_url_templates>false</requires_url_templates> <templates_stored_in_session>false</templates_stored_in_session> <producer_offered_portlet>true</producer_offered_portlet> <created_date>2007-12-13 15:22:25.0</created_date> <modified_date>2007-12-13 15:22:25.0</modified_date> </rsp>