Update Desktop

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

title

String

The new localized title of the Desktop.

{current value}

description

String

The new localized description of the Desktop.

{current value}

book

String

The new main Book definition label for the Desktop.

{current value}

shell

String

The new markup name of the Shell for the Desktop.

{current value}

lookandfeel

String

The new markup name of the Look and Feel for the Desktop.

{current value}

scope

String

The scope for the update operation, either the library definition, the primary admin instance or a specific visitor instance.

library
admin
visitor

admin

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 Desktop instance. If username is omitted, any 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.