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

Get Desktop

Gets the specified Desktop.

Namespace

/bea/wlp/api

HTTP Method

GET

URI

/bea/wlp/api/desktop/details

Parameters

Parameter
Type
Description
Allowed Values
Default Value
webapp (required)
String
The webapp that contains the Desktop.
portal (required)
String
The Portal that contains the Desktop.
desktop (required)
String
The name of the Desktop to retrieve.
format
String
The format of the results.
xml
json
xml
scope
String
The scope at which to get the Desktop.
library
admin
visitor
library
username
String
For 'visitor' scope only. If username is specified, the operation will be done as an administrator (and will require admin privileges), returning the specified username's customized Desktop instance. If username is omitted, the operation will be done as the logged-in user, affecting their own Desktop instance.
Currently logged in user.
locale
String
The locale to use for the new title and/or description of the Desktop. 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/desktop/details?webapp=myWebApp&portal=myPortalPath&desktop=myDesktopPath&locale=en-us&scope=library

Return Example

<rsp>
   <title>My Desktop</title>
   <description>This is My Desktop.</description>
   <webapp>/myWebApp</webapp>
   <modified_date>2007-12-13 10:23:09.0</modified_date>
   <created_date>2007-12-13 10:23:09.0</created_date>
   <book>mainBook</book>
   <shell>headerFooter</shell>
   <lookandfeel>bighornLookAndFeel</lookandfeel>
   <tree_optimization>false</tree_optimization>
   <template>false</template>
   <global>false</global>
   <async_mode>compat_9_2</async_mode>
   <scroll_to_window>false</scroll_to_window>
   <disc>false</disc>
   <dvt>false</dvt>
</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.