WLP REST API: Move Book on Page

Moves a Book on a Page, to a location specified by placeholder and position indices. The Page is identified by its definition label, included as the last part of the URI path.

Parameter	Type	Description	Allowed Values	Default Value
webapp (required)	String	The webapp that contains the Page.
format	String	The format of the results.	xml json	xml
book (required)	String	The definition label of the Book to move on the Page.
placeholder	Integer	The destination placeholder within the Page to move the Book to.		0
position	Integer	The position within the placeholder to move the Book to (starts with zero). After the moved Book is given this position the entire position array must be normalized to ensure it is still zero-based and that it is contiguous with no missing positions. Therefore, the moved Book will use this position and previously existing Books at and beyond this position will have their position incremented by one. After the position incrementing, the positions will be normalized to shift the lowest position to a zero value and shift any positions necessary to make them contiguous.		0
scope (required)	String	The scope at which to perform the move operation, one of to the library definition, the admin instance, or a visitor's customized instance.	library admin visitor	library
portal	String	For 'admin' or 'visitor' scope, the Portal that contains the Page.
desktop	String	For 'admin' or 'visitor' scope, the Desktop that contains the Page.
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 Page instance. If username is omitted, any operation will be done as the logged-in user, affecting their own Page instance.
proliferation	String	For 'library' or 'admin' scope, whether or not the move operation should be cascaded to derived Page instances.	sync async off	async

Parameter

Type

Description

Allowed Values

Default Value

webapp (required)

String

The webapp that contains the Page.

format

String

The format of the results.

xml
json

xml

book (required)

String

The definition label of the Book to move on the Page.

placeholder

Integer

The destination placeholder within the Page to move the Book to.

position

Integer

The position within the placeholder to move the Book to (starts with zero). After the moved Book is given this position the entire position array must be normalized to ensure it is still zero-based and that it is contiguous with no missing positions. Therefore, the moved Book will use this position and previously existing Books at and beyond this position will have their position incremented by one. After the position incrementing, the positions will be normalized to shift the lowest position to a zero value and shift any positions necessary to make them contiguous.

scope (required)

String

The scope at which to perform the move operation, one of to the library definition, the admin instance, or a visitor's customized instance.

library
admin
visitor

library

portal

String

For 'admin' or 'visitor' scope, the Portal that contains the Page.

desktop

String

For 'admin' or 'visitor' scope, the Desktop that contains the Page.

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 Page instance. If username is omitted, any operation will be done as the logged-in user, affecting their own Page instance.

proliferation

String

For 'library' or 'admin' scope, whether or not the move operation should be cascaded to derived Page instances.

sync
async
off

async

Move Book on Page

Namespace

HTTP Method

URI

Parameters

Input Example

Return Example