Enumeration Members

AllChildTypes: "childTypes.all"

Returns whether the content has attachments, comments, or child pages. Use this if you only need to check whether the content has children of a particular type.

Ancestors: "ancestors"

Returns the parent page, if the content is a page.

AttachmentChildType: "childTypes.attachment"

Returns whether the content has attachments.

AttachmentChildren: "children.attachment"

Returns all attachments for the content.

AttachmentDescendant: "descendants.attachment"

Returns all attachments for the content, same as children.attachment.

Body: "body"

Returns the body of the content in different formats, including the editor format, view format, and export format.

CommentChildType: "childTypes.comment"

Returns whether the content has comments.

CommentChildren: "children.comment"

Returns all comments on the content.

CommentDescendant: "descendants.comment"

Returns all comments on the content, same as children.comment.

Container: "container"

Returns the space that the content is in. This is the same as the information returned by Get space.

Contributors: "history.contributors"

Returns all of the users who have contributed to the content.

CurrentUserMetadata: "metadata.currentuser"

Returns information about the current user in relation to the content, including when they last viewed it, modified it, contributed to it, or added it as a favorite.

FrontendMetadata: "metadata.frontend"

This property is only used by Atlassian.

History: "history"

Returns the history of the content, including the date it was created.

InlineProperties: "extensions.inlineProperties"

Returns inline comment-specific properties.

LabelsMetadata: "metadata.labels"

Returns the labels that have been added to the content.

LastUpdated: "history.lastUpdated"

Returns information about the most recent update of the content, including who updated it and when it was updated.

NextVersion: "history.nextVersion"

Returns information about the update after to the current content update.

Operations: "operations"

Returns the operations for the content, which are used when setting permissions.

PageChildType: "childTypes.page"

Returns whether the content has child pages.

PageChildren: "children.page"

Returns pages that are descendants at the level immediately below the content.

PageDescendant: "descendants.page"

Returns pages that are descendants at any level below the content.

PreviousVersion: "history.previousVersion"

Returns information about the update prior to the current content update.

PropertiesMetadata: "metadata.properties"

Returns content properties that have been set via the Confluence REST API.

ReadGroupRestriction: "restrictions.read.restrictions.group"

Returns the groups that have permission to read the content. Note that this may return deleted groups, because deleting a group doesn't remove associated restrictions.

ReadUserRestriction: "restrictions.read.restrictions.user"

Returns the users that have permission to read the content.

Resolution: "extensions.resolution"

Returns the resolution status of each comment.

Space: "space"

Returns the space that the content is in. This is the same as the information returned by Get space.

UpdateGroupRestriction: "restrictions.update.restrictions.group"

Returns the groups that have permission to update the content. Note that this may return deleted groups because deleting a group doesn't remove associated restrictions.

UpdateUserRestriction: "restrictions.update.restrictions.user"

Returns the users that have permission to update the content.

Version: "version"

Returns information about the most recent update of the content, including who updated it and when it was updated.

Generated using TypeDoc v0.25.12