Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Syntax

clonePageTree(sourcePageId, targetPageId, titlePrefix, copyPermissions)

...

Excerpt

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

stringYesID of the selected page to clone.
targetPageIdstringYesID of the target parent page. If the page is at the root level (top level) the parent page should be the spaces home page.
titlePrefixstringYesThe page name prefix to add to avoid conflicts.
copyPermissionsbooleanYesParameter to specify whether the page permissions should be cloned, true/false.

...

Returns true if pages and permissions are cloned successfully.

Example

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

...