Private clientCopies a single page and its associated properties, permissions, attachments, and custom contents. The id path
parameter refers to the content ID of the page to copy. The target of the page to be copied is defined using the
destination in the request body and can be one of the following types.
space: page will be copied to the specified space as a root page on the spaceparent_page: page will be copied as a child of the specified parent pageexisting_page: page will be copied and replace the specified pageBy default, the following objects are expanded: space, history, version.
Permissions required: 'Add' permission for the space that the
content will be copied in and permission to update the content if copying to an existing_page.
Optional callback: undefinedCopy 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.
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.
Optional callback: undefinedThis API will be removed in the next major version. Use getDescendantsOfType method instead.
Optional callback: undefinedThis API will be removed in the next major version. Use getDescendantsOfType method instead.
Returns a map of the direct children of a piece of content. A piece of content has different types of child content, depending on its type. These are the default parent-child content type relationships:
page: child content is page, comment, attachmentblogpost: child content is comment, attachmentattachment: child content is commentcomment: child content is attachmentApps can override these default relationships. Apps can also introduce new content types that create new parent-child content relationships.
Note, the map will always include all child content types that are valid for the content. However, if the content has no instances of a child content type, the map will contain an empty array for that child content type.
Permissions required: 'View' permission for the space, and permission to view the content if it is a page.
Returns a map of the direct children of a piece of content. A piece of content has different types of child content, depending on its type. These are the default parent-child content type relationships:
page: child content is page, comment, attachmentblogpost: child content is comment, attachmentattachment: child content is commentcomment: child content is attachmentApps can override these default relationships. Apps can also introduce new content types that create new parent-child content relationships.
Note, the map will always include all child content types that are valid for the content. However, if the content has no instances of a child content type, the map will contain an empty array for that child content type.
Permissions required: 'View' permission for the space, and permission to view the content if it is a page.
Optional callback: undefinedReturns all children of a given type, for a piece of content. A piece of content has different types of child content, depending on its type:
page: child content is page, comment, attachmentblogpost: child content is comment, attachmentattachment: child content is commentcomment: child content is attachmentCustom content types that are provided by apps can also be returned.
Note, this method only returns direct children. To return children at all levels, use Get descendants by type.
Permissions required: 'View' permission for the space, and permission to view the content if it is a page.
Returns all children of a given type, for a piece of content. A piece of content has different types of child content, depending on its type:
page: child content is page, comment, attachmentblogpost: child content is comment, attachmentattachment: child content is commentcomment: child content is attachmentCustom content types that are provided by apps can also be returned.
Note, this method only returns direct children. To return children at all levels, use Get descendants by type.
Permissions required: 'View' permission for the space, and permission to view the content if it is a page.
Optional callback: undefinedReturns a map of the descendants of a piece of content. This is similar to Get content children, except that this method returns child pages at all levels, rather than just the direct child pages.
A piece of content has different types of descendants, depending on its type:
page: descendant is page, comment, attachmentblogpost: descendant is comment, attachmentattachment: descendant is commentcomment: descendant is attachmentThe map will always include all descendant types that are valid for the content. However, if the content has no instances of a descendant type, the map will contain an empty array for that descendant type.
Permissions required: 'View' permission for the space, and permission to view the content if it is a page.
Returns a map of the descendants of a piece of content. This is similar to Get content children, except that this method returns child pages at all levels, rather than just the direct child pages.
A piece of content has different types of descendants, depending on its type:
page: descendant is page, comment, attachmentblogpost: descendant is comment, attachmentattachment: descendant is commentcomment: descendant is attachmentThe map will always include all descendant types that are valid for the content. However, if the content has no instances of a descendant type, the map will contain an empty array for that descendant type.
Permissions required: 'View' permission for the space, and permission to view the content if it is a page.
Optional callback: undefinedReturns all descendants of a given type, for a piece of content. This is similar to Get content children by type, except that this method returns child pages at all levels, rather than just the direct child pages.
A piece of content has different types of descendants, depending on its type:
page: descendant is page, comment, attachmentblogpost: descendant is comment, attachmentattachment: descendant is commentcomment: descendant is attachmentCustom content types that are provided by apps can also be returned.
Permissions required: 'View' permission for the space, and permission to view the content if it is a page.
Returns all descendants of a given type, for a piece of content. This is similar to Get content children by type, except that this method returns child pages at all levels, rather than just the direct child pages.
A piece of content has different types of descendants, depending on its type:
page: descendant is page, comment, attachmentblogpost: descendant is comment, attachmentattachment: descendant is commentcomment: descendant is attachmentCustom content types that are provided by apps can also be returned.
Permissions required: 'View' permission for the space, and permission to view the content if it is a page.
Optional callback: undefinedMove a page to a new location relative to a target page:
before - move the page under the same parent as the target, before the target in the list of childrenafter - move the page under the same parent as the target, after the target in the list of childrenappend - move the page to be a child of the targetCaution: This API can move pages to the top level of a space. Top-level pages are difficult to find in the UI
because they do not show up in the page tree display. To avoid this, never use before or after positions when
the targetId is a top-level page.
Move a page to a new location relative to a target page:
before - move the page under the same parent as the target, before the target in the list of childrenafter - move the page under the same parent as the target, after the target in the list of childrenappend - move the page to be a child of the targetCaution: This API can move pages to the top level of a space. Top-level pages are difficult to find in the UI
because they do not show up in the page tree display. To avoid this, never use before or after positions when
the targetId is a top-level page.
Optional callback: undefinedGenerated using TypeDoc v0.25.12
Copies a single page and its associated properties, permissions, attachments, and custom contents. The
idpath parameter refers to the content ID of the page to copy. The target of the page to be copied is defined using thedestinationin the request body and can be one of the following types.space: page will be copied to the specified space as a root page on the spaceparent_page: page will be copied as a child of the specified parent pageexisting_page: page will be copied and replace the specified pageBy default, the following objects are expanded:
space,history,version.Permissions required: 'Add' permission for the space that the content will be copied in and permission to update the content if copying to an
existing_page.