v1

latestOpenAPI 3.0.12026-07-13130168404.3 KB
Content - children and descendants

Copy page hierarchy

Copy page hierarchy allows the copying of an entire hierarchy of pages and their associated properties, permissions and attachments. The id path parameter refers to the content id of the page to copy, and the new parent of this copied page is defined using the destinationPageId in the request body. The titleOptions object defines the rules of renaming page titles during the copy; for example, search and replace can be used in conjunction to rewrite the copied page titles.

Response example:

<pre><code> { "id" : "1180606", "links" : { "status" : "/rest/api/longtask/1180606" } } </code></pre>

Use the /longtask/<taskId> REST API to get the copy task status.

post/wiki/rest/api/content/{id}/pagehierarchy/copy

Path parameters

idstring required

Request body

copyAttachmentsboolean

If set to true, attachments are copied to the destination page.

copyPermissionsboolean

If set to true, page permissions are copied to the destination page.

copyPropertiesboolean

If set to true, content properties are copied to the destination page.

copyLabelsboolean

If set to true, labels are copied to the destination page.

copyCustomContentsboolean

If set to true, custom contents are copied to the destination page.

copyDescendantsboolean

If set to true, descendants are copied to the destination page.

destinationPageIdstring required

Response

Returns a full JSON representation of a long running task

aristring

the ARI for the long task, based on its ID

idstring required

a unique identifier for the long task