Get Desktops

Retrieves list of all Desktops in the specified webapp.

Namespace

/bea/wlp/api

HTTP Method

GET

URI

/bea/wlp/api/desktop/list

Parameters

Parameter
Type
Description
Allowed Values
Default Value
webapp (required)
String
The webapp to list Desktops under.
format
String
The format of the results.
xml
json
xml
locale
String
The locale to use for the title and/or descriptions of the returned Desktops. Must be of the format: lang-country-variant ie. [nn], [nn-nn], or [nn-nn-nnnn].
Preferred locale from request.
max
Integer
The maximum number of Desktops to return.
50
start
Integer
The starting index for returned Desktops.
0

Input Example

/bea/wlp/api/desktop/list?webapp=myWebApp&locale=en

Return Example

<rsp>
   <desktop_summaries>
      <desktop_summary>
         <title>My Desktop 1</title>
         <description>This is My Desktop 1.</description>
         <webapp>/myWebApp</webapp>
         <portal>myPortal1</portal>
         <desktop>myDesktop1</desktop>
      </desktop_summary>
      <desktop_summary>
         <title>My Desktop 2</title>
         <description>This is My Desktop 2.</description>
         <webapp>/myWebApp</webapp>
         <portal>myPortal2</portal>
         <desktop>myDesktop2</desktop>
      </desktop_summary>
   </desktop_summaries>
</rsp>