com.atlassian.confluence.plugins.restapi.resources

Class PageHierarchyResource

java.lang.Object

com.atlassian.confluence.plugins.restapi.resources.PageHierarchyResource

public class PageHierarchyResource
extends Object

Constructor Summary

Constructors

Constructor and Description
PageHierarchyResource(PageHierarchyService pageHierarchyService)

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	copyPageHierarchy(ContentId id, CopyPageHierarchyRequest request) Copy page hierarchy allows the copying of an entire hierarchy of pages and their associated properties, permissions and attachments.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PageHierarchyResource

public PageHierarchyResource(PageHierarchyService pageHierarchyService)

Method Detail

copyPageHierarchy

public javax.ws.rs.core.Response copyPageHierarchy(ContentId id,
                                                   CopyPageHierarchyRequest request)
                                            throws ServiceException

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:

 {
      "id" : "1180606",
      "links" : {
           "status" : "/rest/api/longtask/1180606"
      }
 }
 

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

Parameters:

request - Request object from json post body

Returns:

a JSON representation of a long task

Throws:

ServiceException