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

Import Desktop

Import a new portal file and update or create a desktop. If the desktop already exists merge the changes based off of the supplied rules.

Namespace

/bea/wlp/api

HTTP Method

POST

URI

/bea/wlp/api/desktop/import

Parameters

Parameter
Type
Description
Allowed Values
Default Value
webapp (required)
String
The webapp in which to create the desktop.
portal (required)
String
The portal path in which to create the desktop, if the portal path does not already exist it will be created if createPortal is true.
desktop (required)
String
The desktop path for this desktop.
portalFile (required)
String
The .portal used to create or re-import the desktop from.
deletes
Boolean
When re-importing remove portlets from existing desktop not in the .portal.
true
moves
Boolean
When re-importing move pages (on the same book) in the desktop to reflect positions in the .portal.
true
outerMoves
Boolean
When re-importing move pages (to different books) in the desktop to reflect positions in the .portal.
true
updates
Boolean
When re-importing perform updates and adds to desktops, books, pages, portlets.
abortIfPortletMissing
Boolean
Abort the process if a referenced .portlet is missing from the war.
createPortal
Boolean
Create a portal with the supplied portal path if one doesn't already exist.
true
portalTitle
String
Use this portal title if creating a portal.
portal path
proliferation
String
For move, add and delete operations whether or not the operation should be cascaded to successors (end users).
sync
async
off
sync
encoding
String
encoding of the portal file.
UTF-8

Input Example

/bea/wlp/api/desktop/import?webapp=myWebApp&portal=myportalpath&desktop=mydesktoppath&portalFile=/myportal.portal

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.