clonePageTree

Syntax

clonePageTree(sourcePageId, targetPageId, titlePrefix, copyPermissions)

Description

Clones the page tree with its permissions.

Some examples of routine behavior:

If the name (prefix + source page name) matches the name of any page in this space - copying does not occur, returns false and writes an error to the logs;
If the name (prefix + source page name) of the source page does not match the name of any page in this space, but the names (prefix + name of the child page of the source) of its child pages match any other page in the space, all pages whose names don't match with other page names are copied;
If nothing matches, the whole page tree will be copied.

Parameters

Parameter name	Type	Required	Description
`sourcePageId`	`string`	Yes	ID of the selected page to clone.
`targetPageId`	`string`	Yes	ID of the target parent page. If the page is at the root level (top level) the parent page should be the spaces home page.
`titlePrefix`	`string`	Yes	The page name prefix to add to avoid conflicts.
`copyPermissions`	`boolean`	Yes	Parameter to specify whether the page permissions should be cloned, true/false.

Return type

boolean(true/false)

Returns true if pages and permissions are cloned successfully.

Example

number targetPageId = 11003;
string titlePrefix = "Copy of ";
boolean copyPermissions = true;
return clonePageTree(sourcePageId, targetPageId, titlePrefix, copyPermissions);