Package io.github.primelib.confluence4j.rest.v2.api

Schnittstelle ConfluenceRESTV2AsyncApi

@Generated("io.github.primelib.primecodegen.javafeign.JavaFeignGenerator")
public interface ConfluenceRESTV2AsyncApi

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
CompletableFuture<CheckAccessByEmail200Response>	checkAccessByEmail(@NotNull CheckAccessByEmailRequest checkAccessByEmailRequest)	Check site access for a list of emails
CompletableFuture<ContentIdToContentTypeResponse>	convertContentIdsToContentTypes(@NotNull ConvertContentIdsToContentTypesRequest convertContentIdsToContentTypesRequest)	Convert content ids to content types
CompletableFuture<ContentProperty>	createAttachmentProperty(@NotNull String attachmentId, @NotNull ContentPropertyCreateRequest contentPropertyCreateRequest)	Create content property for attachment
CompletableFuture<BlogPostSingle>	createBlogPost(@NotNull CreateBlogPostRequest createBlogPostRequest, @Nullable Boolean _private)	Create blog post
CompletableFuture<ContentProperty>	createBlogpostProperty(@NotNull Long blogpostId, @NotNull ContentPropertyCreateRequest contentPropertyCreateRequest)	Create content property for blog post
CompletableFuture<ContentProperty>	createCommentProperty(@NotNull Long commentId, @NotNull ContentPropertyCreateRequest contentPropertyCreateRequest)	Create content property for comment
CompletableFuture<CustomContentSingle>	createCustomContent(@NotNull CreateCustomContentRequest createCustomContentRequest)	Create custom content
CompletableFuture<ContentProperty>	createCustomContentProperty(@NotNull Long customContentId, @NotNull ContentPropertyCreateRequest contentPropertyCreateRequest)	Create content property for custom content
CompletableFuture<FooterCommentModel>	createFooterComment(@NotNull CreateFooterCommentModel createFooterCommentModel)	Create footer comment
CompletableFuture<InlineCommentModel>	createInlineComment(@NotNull CreateInlineCommentModel createInlineCommentModel)	Create inline comment
CompletableFuture<PageSingle>	createPage(@NotNull CreatePageRequest createPageRequest, @Nullable Boolean embedded, @Nullable Boolean _private, @Nullable Boolean rootLevel)	Create page
CompletableFuture<ContentProperty>	createPageProperty(@NotNull Long pageId, @NotNull ContentPropertyCreateRequest contentPropertyCreateRequest)	Create content property for page
CompletableFuture<SpaceProperty>	createSpaceProperty(@NotNull Long spaceId, @NotNull SpacePropertyCreateRequest spacePropertyCreateRequest)	Create space property in space
CompletableFuture<WhiteboardSingle>	createWhiteboard(@NotNull CreateWhiteboardRequest createWhiteboardRequest, @Nullable Boolean _private)	Create whiteboard
CompletableFuture<ContentProperty>	createWhiteboardProperty(@NotNull Long id, @NotNull ContentPropertyCreateRequest contentPropertyCreateRequest)	Create content property for whiteboard
CompletableFuture<Void>	deleteAttachment(@NotNull Long id, @Nullable Boolean purge)	Delete attachment
CompletableFuture<Void>	deleteAttachmentPropertyById(@NotNull String attachmentId, @NotNull Long propertyId)	Delete content property for attachment by id
CompletableFuture<Void>	deleteBlogPost(@NotNull Long id, @Nullable Boolean purge, @Nullable Boolean draft)	Delete blog post
CompletableFuture<Void>	deleteBlogpostPropertyById(@NotNull Long blogpostId, @NotNull Long propertyId)	Delete content property for blogpost by id
CompletableFuture<Void>	deleteCommentPropertyById(@NotNull Long commentId, @NotNull Long propertyId)	Delete content property for comment by id
CompletableFuture<Void>	deleteCustomContent(@NotNull Long id, @Nullable Boolean purge)	Delete custom content
CompletableFuture<Void>	deleteCustomContentPropertyById(@NotNull Long customContentId, @NotNull Long propertyId)	Delete content property for custom content by id
CompletableFuture<Void>	deleteFooterComment(@NotNull Long commentId)	Delete footer comment
CompletableFuture<Void>	deleteInlineComment(@NotNull Long commentId)	Delete inline comment
CompletableFuture<Void>	deletePage(@NotNull Long id, @Nullable Boolean purge, @Nullable Boolean draft)	Delete page
CompletableFuture<Void>	deletePagePropertyById(@NotNull Long pageId, @NotNull Long propertyId)	Delete content property for page by id
CompletableFuture<Void>	deleteSpacePropertyById(@NotNull Long spaceId, @NotNull Long propertyId)	Delete space property by id
CompletableFuture<Void>	deleteWhiteboard(@NotNull Long id)	Delete whiteboard
CompletableFuture<Void>	deleteWhiteboardPropertyById(@NotNull Long whiteboardId, @NotNull Long propertyId)	Delete content property for whiteboard by id
CompletableFuture<Attachment>	getAttachmentById(@NotNull String id, @Nullable Integer version)	Get attachment by id
CompletableFuture<MultiEntityResultAttachmentCommentModel>	getAttachmentComments(@NotNull String id, @Nullable PrimaryBodyRepresentation bodyFormat, @Nullable String cursor, @Nullable Integer limit, @Nullable CommentSortOrder sort)	Get attachment comments
CompletableFuture<MultiEntityResultContentProperty>	getAttachmentContentProperties(@NotNull String attachmentId, @Nullable String key, @Nullable ContentPropertySortOrder sort, @Nullable String cursor, @Nullable Integer limit)	Get content properties for attachment
CompletableFuture<ContentProperty>	getAttachmentContentPropertiesById(@NotNull String attachmentId, @NotNull Long propertyId)	Get content property for attachment by id
CompletableFuture<MultiEntityResultLabel>	getAttachmentLabels(@NotNull Long id, @Nullable String prefix, @Nullable List<LabelSortOrder> sort, @Nullable String cursor, @Nullable Integer limit)	Get labels for attachment
CompletableFuture<PermittedOperationsResponse>	getAttachmentOperations(@NotNull String id)	Get permitted operations for attachment
CompletableFuture<MultiEntityResultAttachment>	getAttachments(@Nullable AttachmentSortOrder sort, @Nullable String cursor, @Nullable List<String> status, @Nullable String mediaType, @Nullable String filename, @Nullable Integer limit)	Get attachments
CompletableFuture<DetailedVersion>	getAttachmentVersionDetails(@NotNull String attachmentId, @NotNull Long versionNumber)	Get version details for attachment version
CompletableFuture<MultiEntityResultVersion>	getAttachmentVersions(@NotNull String id, @Nullable String cursor, @Nullable Integer limit, @Nullable VersionSortOrder sort)	Get attachment versions
CompletableFuture<MultiEntityResultAttachment>	getBlogpostAttachments(@NotNull Long id, @Nullable AttachmentSortOrder sort, @Nullable String cursor, @Nullable List<String> status, @Nullable String mediaType, @Nullable String filename, @Nullable Integer limit)	Get attachments for blog post
CompletableFuture<BlogPostSingle>	getBlogPostById(@NotNull Long id, @Nullable PrimaryBodyRepresentationSingle bodyFormat, @Nullable Boolean getDraft, @Nullable Integer version)	Get blog post by id
CompletableFuture<MultiEntityResultContentProperty>	getBlogpostContentProperties(@NotNull Long blogpostId, @Nullable String key, @Nullable ContentPropertySortOrder sort, @Nullable String cursor, @Nullable Integer limit)	Get content properties for blog post
CompletableFuture<ContentProperty>	getBlogpostContentPropertiesById(@NotNull Long blogpostId, @NotNull Long propertyId)	Get content property for blog post by id
CompletableFuture<MultiEntityResultBlogPostCommentModel>	getBlogPostFooterComments(@NotNull Long id, @Nullable PrimaryBodyRepresentation bodyFormat, @Nullable CommentSortOrder sort, @Nullable String cursor, @Nullable Integer limit)	Get footer comments for blog post
CompletableFuture<MultiEntityResultBlogPostInlineCommentModel>	getBlogPostInlineComments(@NotNull Long id, @Nullable PrimaryBodyRepresentation bodyFormat, @Nullable CommentSortOrder sort, @Nullable String cursor, @Nullable Integer limit)	Get inline comments for blog post
CompletableFuture<MultiEntityResultLabel>	getBlogPostLabels(@NotNull Long id, @Nullable String prefix, @Nullable List<LabelSortOrder> sort, @Nullable String cursor, @Nullable Integer limit)	Get labels for blog post
CompletableFuture<Integer>	getBlogPostLikeCount(@NotNull Long id)	Get like count for blog post
CompletableFuture<MultiEntityResultString>	getBlogPostLikeUsers(@NotNull Long id, @Nullable String cursor, @Nullable Integer limit)	Get account IDs of likes for blog post
CompletableFuture<PermittedOperationsResponse>	getBlogPostOperations(@NotNull Long id)	Get permitted operations for blog post
CompletableFuture<MultiEntityResultBlogPost>	getBlogPosts(@Nullable List<Long> id, @Nullable List<Long> spaceId, @Nullable BlogPostSortOrder sort, @Nullable List<String> status, @Nullable String title, @Nullable PrimaryBodyRepresentation bodyFormat, @Nullable String cursor, @Nullable Integer limit)	Get blog posts
CompletableFuture<MultiEntityResultBlogPost>	getBlogPostsInSpace(@NotNull Long id, @Nullable BlogPostSortOrder sort, @Nullable List<String> status, @Nullable String title, @Nullable PrimaryBodyRepresentation bodyFormat, @Nullable String cursor, @Nullable Integer limit)	Get blog posts in space
CompletableFuture<DetailedVersion>	getBlogPostVersionDetails(@NotNull Long blogpostId, @NotNull Long versionNumber)	Get version details for blog post version
CompletableFuture<MultiEntityResultVersion1>	getBlogPostVersions(@NotNull Long id, @Nullable PrimaryBodyRepresentation bodyFormat, @Nullable String cursor, @Nullable Integer limit, @Nullable VersionSortOrder sort)	Get blog post versions
CompletableFuture<MultiEntityResultChildCustomContent>	getChildCustomContent(@NotNull Long id, @Nullable String cursor, @Nullable Integer limit, @Nullable List<ChildCustomContentSortOrder> sort)	Get child custom content
CompletableFuture<MultiEntityResultChildPage>	getChildPages(@NotNull Long id, @Nullable String cursor, @Nullable Integer limit, @Nullable List<ChildPageSortOrder> sort)	Get child pages
CompletableFuture<MultiEntityResultContentProperty>	getCommentContentProperties(@NotNull Long commentId, @Nullable String key, @Nullable ContentPropertySortOrder sort, @Nullable String cursor, @Nullable Integer limit)	Get content properties for comment
CompletableFuture<ContentProperty>	getCommentContentPropertiesById(@NotNull Long commentId, @NotNull Long propertyId)	Get content property for comment by id
CompletableFuture<MultiEntityResultAttachment>	getCustomContentAttachments(@NotNull Long id, @Nullable AttachmentSortOrder sort, @Nullable String cursor, @Nullable List<String> status, @Nullable String mediaType, @Nullable String filename, @Nullable Integer limit)	Get attachments for custom content
CompletableFuture<CustomContentSingle>	getCustomContentById(@NotNull Long id, @Nullable CustomContentBodyRepresentationSingle bodyFormat, @Nullable Integer version)	Get custom content by id
CompletableFuture<MultiEntityResultCustomContent>	getCustomContentByType(@NotNull String type, @Nullable List<Long> id, @Nullable List<Long> spaceId, @Nullable CustomContentSortOrder sort, @Nullable String cursor, @Nullable Integer limit, @Nullable CustomContentBodyRepresentation bodyFormat)	Get custom content by type
CompletableFuture<MultiEntityResultCustomContent>	getCustomContentByTypeInBlogPost(@NotNull Long id, @NotNull String type, @Nullable CustomContentSortOrder sort, @Nullable String cursor, @Nullable Integer limit, @Nullable CustomContentBodyRepresentation bodyFormat)	Get custom content by type in blog post
CompletableFuture<MultiEntityResultCustomContent>	getCustomContentByTypeInPage(@NotNull Long id, @NotNull String type, @Nullable CustomContentSortOrder sort, @Nullable String cursor, @Nullable Integer limit, @Nullable CustomContentBodyRepresentation bodyFormat)	Get custom content by type in page
CompletableFuture<MultiEntityResultCustomContent>	getCustomContentByTypeInSpace(@NotNull Long id, @NotNull String type, @Nullable String cursor, @Nullable Integer limit, @Nullable CustomContentBodyRepresentation bodyFormat)	Get custom content by type in space
CompletableFuture<MultiEntityResultCustomContentCommentModel>	getCustomContentComments(@NotNull Long id, @Nullable PrimaryBodyRepresentation bodyFormat, @Nullable String cursor, @Nullable Integer limit, @Nullable CommentSortOrder sort)	Get custom content comments
CompletableFuture<MultiEntityResultContentProperty>	getCustomContentContentProperties(@NotNull Long customContentId, @Nullable String key, @Nullable ContentPropertySortOrder sort, @Nullable String cursor, @Nullable Integer limit)	Get content properties for custom content
CompletableFuture<ContentProperty>	getCustomContentContentPropertiesById(@NotNull Long customContentId, @NotNull Long propertyId)	Get content property for custom content by id
CompletableFuture<MultiEntityResultLabel>	getCustomContentLabels(@NotNull Long id, @Nullable String prefix, @Nullable List<LabelSortOrder> sort, @Nullable String cursor, @Nullable Integer limit)	Get labels for custom content
CompletableFuture<PermittedOperationsResponse>	getCustomContentOperations(@NotNull Long id)	Get permitted operations for custom content
CompletableFuture<DetailedVersion>	getCustomContentVersionDetails(@NotNull Long customContentId, @NotNull Long versionNumber)	Get version details for custom content version
CompletableFuture<MultiEntityResultVersion3>	getCustomContentVersions(@NotNull Long customContentId, @Nullable CustomContentBodyRepresentation bodyFormat, @Nullable String cursor, @Nullable Integer limit, @Nullable VersionSortOrder sort)	Get custom content versions
CompletableFuture<DataPolicyMetadata>	getDataPolicyMetadata()	Get data policy metadata for the workspace (EAP)
CompletableFuture<MultiEntityResultDataPolicySpace>	getDataPolicySpaces(@Nullable List<Long> ids, @Nullable List<String> keys, @Nullable SpaceSortOrder sort, @Nullable String cursor, @Nullable Integer limit)	Get spaces with data policies (EAP)
CompletableFuture<FooterCommentModel>	getFooterCommentById(@NotNull Long commentId, @Nullable PrimaryBodyRepresentationSingle bodyFormat, @Nullable Integer version)	Get footer comment by id
CompletableFuture<MultiEntityResultChildrenCommentModel>	getFooterCommentChildren(@NotNull Long id, @Nullable PrimaryBodyRepresentation bodyFormat, @Nullable CommentSortOrder sort, @Nullable String cursor, @Nullable Integer limit)	Get children footer comments
CompletableFuture<PermittedOperationsResponse>	getFooterCommentOperations(@NotNull Long id)	Get permitted operations for footer comment
CompletableFuture<MultiEntityResultFooterCommentModel>	getFooterComments(@Nullable PrimaryBodyRepresentation bodyFormat, @Nullable CommentSortOrder sort, @Nullable String cursor, @Nullable Integer limit)	Get footer comments
CompletableFuture<DetailedVersion>	getFooterCommentVersionDetails(@NotNull Long id, @NotNull Long versionNumber)	Get version details for footer comment version
CompletableFuture<MultiEntityResultVersion4>	getFooterCommentVersions(@NotNull Long id, @Nullable PrimaryBodyRepresentation bodyFormat, @Nullable String cursor, @Nullable Integer limit, @Nullable VersionSortOrder sort)	Get footer comment versions
CompletableFuture<Integer>	getFooterLikeCount(@NotNull Long id)	Get like count for footer comment
CompletableFuture<MultiEntityResultString>	getFooterLikeUsers(@NotNull Long id, @Nullable String cursor, @Nullable Integer limit)	Get account IDs of likes for footer comment
CompletableFuture<InlineCommentModel>	getInlineCommentById(@NotNull Long commentId, @Nullable PrimaryBodyRepresentationSingle bodyFormat, @Nullable Integer version)	Get inline comment by id
CompletableFuture<MultiEntityResultInlineCommentChildrenModel>	getInlineCommentChildren(@NotNull Long id, @Nullable PrimaryBodyRepresentation bodyFormat, @Nullable CommentSortOrder sort, @Nullable String cursor, @Nullable Integer limit)	Get children inline comments
CompletableFuture<PermittedOperationsResponse>	getInlineCommentOperations(@NotNull Long id)	Get permitted operations for inline comment
CompletableFuture<MultiEntityResultInlineCommentModel>	getInlineComments(@Nullable PrimaryBodyRepresentation bodyFormat, @Nullable CommentSortOrder sort, @Nullable String cursor, @Nullable Integer limit)	Get inline comments
CompletableFuture<DetailedVersion>	getInlineCommentVersionDetails(@NotNull Long id, @NotNull Long versionNumber)	Get version details for inline comment version
CompletableFuture<MultiEntityResultVersion4>	getInlineCommentVersions(@NotNull Long id, @Nullable PrimaryBodyRepresentation bodyFormat, @Nullable String cursor, @Nullable Integer limit, @Nullable VersionSortOrder sort)	Get inline comment versions
CompletableFuture<Integer>	getInlineLikeCount(@NotNull Long id)	Get like count for inline comment
CompletableFuture<MultiEntityResultString>	getInlineLikeUsers(@NotNull Long id, @Nullable String cursor, @Nullable Integer limit)	Get account IDs of likes for inline comment
CompletableFuture<MultiEntityResultAttachment1>	getLabelAttachments(@NotNull Long id, @Nullable AttachmentSortOrder sort, @Nullable String cursor, @Nullable Integer limit)	Get attachments for label
CompletableFuture<MultiEntityResultBlogPost>	getLabelBlogPosts(@NotNull Long id, @Nullable List<Long> spaceId, @Nullable PrimaryBodyRepresentation bodyFormat, @Nullable BlogPostSortOrder sort, @Nullable String cursor, @Nullable Integer limit)	Get blog posts for label
CompletableFuture<MultiEntityResultPage>	getLabelPages(@NotNull Long id, @Nullable List<Long> spaceId, @Nullable PrimaryBodyRepresentation bodyFormat, @Nullable PageSortOrder sort, @Nullable String cursor, @Nullable Integer limit)	Get pages for label
CompletableFuture<MultiEntityResultLabel1>	getLabels(@Nullable List<Long> labelId, @Nullable List<String> prefix, @Nullable String cursor, @Nullable List<LabelSortOrder> sort, @Nullable Integer limit)	Get labels
CompletableFuture<MultiEntityResultAncestor>	getPageAncestors(@NotNull Long id, @Nullable Integer limit)	Get all ancestors of page
CompletableFuture<MultiEntityResultAttachment>	getPageAttachments(@NotNull Long id, @Nullable AttachmentSortOrder sort, @Nullable String cursor, @Nullable List<String> status, @Nullable String mediaType, @Nullable String filename, @Nullable Integer limit)	Get attachments for page
CompletableFuture<PageSingle>	getPageById(@NotNull Long id, @Nullable PrimaryBodyRepresentationSingle bodyFormat, @Nullable Boolean getDraft, @Nullable Integer version)	Get page by id
CompletableFuture<MultiEntityResultContentProperty>	getPageContentProperties(@NotNull Long pageId, @Nullable String key, @Nullable ContentPropertySortOrder sort, @Nullable String cursor, @Nullable Integer limit)	Get content properties for page
CompletableFuture<ContentProperty>	getPageContentPropertiesById(@NotNull Long pageId, @NotNull Long propertyId)	Get content property for page by id
CompletableFuture<MultiEntityResultPageCommentModel>	getPageFooterComments(@NotNull Long id, @Nullable PrimaryBodyRepresentation bodyFormat, @Nullable CommentSortOrder sort, @Nullable String cursor, @Nullable Integer limit)	Get footer comments for page
CompletableFuture<MultiEntityResultPageInlineCommentModel>	getPageInlineComments(@NotNull Long id, @Nullable PrimaryBodyRepresentation bodyFormat, @Nullable CommentSortOrder sort, @Nullable String cursor, @Nullable Integer limit)	Get inline comments for page
CompletableFuture<MultiEntityResultLabel>	getPageLabels(@NotNull Long id, @Nullable String prefix, @Nullable List<LabelSortOrder> sort, @Nullable String cursor, @Nullable Integer limit)	Get labels for page
CompletableFuture<Integer>	getPageLikeCount(@NotNull Long id)	Get like count for page
CompletableFuture<MultiEntityResultString>	getPageLikeUsers(@NotNull Long id, @Nullable String cursor, @Nullable Integer limit)	Get account IDs of likes for page
CompletableFuture<PermittedOperationsResponse>	getPageOperations(@NotNull Long id)	Get permitted operations for page
CompletableFuture<MultiEntityResultPage>	getPages(@Nullable List<Long> id, @Nullable List<Long> spaceId, @Nullable PageSortOrder sort, @Nullable List<String> status, @Nullable String title, @Nullable PrimaryBodyRepresentation bodyFormat, @Nullable String cursor, @Nullable Integer limit)	Get pages
CompletableFuture<MultiEntityResultPage>	getPagesInSpace(@NotNull Long id, @Nullable String depth, @Nullable PageSortOrder sort, @Nullable List<String> status, @Nullable String title, @Nullable PrimaryBodyRepresentation bodyFormat, @Nullable String cursor, @Nullable Integer limit)	Get pages in space
CompletableFuture<DetailedVersion>	getPageVersionDetails(@NotNull Long pageId, @NotNull Long versionNumber)	Get version details for page version
CompletableFuture<MultiEntityResultVersion2>	getPageVersions(@NotNull Long id, @Nullable PrimaryBodyRepresentation bodyFormat, @Nullable String cursor, @Nullable Integer limit, @Nullable VersionSortOrder sort)	Get page versions
CompletableFuture<Space>	getSpaceById(@NotNull Long id, @Nullable SpaceDescriptionBodyRepresentation descriptionFormat, @Nullable Boolean includeIcon)	Get space by id
CompletableFuture<MultiEntityResultLabel>	getSpaceContentLabels(@NotNull Long id, @Nullable String prefix, @Nullable List<LabelSortOrder> sort, @Nullable String cursor, @Nullable Integer limit)	Get labels for space content
CompletableFuture<MultiEntityResultLabel>	getSpaceLabels(@NotNull Long id, @Nullable String prefix, @Nullable List<LabelSortOrder> sort, @Nullable String cursor, @Nullable Integer limit)	Get labels for space
CompletableFuture<PermittedOperationsResponse>	getSpaceOperations(@NotNull Long id)	Get permitted operations for space
CompletableFuture<MultiEntityResultSpacePermission>	getSpacePermissions(@NotNull Long id, @Nullable String cursor, @Nullable Integer limit)	Get space permissions
CompletableFuture<MultiEntityResultSpaceProperty>	getSpaceProperties(@NotNull Long spaceId, @Nullable String key, @Nullable String cursor, @Nullable Integer limit)	Get space properties in space
CompletableFuture<SpaceProperty>	getSpacePropertyById(@NotNull Long spaceId, @NotNull Long propertyId)	Get space property by id
CompletableFuture<MultiEntityResultSpace>	getSpaces(@Nullable List<Long> ids, @Nullable List<String> keys, @Nullable String type, @Nullable String status, @Nullable List<String> labels, @Nullable SpaceSortOrder sort, @Nullable SpaceDescriptionBodyRepresentation descriptionFormat, @Nullable Boolean includeIcon, @Nullable String cursor, @Nullable Integer limit)	Get spaces
CompletableFuture<Task>	getTaskById(@NotNull Long id, @Nullable PrimaryBodyRepresentation bodyFormat)	Get task by id
CompletableFuture<MultiEntityResultTask>	getTasks(@Nullable PrimaryBodyRepresentation bodyFormat, @Nullable Boolean includeBlankTasks, @Nullable String status, @Nullable List<Long> taskId, @Nullable List<Long> spaceId, @Nullable List<Long> pageId, @Nullable List<Long> blogpostId, @Nullable List<String> createdBy, @Nullable List<String> assignedTo, @Nullable List<String> completedBy, @Nullable Long createdAtFrom, @Nullable Long createdAtTo, @Nullable Long dueAtFrom, @Nullable Long dueAtTo, @Nullable Long completedAtFrom, @Nullable Long completedAtTo, @Nullable String cursor, @Nullable Integer limit)	Get tasks
CompletableFuture<MultiEntityResultAncestor>	getWhiteboardAncestors(@NotNull Long id, @Nullable Integer limit)	Get all ancestors of the whiteboard
CompletableFuture<WhiteboardSingle>	getWhiteboardById(@NotNull Long id)	Get whiteboard by id
CompletableFuture<MultiEntityResultContentProperty>	getWhiteboardContentProperties(@NotNull Long id, @Nullable String key, @Nullable ContentPropertySortOrder sort, @Nullable String cursor, @Nullable Integer limit)	Get content properties for whiteboard
CompletableFuture<ContentProperty>	getWhiteboardContentPropertiesById(@NotNull Long whiteboardId, @NotNull Long propertyId)	Get content property for whiteboard by id
CompletableFuture<PermittedOperationsResponse>	getWhiteboardOperations(@NotNull Long id)	Get permitted operations for a whiteboard
CompletableFuture<Void>	inviteByEmail(@NotNull CheckAccessByEmailRequest checkAccessByEmailRequest)	Invite a list of emails to the site
CompletableFuture<ContentProperty>	updateAttachmentPropertyById(@NotNull String attachmentId, @NotNull Long propertyId, @NotNull ContentPropertyUpdateRequest contentPropertyUpdateRequest)	Update content property for attachment by id
CompletableFuture<BlogPostSingle>	updateBlogPost(@NotNull Long id, @NotNull UpdateBlogPostRequest updateBlogPostRequest)	Update blog post
CompletableFuture<ContentProperty>	updateBlogpostPropertyById(@NotNull Long blogpostId, @NotNull Long propertyId, @NotNull ContentPropertyUpdateRequest contentPropertyUpdateRequest)	Update content property for blog post by id
CompletableFuture<ContentProperty>	updateCommentPropertyById(@NotNull Long commentId, @NotNull Long propertyId, @NotNull ContentPropertyUpdateRequest contentPropertyUpdateRequest)	Update content property for comment by id
CompletableFuture<CustomContentSingle>	updateCustomContent(@NotNull Long id, @NotNull UpdateCustomContentRequest updateCustomContentRequest)	Update custom content
CompletableFuture<ContentProperty>	updateCustomContentPropertyById(@NotNull Long customContentId, @NotNull Long propertyId, @NotNull ContentPropertyUpdateRequest contentPropertyUpdateRequest)	Update content property for custom content by id
CompletableFuture<FooterCommentModel>	updateFooterComment(@NotNull Long commentId, @NotNull UpdateFooterCommentModel updateFooterCommentModel)	Update footer comment
CompletableFuture<InlineCommentModel>	updateInlineComment(@NotNull Long commentId, @NotNull UpdateInlineCommentModel updateInlineCommentModel)	Update inline comment
CompletableFuture<PageSingle>	updatePage(@NotNull Long id, @NotNull UpdatePageRequest updatePageRequest)	Update page
CompletableFuture<ContentProperty>	updatePagePropertyById(@NotNull Long pageId, @NotNull Long propertyId, @NotNull ContentPropertyUpdateRequest contentPropertyUpdateRequest)	Update content property for page by id
CompletableFuture<SpaceProperty>	updateSpacePropertyById(@NotNull Long spaceId, @NotNull Long propertyId, @NotNull SpacePropertyUpdateRequest spacePropertyUpdateRequest)	Update space property by id
CompletableFuture<Task>	updateTask(@NotNull Long id, @NotNull UpdateTaskRequest updateTaskRequest)	Update task
CompletableFuture<ContentProperty>	updateWhiteboardPropertyById(@NotNull Long whiteboardId, @NotNull Long propertyId, @NotNull ContentPropertyUpdateRequest contentPropertyUpdateRequest)	Update content property for whiteboard by id

Methodendetails

checkAccessByEmail

CompletableFuture<CheckAccessByEmail200Response> checkAccessByEmail(@NotNull
 @NotNull CheckAccessByEmailRequest checkAccessByEmailRequest)

Check site access for a list of emails

Returns the list of emails from the input list that do not have access to site. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site ('Can use' global permission).

Parameter:

checkAccessByEmailRequest - (required)

convertContentIdsToContentTypes

CompletableFuture<ContentIdToContentTypeResponse> convertContentIdsToContentTypes(@NotNull
 @NotNull ConvertContentIdsToContentTypesRequest convertContentIdsToContentTypesRequest)

Convert content ids to content types

Converts a list of content ids into their associated content types. This is useful for users migrating from v1 to v2 who may have stored just content ids without their associated type. This will return types as they should be used in v2. Notably, this will return inline-comment for inline comments and footer-comment for footer comments, which is distinct from them both being represented by comment in v1. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the requested content. Any content that the user does not have permission to view or does not exist will map to null in the response.

Parameter:

convertContentIdsToContentTypesRequest - (required)

createAttachmentProperty

CompletableFuture<ContentProperty> createAttachmentProperty(@NotNull
 @NotNull String attachmentId,
 @NotNull
 @NotNull ContentPropertyCreateRequest contentPropertyCreateRequest)

Create content property for attachment

Creates a new content property for an attachment. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to update the attachment. Authentication - Required Scopes: [read:attachment:confluence]

Parameter:

attachmentId - The ID of the attachment to create a property for. (required)

contentPropertyCreateRequest - The content property to be created (required)

createBlogPost

CompletableFuture<BlogPostSingle> createBlogPost(@NotNull
 @NotNull CreateBlogPostRequest createBlogPostRequest,
 @Nullable
 @Nullable Boolean _private)

Create blog post

Creates a new blog post in the space specified by the spaceId. By default this will create the blog post as a non-draft, unless the status is specified as draft. If creating a non-draft, the title must not be empty. Currently only supports the storage representation specified in the body.representation enums below Authentication - Required Scopes: [write:page:confluence]

Parameter:

createBlogPostRequest - (required)

_private - The blog post will be private. Only the user who creates this blog post will have permission to view and edit one. (optional, defaults to false)

createBlogpostProperty

CompletableFuture<ContentProperty> createBlogpostProperty(@NotNull
 @NotNull Long blogpostId,
 @NotNull
 @NotNull ContentPropertyCreateRequest contentPropertyCreateRequest)

Create content property for blog post

Creates a new property for a blogpost. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to update the blog post. Authentication - Required Scopes: [read:page:confluence, write:page:confluence]

Parameter:

blogpostId - The ID of the blog post to create a property for. (required)

contentPropertyCreateRequest - The content property to be created (required)

createCommentProperty

CompletableFuture<ContentProperty> createCommentProperty(@NotNull
 @NotNull Long commentId,
 @NotNull
 @NotNull ContentPropertyCreateRequest contentPropertyCreateRequest)

Create content property for comment

Creates a new content property for a comment. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to update the comment. Authentication - Required Scopes: [read:comment:confluence, write:comment:confluence]

Parameter:

commentId - The ID of the comment to create a property for. (required)

contentPropertyCreateRequest - The content property to be created (required)

createCustomContent

CompletableFuture<CustomContentSingle> createCustomContent(@NotNull
 @NotNull CreateCustomContentRequest createCustomContentRequest)

Create custom content

Creates a new custom content in the given space, page, blogpost or other custom content. Only one of spaceId, pageId, blogPostId, or customContentId is required in the request body. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content of the page or blogpost and its corresponding space. Permission to create custom content in the space. Authentication - Required Scopes: [write:custom-content:confluence]

Parameter:

createCustomContentRequest - (required)

createCustomContentProperty

CompletableFuture<ContentProperty> createCustomContentProperty(@NotNull
 @NotNull Long customContentId,
 @NotNull
 @NotNull ContentPropertyCreateRequest contentPropertyCreateRequest)

Create content property for custom content

Creates a new content property for a piece of custom content. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to update the custom content. Authentication - Required Scopes: [read:custom-content:confluence, write:custom-content:confluence]

Parameter:

customContentId - The ID of the custom content to create a property for. (required)

contentPropertyCreateRequest - The content property to be created (required)

createFooterComment

CompletableFuture<FooterCommentModel> createFooterComment(@NotNull
 @NotNull CreateFooterCommentModel createFooterCommentModel)

Create footer comment

Create a footer comment. The footer comment can be made against several locations: - at the top level (specifying pageId or blogPostId in the request body) - as a reply (specifying parentCommentId in the request body) - against an attachment (note: this is different than the comments added via the attachment properties page on the UI, which are referred to as version comments) - against a custom content **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content of the page or blogpost and its corresponding space. Permission to create comments in the space. Authentication - Required Scopes: [write:comment:confluence]

Parameter:

createFooterCommentModel - The footer comment to be created (required)

createInlineComment

CompletableFuture<InlineCommentModel> createInlineComment(@NotNull
 @NotNull CreateInlineCommentModel createInlineCommentModel)

Create inline comment

Create an inline comment. This can be at the top level (specifying pageId or blogPostId in the request body) or as a reply (specifying parentCommentId in the request body). Note the inlineCommentProperties object in the request body is used to select the text the inline comment should be tied to. This is what determines the text highlighting when viewing a page in Confluence. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content of the page or blogpost and its corresponding space. Permission to create comments in the space. Authentication - Required Scopes: [write:comment:confluence]

Parameter:

createInlineCommentModel - The inline comment to be created (required)

createPage

CompletableFuture<PageSingle> createPage(@NotNull
 @NotNull CreatePageRequest createPageRequest,
 @Nullable
 @Nullable Boolean embedded,
 @Nullable
 @Nullable Boolean _private,
 @Nullable
 @Nullable Boolean rootLevel)

Create page

Creates a page in the space. Pages are created as published by default unless specified as a draft in the status field. If creating a published page, the title must be specified. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the corresponding space. Permission to create a page in the space. Authentication - Required Scopes: [write:page:confluence]

Parameter:

createPageRequest - (required)

embedded - Tag the content as embedded and content will be created in NCS. (optional, defaults to false)

_private - The page will be private. Only the user who creates this page will have permission to view and edit one. (optional, defaults to false)

rootLevel - The page will be created at the root level of the space (outside the space homepage tree). (optional, defaults to false)

createPageProperty

CompletableFuture<ContentProperty> createPageProperty(@NotNull
 @NotNull Long pageId,
 @NotNull
 @NotNull ContentPropertyCreateRequest contentPropertyCreateRequest)

Create content property for page

Creates a new content property for a page. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to update the page. Authentication - Required Scopes: [read:page:confluence, write:page:confluence]

Parameter:

pageId - The ID of the page to create a property for. (required)

contentPropertyCreateRequest - The content property to be created (required)

createSpaceProperty

CompletableFuture<SpaceProperty> createSpaceProperty(@NotNull
 @NotNull Long spaceId,
 @NotNull
 @NotNull SpacePropertyCreateRequest spacePropertyCreateRequest)

Create space property in space

Creates a new space property. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site ('Can use' global permission) and 'Admin' permission for the space. Authentication - Required Scopes: [read:space:confluence, write:space:confluence]

Parameter:

spaceId - The ID of the space for which space properties should be returned. (required)

spacePropertyCreateRequest - The space property to be created (required)

createWhiteboard

CompletableFuture<WhiteboardSingle> createWhiteboard(@NotNull
 @NotNull CreateWhiteboardRequest createWhiteboardRequest,
 @Nullable
 @Nullable Boolean _private)

Create whiteboard

Creates a whiteboard in the space. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the corresponding space. Permission to create a whiteboard in the space. Authentication - Required Scopes: [write:whiteboard:confluence]

Parameter:

createWhiteboardRequest - (required)

_private - The whiteboard will be private. Only the user who creates this whiteboard will have permission to view and edit one. (optional, defaults to false)

createWhiteboardProperty

CompletableFuture<ContentProperty> createWhiteboardProperty(@NotNull
 @NotNull Long id,
 @NotNull
 @NotNull ContentPropertyCreateRequest contentPropertyCreateRequest)

Create content property for whiteboard

Creates a new content property for a whiteboard. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to update the whiteboard. Authentication - Required Scopes: [read:whiteboard:confluence, write:whiteboard:confluence]

Parameter:

id - The ID of the whiteboard to create a property for. (required)

contentPropertyCreateRequest - The content property to be created (required)

deleteAttachment

CompletableFuture<Void> deleteAttachment(@NotNull
 @NotNull Long id,
 @Nullable
 @Nullable Boolean purge)

Delete attachment

Delete an attachment by id. Deleting an attachment moves the attachment to the trash, where it can be restored later. To permanently delete an attachment (or "purge" it), the endpoint must be called on a **trashed** attachment with the following param purge=true. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the container of the attachment. Permission to delete attachments in the space. Permission to administer the space (if attempting to purge).

Parameter:

id - The ID of the attachment to be deleted. (required)

purge - If attempting to purge the attachment. (optional, defaults to false)

deleteAttachmentPropertyById

CompletableFuture<Void> deleteAttachmentPropertyById(@NotNull
 @NotNull String attachmentId,
 @NotNull
 @NotNull Long propertyId)

Delete content property for attachment by id

Deletes a content property for an attachment by its id. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to attachment the page. Authentication - Required Scopes: [read:attachment:confluence]

Parameter:

attachmentId - The ID of the attachment the property belongs to. (required)

propertyId - The ID of the property to be deleted. (required)

deleteBlogPost

CompletableFuture<Void> deleteBlogPost(@NotNull
 @NotNull Long id,
 @Nullable
 @Nullable Boolean purge,
 @Nullable
 @Nullable Boolean draft)

Delete blog post

Delete a blog post by id. By default this will delete blog posts that are non-drafts. To delete a blog post that is a draft, the endpoint must be called on a draft with the following param draft=true. Discarded drafts are not sent to the trash and are permanently deleted. Deleting a blog post that is not a draft moves the blog post to the trash, where it can be restored later. To permanently delete a blog post (or "purge" it), the endpoint must be called on a **trashed** blog post with the following param purge=true. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the blog post and its corresponding space. Permission to delete blog posts in the space. Permission to administer the space (if attempting to purge). Authentication - Required Scopes: [delete:page:confluence]

Parameter:

id - The ID of the blog post to be deleted. (required)

purge - If attempting to purge the blog post. (optional, defaults to false)

draft - If attempting to delete a blog post that is a draft. (optional, defaults to false)

deleteBlogpostPropertyById

CompletableFuture<Void> deleteBlogpostPropertyById(@NotNull
 @NotNull Long blogpostId,
 @NotNull
 @NotNull Long propertyId)

Delete content property for blogpost by id

Deletes a content property for a blogpost by its id. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to edit the blog post. Authentication - Required Scopes: [read:page:confluence, write:page:confluence]

Parameter:

blogpostId - The ID of the blog post the property belongs to. (required)

propertyId - The ID of the property to be deleted. (required)

deleteCommentPropertyById

CompletableFuture<Void> deleteCommentPropertyById(@NotNull
 @NotNull Long commentId,
 @NotNull
 @NotNull Long propertyId)

Delete content property for comment by id

Deletes a content property for a comment by its id. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to edit the comment. Authentication - Required Scopes: [read:comment:confluence, write:comment:confluence]

Parameter:

commentId - The ID of the comment the property belongs to. (required)

propertyId - The ID of the property to be deleted. (required)

deleteCustomContent

CompletableFuture<Void> deleteCustomContent(@NotNull
 @NotNull Long id,
 @Nullable
 @Nullable Boolean purge)

Delete custom content

Delete a custom content by id. Deleting a custom content will either move it to the trash or permanently delete it (purge it), depending on the apiSupport. To permanently delete a **trashed** custom content, the endpoint must be called with the following param purge=true. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content of the page or blogpost and its corresponding space. Permission to delete custom content in the space. Permission to administer the space (if attempting to purge). Authentication - Required Scopes: [delete:custom-content:confluence]

Parameter:

id - The ID of the custom content to be deleted. (required)

purge - If attempting to purge the custom content. (optional, defaults to false)

deleteCustomContentPropertyById

CompletableFuture<Void> deleteCustomContentPropertyById(@NotNull
 @NotNull Long customContentId,
 @NotNull
 @NotNull Long propertyId)

Delete content property for custom content by id

Deletes a content property for a piece of custom content by its id. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to edit the custom content. Authentication - Required Scopes: [read:custom-content:confluence, write:custom-content:confluence]

Parameter:

customContentId - The ID of the custom content the property belongs to. (required)

propertyId - The ID of the property to be deleted. (required)

deleteFooterComment

CompletableFuture<Void> deleteFooterComment(@NotNull
 @NotNull Long commentId)

Delete footer comment

Deletes a footer comment. This is a permanent deletion and cannot be reverted. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content of the page or blogpost and its corresponding space. Permission to delete comments in the space. Authentication - Required Scopes: [delete:comment:confluence]

Parameter:

commentId - The ID of the comment to be retrieved. (required)

deleteInlineComment

CompletableFuture<Void> deleteInlineComment(@NotNull
 @NotNull Long commentId)

Delete inline comment

Deletes an inline comment. This is a permanent deletion and cannot be reverted. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content of the page or blogpost and its corresponding space. Permission to delete comments in the space. Authentication - Required Scopes: [delete:comment:confluence]

Parameter:

commentId - The ID of the comment to be deleted. (required)

deletePage

CompletableFuture<Void> deletePage(@NotNull
 @NotNull Long id,
 @Nullable
 @Nullable Boolean purge,
 @Nullable
 @Nullable Boolean draft)

Delete page

Delete a page by id. By default this will delete pages that are non-drafts. To delete a page that is a draft, the endpoint must be called on a draft with the following param draft=true. Discarded drafts are not sent to the trash and are permanently deleted. Deleting a page moves the page to the trash, where it can be restored later. To permanently delete a page (or "purge" it), the endpoint must be called on a **trashed** page with the following param purge=true. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the page and its corresponding space. Permission to delete pages in the space. Permission to administer the space (if attempting to purge). Authentication - Required Scopes: [delete:page:confluence]

Parameter:

id - The ID of the page to be deleted. (required)

purge - If attempting to purge the page. (optional, defaults to false)

draft - If attempting to delete a page that is a draft. (optional, defaults to false)

deletePagePropertyById

CompletableFuture<Void> deletePagePropertyById(@NotNull
 @NotNull Long pageId,
 @NotNull
 @NotNull Long propertyId)

Delete content property for page by id

Deletes a content property for a page by its id. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to edit the page. Authentication - Required Scopes: [read:page:confluence, write:page:confluence]

Parameter:

pageId - The ID of the page the property belongs to. (required)

propertyId - The ID of the property to be deleted. (required)

deleteSpacePropertyById

CompletableFuture<Void> deleteSpacePropertyById(@NotNull
 @NotNull Long spaceId,
 @NotNull
 @NotNull Long propertyId)

Delete space property by id

Deletes a space property by its id. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site ('Can use' global permission) and 'Admin' permission for the space. Authentication - Required Scopes: [read:space:confluence, write:space:confluence]

Parameter:

spaceId - The ID of the space the property belongs to. (required)

propertyId - The ID of the property to be deleted. (required)

deleteWhiteboard

CompletableFuture<Void> deleteWhiteboard(@NotNull
 @NotNull Long id)

Delete whiteboard

Delete a whiteboard by id. Deleting a whiteboard moves the whiteboard to the trash, where it can be restored later **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the whiteboard and its corresponding space. Permission to delete whiteboards in the space. Authentication - Required Scopes: [delete:whiteboard:confluence]

Parameter:

id - The ID of the whiteboard to be deleted. (required)

deleteWhiteboardPropertyById

CompletableFuture<Void> deleteWhiteboardPropertyById(@NotNull
 @NotNull Long whiteboardId,
 @NotNull
 @NotNull Long propertyId)

Delete content property for whiteboard by id

Deletes a content property for a whiteboard by its id. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to edit the whiteboard. Authentication - Required Scopes: [read:whiteboard:confluence, write:whiteboard:confluence]

Parameter:

whiteboardId - The ID of the whiteboard the property belongs to. (required)

propertyId - The ID of the property to be deleted. (required)

getAttachmentById

CompletableFuture<Attachment> getAttachmentById(@NotNull
 @NotNull String id,
 @Nullable
 @Nullable Integer version)

Get attachment by id

Returns a specific attachment. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the attachment's container. Authentication - Required Scopes: [read:attachment:confluence]

Parameter:

id - The ID of the attachment to be returned. If you don't know the attachment's ID, use Get attachments for page/blogpost/custom content. (required)

version - Allows you to retrieve a previously published version. Specify the previous version's number to retrieve its details. (optional)

getAttachmentComments

CompletableFuture<MultiEntityResultAttachmentCommentModel> getAttachmentComments(@NotNull
 @NotNull String id,
 @Nullable
 @Nullable PrimaryBodyRepresentation bodyFormat,
 @Nullable
 @Nullable String cursor,
 @Nullable
 @Nullable Integer limit,
 @Nullable
 @Nullable CommentSortOrder sort)

Get attachment comments

Returns the comments of the specific attachment. The number of results is limited by the limit parameter and additional results (if available) will be available through the next URL present in the Link response header. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the attachment and its corresponding containers. Authentication - Required Scopes: [read:comment:confluence]

Parameter:

id - The ID of the attachment for which comments should be returned. (required)

bodyFormat - The content format type to be returned in the body field of the response. If available, the representation will be available under a response field of the same name under the body field. (optional)

cursor - Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results. (optional)

limit - Maximum number of comments per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results. (optional, defaults to 25)

sort - Used to sort the result by a particular field. (optional)

getAttachmentContentProperties

CompletableFuture<MultiEntityResultContentProperty> getAttachmentContentProperties(@NotNull
 @NotNull String attachmentId,
 @Nullable
 @Nullable String key,
 @Nullable
 @Nullable ContentPropertySortOrder sort,
 @Nullable
 @Nullable String cursor,
 @Nullable
 @Nullable Integer limit)

Get content properties for attachment

Retrieves all Content Properties tied to a specified attachment. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the attachment. Authentication - Required Scopes: [read:attachment:confluence]

Parameter:

attachmentId - The ID of the attachment for which content properties should be returned. (required)

key - Filters the response to return a specific content property with matching key (case sensitive). (optional)

sort - Used to sort the result by a particular field. (optional)

cursor - Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results. (optional)

limit - Maximum number of attachments per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results. (optional, defaults to 25)

getAttachmentContentPropertiesById

CompletableFuture<ContentProperty> getAttachmentContentPropertiesById(@NotNull
 @NotNull String attachmentId,
 @NotNull
 @NotNull Long propertyId)

Get content property for attachment by id

Retrieves a specific Content Property by ID that is attached to a specified attachment. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the attachment. Authentication - Required Scopes: [read:attachment:confluence]

Parameter:

attachmentId - The ID of the attachment for which content properties should be returned. (required)

propertyId - The ID of the content property to be returned (required)

getAttachmentLabels

CompletableFuture<MultiEntityResultLabel> getAttachmentLabels(@NotNull
 @NotNull Long id,
 @Nullable
 @Nullable String prefix,
 @Nullable
 @Nullable List<LabelSortOrder> sort,
 @Nullable
 @Nullable String cursor,
 @Nullable
 @Nullable Integer limit)

Get labels for attachment

Returns the labels of specific attachment. The number of results is limited by the limit parameter and additional results (if available) will be available through the next URL present in the Link response header. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the parent content of the attachment and its corresponding space. Authentication - Required Scopes: [read:attachment:confluence]

Parameter:

id - The ID of the attachment for which labels should be returned. (required)

prefix - Filter the results to labels based on their prefix. (optional)

sort - Used to sort the result by a particular field. (optional)

cursor - Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results. (optional)

limit - Maximum number of labels per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results. (optional, defaults to 25)

getAttachmentOperations

CompletableFuture<PermittedOperationsResponse> getAttachmentOperations(@NotNull
 @NotNull String id)

Get permitted operations for attachment

Returns the permitted operations on specific attachment. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the parent content of the attachment and its corresponding space. Authentication - Required Scopes: [read:attachment:confluence]

Parameter:

id - The ID of the attachment for which operations should be returned. (required)

getAttachmentVersionDetails

CompletableFuture<DetailedVersion> getAttachmentVersionDetails(@NotNull
 @NotNull String attachmentId,
 @NotNull
 @NotNull Long versionNumber)

Get version details for attachment version

Retrieves version details for the specified attachment and version number. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the attachment. Authentication - Required Scopes: [read:attachment:confluence]

Parameter:

attachmentId - The ID of the attachment for which version details should be returned. (required)

versionNumber - The version number of the attachment to be returned. (required)

getAttachmentVersions

CompletableFuture<MultiEntityResultVersion> getAttachmentVersions(@NotNull
 @NotNull String id,
 @Nullable
 @Nullable String cursor,
 @Nullable
 @Nullable Integer limit,
 @Nullable
 @Nullable VersionSortOrder sort)

Get attachment versions

Returns the versions of specific attachment. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the attachment and its corresponding space. Authentication - Required Scopes: [read:attachment:confluence]

Parameter:

id - The ID of the attachment to be queried for its versions. If you don't know the attachment ID, use Get attachments and filter the results. (required)

cursor - Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results. (optional)

limit - Maximum number of versions per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results. (optional, defaults to 25)

sort - Used to sort the result by a particular field. (optional)

getAttachments

CompletableFuture<MultiEntityResultAttachment> getAttachments(@Nullable
 @Nullable AttachmentSortOrder sort,
 @Nullable
 @Nullable String cursor,
 @Nullable
 @Nullable List<String> status,
 @Nullable
 @Nullable String mediaType,
 @Nullable
 @Nullable String filename,
 @Nullable
 @Nullable Integer limit)

Get attachments

Returns all attachments. The number of results is limited by the limit parameter and additional results (if available) will be available through the next URL present in the Link response header. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the container of the attachment. Authentication - Required Scopes: [read:attachment:confluence]

Parameter:

sort - Used to sort the result by a particular field. (optional)

cursor - Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results. (optional)

status - Filter the results to attachments based on their status. By default, current and archived are used. (optional)

mediaType - Filters on the mediaType of attachments. Only one may be specified. (optional)

filename - Filters on the file-name of attachments. Only one may be specified. (optional)

limit - Maximum number of attachments per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results. (optional, defaults to 50)

getBlogPostById

CompletableFuture<BlogPostSingle> getBlogPostById(@NotNull
 @NotNull Long id,
 @Nullable
 @Nullable PrimaryBodyRepresentationSingle bodyFormat,
 @Nullable
 @Nullable Boolean getDraft,
 @Nullable
 @Nullable Integer version)

Get blog post by id

Returns a specific blog post. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the blog post and its corresponding space. Authentication - Required Scopes: [read:page:confluence]

Parameter:

id - The ID of the blog post to be returned. If you don't know the blog post ID, use Get blog posts and filter the results. (required)

bodyFormat - The content format types to be returned in the body field of the response. If available, the representation will be available under a response field of the same name under the body field. (optional)

getDraft - Retrieve the draft version of this blog post. (optional, defaults to false)

version - Allows you to retrieve a previously published version. Specify the previous version's number to retrieve its details. (optional)

getBlogPostFooterComments

CompletableFuture<MultiEntityResultBlogPostCommentModel> getBlogPostFooterComments(@NotNull
 @NotNull Long id,
 @Nullable
 @Nullable PrimaryBodyRepresentation bodyFormat,
 @Nullable
 @Nullable CommentSortOrder sort,
 @Nullable
 @Nullable String cursor,
 @Nullable
 @Nullable Integer limit)

Get footer comments for blog post

Returns the root footer comments of specific blog post. The number of results is limited by the limit parameter and additional results (if available) will be available through the next URL present in the Link response header. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content of the blog post and its corresponding space. Authentication - Required Scopes: [read:comment:confluence]

Parameter:

id - The ID of the blog post for which footer comments should be returned. (required)

bodyFormat - The content format type to be returned in the body field of the response. If available, the representation will be available under a response field of the same name under the body field. (optional)

sort - Used to sort the result by a particular field. (optional)

cursor - Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results. (optional)

limit - Maximum number of footer comments per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results. (optional, defaults to 25)

getBlogPostInlineComments

CompletableFuture<MultiEntityResultBlogPostInlineCommentModel> getBlogPostInlineComments(@NotNull
 @NotNull Long id,
 @Nullable
 @Nullable PrimaryBodyRepresentation bodyFormat,
 @Nullable
 @Nullable CommentSortOrder sort,
 @Nullable
 @Nullable String cursor,
 @Nullable
 @Nullable Integer limit)

Get inline comments for blog post

Returns the root inline comments of specific blog post. The number of results is limited by the limit parameter and additional results (if available) will be available through the next URL present in the Link response header. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content of the blog post and its corresponding space. Authentication - Required Scopes: [read:comment:confluence]

Parameter:

id - The ID of the blog post for which inline comments should be returned. (required)

bodyFormat - The content format type to be returned in the body field of the response. If available, the representation will be available under a response field of the same name under the body field. (optional)

sort - Used to sort the result by a particular field. (optional)

cursor - Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results. (optional)

limit - Maximum number of inline comments per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results. (optional, defaults to 25)

getBlogPostLabels

CompletableFuture<MultiEntityResultLabel> getBlogPostLabels(@NotNull
 @NotNull Long id,
 @Nullable
 @Nullable String prefix,
 @Nullable
 @Nullable List<LabelSortOrder> sort,
 @Nullable
 @Nullable String cursor,
 @Nullable
 @Nullable Integer limit)

Get labels for blog post

Returns the labels of specific blog post. The number of results is limited by the limit parameter and additional results (if available) will be available through the next URL present in the Link response header. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content of the blog post and its corresponding space. Authentication - Required Scopes: [read:page:confluence]

Parameter:

id - The ID of the blog post for which labels should be returned. (required)

prefix - Filter the results to labels based on their prefix. (optional)

sort - Used to sort the result by a particular field. (optional)

cursor - Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results. (optional)

limit - Maximum number of labels per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results. (optional, defaults to 25)

getBlogPostLikeCount

CompletableFuture<Integer> getBlogPostLikeCount(@NotNull
 @NotNull Long id)

Get like count for blog post

Returns the count of likes of specific blog post. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content of the blog post and its corresponding space. Authentication - Required Scopes: [read:page:confluence]

Parameter:

id - The ID of the blog post for which like count should be returned. (required)

getBlogPostLikeUsers

CompletableFuture<MultiEntityResultString> getBlogPostLikeUsers(@NotNull
 @NotNull Long id,
 @Nullable
 @Nullable String cursor,
 @Nullable
 @Nullable Integer limit)

Get account IDs of likes for blog post

Returns the account IDs of likes of specific blog post. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content of the blog post and its corresponding space. Authentication - Required Scopes: [read:page:confluence]

Parameter:

id - The ID of the blog post for which account IDs should be returned. (required)

cursor - Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results. (optional)

limit - Maximum number of account IDs per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results. (optional, defaults to 25)

getBlogPostOperations

CompletableFuture<PermittedOperationsResponse> getBlogPostOperations(@NotNull
 @NotNull Long id)

Get permitted operations for blog post

Returns the permitted operations on specific blog post. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the parent content of the blog post and its corresponding space. Authentication - Required Scopes: [read:page:confluence]

Parameter:

id - The ID of the blog post for which operations should be returned. (required)

getBlogPostVersionDetails

CompletableFuture<DetailedVersion> getBlogPostVersionDetails(@NotNull
 @NotNull Long blogpostId,
 @NotNull
 @NotNull Long versionNumber)

Get version details for blog post version

Retrieves version details for the specified blog post and version number. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the blog post. Authentication - Required Scopes: [read:page:confluence]

Parameter:

blogpostId - The ID of the blog post for which version details should be returned. (required)

versionNumber - The version number of the blog post to be returned. (required)

getBlogPostVersions

CompletableFuture<MultiEntityResultVersion1> getBlogPostVersions(@NotNull
 @NotNull Long id,
 @Nullable
 @Nullable PrimaryBodyRepresentation bodyFormat,
 @Nullable
 @Nullable String cursor,
 @Nullable
 @Nullable Integer limit,
 @Nullable
 @Nullable VersionSortOrder sort)

Get blog post versions

Returns the versions of specific blog post. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the blog post and its corresponding space. Authentication - Required Scopes: [read:page:confluence]

Parameter:

id - The ID of the blog post to be queried for its versions. If you don't know the blog post ID, use Get blog posts and filter the results. (required)

bodyFormat - The content format types to be returned in the body field of the response. If available, the representation will be available under a response field of the same name under the body field. (optional)

cursor - Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results. (optional)

limit - Maximum number of versions per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results. (optional, defaults to 25)

sort - Used to sort the result by a particular field. (optional)

getBlogPosts

CompletableFuture<MultiEntityResultBlogPost> getBlogPosts(@Nullable
 @Nullable List<Long> id,
 @Nullable
 @Nullable List<Long> spaceId,
 @Nullable
 @Nullable BlogPostSortOrder sort,
 @Nullable
 @Nullable List<String> status,
 @Nullable
 @Nullable String title,
 @Nullable
 @Nullable PrimaryBodyRepresentation bodyFormat,
 @Nullable
 @Nullable String cursor,
 @Nullable
 @Nullable Integer limit)

Get blog posts

Returns all blog posts. The number of results is limited by the limit parameter and additional results (if available) will be available through the next URL present in the Link response header. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site ('Can use' global permission). Only blog posts that the user has permission to view will be returned. Authentication - Required Scopes: [read:page:confluence]

Parameter:

id - Filter the results based on blog post ids. Multiple blog post ids can be specified as a comma-separated list. (optional)

spaceId - Filter the results based on space ids. Multiple space ids can be specified as a comma-separated list. (optional)

sort - Used to sort the result by a particular field. (optional)

status - Filter the results to blog posts based on their status. By default, current is used. (optional)

title - Filter the results to blog posts based on their title. (optional)

bodyFormat - The content format types to be returned in the body field of the response. If available, the representation will be available under a response field of the same name under the body field. (optional)

cursor - Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results. (optional)

limit - Maximum number of blog posts per result to return. If more results exist, use the Link response header to retrieve a relative URL that will return the next set of results. (optional, defaults to 25)

getBlogPostsInSpace

CompletableFuture<MultiEntityResultBlogPost> getBlogPostsInSpace(@NotNull
 @NotNull Long id,
 @Nullable
 @Nullable BlogPostSortOrder sort,
 @Nullable
 @Nullable List<String> status,
 @Nullable
 @Nullable String title,
 @Nullable
 @Nullable PrimaryBodyRepresentation bodyFormat,
 @Nullable
 @Nullable String cursor,
 @Nullable
 @Nullable Integer limit)

Get blog posts in space

Returns all blog posts in a space. The number of results is limited by the limit parameter and additional results (if available) will be available through the next URL present in the Link response header. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site ('Can use' global permission) and view the space. Only blog posts that the user has permission to view will be returned. Authentication - Required Scopes: [read:page:confluence]

Parameter:

id - The ID of the space for which blog posts should be returned. (required)

sort - Used to sort the result by a particular field. (optional)

status - Filter the results to blog posts based on their status. By default, current is used. (optional)

title - Filter the results to blog posts based on their title. (optional)

bodyFormat - The content format types to be returned in the body field of the response. If available, the representation will be available under a response field of the same name under the body field. (optional)

cursor - Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results. (optional)

limit - Maximum number of blog posts per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results. (optional, defaults to 25)

getBlogpostAttachments

CompletableFuture<MultiEntityResultAttachment> getBlogpostAttachments(@NotNull
 @NotNull Long id,
 @Nullable
 @Nullable AttachmentSortOrder sort,
 @Nullable
 @Nullable String cursor,
 @Nullable
 @Nullable List<String> status,
 @Nullable
 @Nullable String mediaType,
 @Nullable
 @Nullable String filename,
 @Nullable
 @Nullable Integer limit)

Get attachments for blog post

Returns the attachments of specific blog post. The number of results is limited by the limit parameter and additional results (if available) will be available through the next URL present in the Link response header. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content of the blog post and its corresponding space. Authentication - Required Scopes: [read:attachment:confluence]

Parameter:

id - The ID of the blog post for which attachments should be returned. (required)

sort - Used to sort the result by a particular field. (optional)

cursor - Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results. (optional)

status - Filter the results to attachments based on their status. By default, current and archived are used. (optional)

mediaType - Filters on the mediaType of attachments. Only one may be specified. (optional)

filename - Filters on the file-name of attachments. Only one may be specified. (optional)

limit - Maximum number of attachments per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results. (optional, defaults to 50)

getBlogpostContentProperties

CompletableFuture<MultiEntityResultContentProperty> getBlogpostContentProperties(@NotNull
 @NotNull Long blogpostId,
 @Nullable
 @Nullable String key,
 @Nullable
 @Nullable ContentPropertySortOrder sort,
 @Nullable
 @Nullable String cursor,
 @Nullable
 @Nullable Integer limit)

Get content properties for blog post

Retrieves all Content Properties tied to a specified blog post. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the blog post. Authentication - Required Scopes: [read:page:confluence]

Parameter:

blogpostId - The ID of the blog post for which content properties should be returned. (required)

key - Filters the response to return a specific content property with matching key (case sensitive). (optional)

sort - Used to sort the result by a particular field. (optional)

cursor - Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results. (optional)

limit - Maximum number of attachments per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results. (optional, defaults to 25)

getBlogpostContentPropertiesById

CompletableFuture<ContentProperty> getBlogpostContentPropertiesById(@NotNull
 @NotNull Long blogpostId,
 @NotNull
 @NotNull Long propertyId)

Get content property for blog post by id

Retrieves a specific Content Property by ID that is attached to a specified blog post. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the blog post. Authentication - Required Scopes: [read:page:confluence]

Parameter:

blogpostId - The ID of the blog post for which content properties should be returned. (required)

propertyId - The ID of the property being requested (required)

getChildCustomContent

CompletableFuture<MultiEntityResultChildCustomContent> getChildCustomContent(@NotNull
 @NotNull Long id,
 @Nullable
 @Nullable String cursor,
 @Nullable
 @Nullable Integer limit,
 @Nullable
 @Nullable List<ChildCustomContentSortOrder> sort)

Get child custom content

Returns all child custom content for given custom content id. The number of results is limited by the limit parameter and additional results (if available) will be available through the next URL present in the Link response header. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site ('Can use' global permission). Only custom content that the user has permission to view will be returned. Authentication - Required Scopes: [read:custom-content:confluence]

Parameter:

id - The ID of the parent custom content. If you don't know the custom content ID, use Get custom-content and filter the results. (required)

cursor - Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results. (optional)

limit - Maximum number of pages per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results. (optional, defaults to 25)

sort - Used to sort the result by a particular field. (optional)

getChildPages

CompletableFuture<MultiEntityResultChildPage> getChildPages(@NotNull
 @NotNull Long id,
 @Nullable
 @Nullable String cursor,
 @Nullable
 @Nullable Integer limit,
 @Nullable
 @Nullable List<ChildPageSortOrder> sort)

Get child pages

Returns all child pages for given page id. The number of results is limited by the limit parameter and additional results (if available) will be available through the next URL present in the Link response header. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site ('Can use' global permission). Only pages that the user has permission to view will be returned. Authentication - Required Scopes: [read:page:confluence]

Parameter:

id - The ID of the parent page. If you don't know the page ID, use Get pages and filter the results. (required)

cursor - Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results. (optional)

limit - Maximum number of pages per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results. (optional, defaults to 25)

sort - Used to sort the result by a particular field. (optional)

getCommentContentProperties

CompletableFuture<MultiEntityResultContentProperty> getCommentContentProperties(@NotNull
 @NotNull Long commentId,
 @Nullable
 @Nullable String key,
 @Nullable
 @Nullable ContentPropertySortOrder sort,
 @Nullable
 @Nullable String cursor,
 @Nullable
 @Nullable Integer limit)

Get content properties for comment

Retrieves Content Properties attached to a specified comment. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the comment. Authentication - Required Scopes: [read:comment:confluence]

Parameter:

commentId - The ID of the comment for which content properties should be returned. (required)

key - Filters the response to return a specific content property with matching key (case sensitive). (optional)

sort - Used to sort the result by a particular field. (optional)

cursor - Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results. (optional)

limit - Maximum number of attachments per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results. (optional, defaults to 25)

getCommentContentPropertiesById

CompletableFuture<ContentProperty> getCommentContentPropertiesById(@NotNull
 @NotNull Long commentId,
 @NotNull
 @NotNull Long propertyId)

Get content property for comment by id

Retrieves a specific Content Property by ID that is attached to a specified comment. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the comment. Authentication - Required Scopes: [read:comment:confluence]

Parameter:

commentId - The ID of the comment for which content properties should be returned. (required)

propertyId - The ID of the content property being requested. (required)

getCustomContentAttachments

CompletableFuture<MultiEntityResultAttachment> getCustomContentAttachments(@NotNull
 @NotNull Long id,
 @Nullable
 @Nullable AttachmentSortOrder sort,
 @Nullable
 @Nullable String cursor,
 @Nullable
 @Nullable List<String> status,
 @Nullable
 @Nullable String mediaType,
 @Nullable
 @Nullable String filename,
 @Nullable
 @Nullable Integer limit)

Get attachments for custom content

Returns the attachments of specific custom content. The number of results is limited by the limit parameter and additional results (if available) will be available through the next URL present in the Link response header. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content of the custom content and its corresponding space. Authentication - Required Scopes: [read:attachment:confluence]

Parameter:

id - The ID of the custom content for which attachments should be returned. (required)

sort - Used to sort the result by a particular field. (optional)

cursor - Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results. (optional)

status - Filter the results to attachments based on their status. By default, current and archived are used. (optional)

mediaType - Filters on the mediaType of attachments. Only one may be specified. (optional)

filename - Filters on the file-name of attachments. Only one may be specified. (optional)

limit - Maximum number of attachments per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results. (optional, defaults to 50)

getCustomContentById

CompletableFuture<CustomContentSingle> getCustomContentById(@NotNull
 @NotNull Long id,
 @Nullable
 @Nullable CustomContentBodyRepresentationSingle bodyFormat,
 @Nullable
 @Nullable Integer version)

Get custom content by id

Returns a specific piece of custom content. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the custom content, the container of the custom content, and the corresponding space (if different from the container). Authentication - Required Scopes: [read:custom-content:confluence]

Parameter:

id - The ID of the custom content to be returned. If you don't know the custom content ID, use Get Custom Content by Type and filter the results. (required)

bodyFormat - The content format types to be returned in the body field of the response. If available, the representation will be available under a response field of the same name under the body field. Note: If the custom content body type is storage, the storage and atlas_doc_format body formats are able to be returned. If the custom content body type is raw, only the raw body format is able to be returned. (optional)

version - Allows you to retrieve a previously published version. Specify the previous version's number to retrieve its details. (optional)

getCustomContentByType

CompletableFuture<MultiEntityResultCustomContent> getCustomContentByType(@NotNull
 @NotNull String type,
 @Nullable
 @Nullable List<Long> id,
 @Nullable
 @Nullable List<Long> spaceId,
 @Nullable
 @Nullable CustomContentSortOrder sort,
 @Nullable
 @Nullable String cursor,
 @Nullable
 @Nullable Integer limit,
 @Nullable
 @Nullable CustomContentBodyRepresentation bodyFormat)

Get custom content by type

Returns all custom content for a given type. The number of results is limited by the limit parameter and additional results (if available) will be available through the next URL present in the Link response header. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the custom content, the container of the custom content, and the corresponding space (if different from the container). Authentication - Required Scopes: [read:custom-content:confluence]

Parameter:

type - The type of custom content being requested. See: https://developer.atlassian.com/cloud/confluence/custom-content/ for additional details on custom content. (required)

id - Filter the results based on custom content ids. Multiple custom content ids can be specified as a comma-separated list. (optional)

spaceId - Filter the results based on space ids. Multiple space ids can be specified as a comma-separated list. (optional)

sort - Used to sort the result by a particular field. (optional)

cursor - Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results. (optional)

limit - Maximum number of pages per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results. (optional, defaults to 25)

bodyFormat - The content format types to be returned in the body field of the response. If available, the representation will be available under a response field of the same name under the body field. Note: If the custom content body type is storage, the storage and atlas_doc_format body formats are able to be returned. If the custom content body type is raw, only the raw body format is able to be returned. (optional)

getCustomContentByTypeInBlogPost

CompletableFuture<MultiEntityResultCustomContent> getCustomContentByTypeInBlogPost(@NotNull
 @NotNull Long id,
 @NotNull
 @NotNull String type,
 @Nullable
 @Nullable CustomContentSortOrder sort,
 @Nullable
 @Nullable String cursor,
 @Nullable
 @Nullable Integer limit,
 @Nullable
 @Nullable CustomContentBodyRepresentation bodyFormat)

Get custom content by type in blog post

Returns all custom content for a given type within a given blogpost. The number of results is limited by the limit parameter and additional results (if available) will be available through the next URL present in the Link response header. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the custom content, the container of the custom content (blog post), and the corresponding space. Authentication - Required Scopes: [read:custom-content:confluence]

Parameter:

id - The ID of the blog post for which custom content should be returned. (required)

type - The type of custom content being requested. See: https://developer.atlassian.com/cloud/confluence/custom-content/ for additional details on custom content. (required)

sort - Used to sort the result by a particular field. (optional)

cursor - Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results. (optional)

limit - Maximum number of pages per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results. (optional, defaults to 25)

bodyFormat - The content format types to be returned in the body field of the response. If available, the representation will be available under a response field of the same name under the body field. Note: If the custom content body type is storage, the storage and atlas_doc_format body formats are able to be returned. If the custom content body type is raw, only the raw body format is able to be returned. (optional)

getCustomContentByTypeInPage

CompletableFuture<MultiEntityResultCustomContent> getCustomContentByTypeInPage(@NotNull
 @NotNull Long id,
 @NotNull
 @NotNull String type,
 @Nullable
 @Nullable CustomContentSortOrder sort,
 @Nullable
 @Nullable String cursor,
 @Nullable
 @Nullable Integer limit,
 @Nullable
 @Nullable CustomContentBodyRepresentation bodyFormat)

Get custom content by type in page

Returns all custom content for a given type within a given page. The number of results is limited by the limit parameter and additional results (if available) will be available through the next URL present in the Link response header. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the custom content, the container of the custom content (page), and the corresponding space. Authentication - Required Scopes: [read:custom-content:confluence]

Parameter:

id - The ID of the page for which custom content should be returned. (required)

type - The type of custom content being requested. See: https://developer.atlassian.com/cloud/confluence/custom-content/ for additional details on custom content. (required)

sort - Used to sort the result by a particular field. (optional)

cursor - Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results. (optional)

limit - Maximum number of pages per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results. (optional, defaults to 25)

bodyFormat - The content format types to be returned in the body field of the response. If available, the representation will be available under a response field of the same name under the body field. Note: If the custom content body type is storage, the storage and atlas_doc_format body formats are able to be returned. If the custom content body type is raw, only the raw body format is able to be returned. (optional)

getCustomContentByTypeInSpace

CompletableFuture<MultiEntityResultCustomContent> getCustomContentByTypeInSpace(@NotNull
 @NotNull Long id,
 @NotNull
 @NotNull String type,
 @Nullable
 @Nullable String cursor,
 @Nullable
 @Nullable Integer limit,
 @Nullable
 @Nullable CustomContentBodyRepresentation bodyFormat)

Get custom content by type in space

Returns all custom content for a given type within a given space. The number of results is limited by the limit parameter and additional results (if available) will be available through the next URL present in the Link response header. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the custom content and the corresponding space. Authentication - Required Scopes: [read:custom-content:confluence]

Parameter:

id - The ID of the space for which custom content should be returned. (required)

type - The type of custom content being requested. See: https://developer.atlassian.com/cloud/confluence/custom-content/ for additional details on custom content. (required)

cursor - Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results. (optional)

limit - Maximum number of pages per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results. (optional, defaults to 25)

bodyFormat - The content format types to be returned in the body field of the response. If available, the representation will be available under a response field of the same name under the body field. Note: If the custom content body type is storage, the storage and atlas_doc_format body formats are able to be returned. If the custom content body type is raw, only the raw body format is able to be returned. (optional)

getCustomContentComments

CompletableFuture<MultiEntityResultCustomContentCommentModel> getCustomContentComments(@NotNull
 @NotNull Long id,
 @Nullable
 @Nullable PrimaryBodyRepresentation bodyFormat,
 @Nullable
 @Nullable String cursor,
 @Nullable
 @Nullable Integer limit,
 @Nullable
 @Nullable CommentSortOrder sort)

Get custom content comments

Returns the comments of the specific custom content. The number of results is limited by the limit parameter and additional results (if available) will be available through the next URL present in the Link response header. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the custom content and its corresponding containers. Authentication - Required Scopes: [read:comment:confluence]

Parameter:

id - The ID of the custom content for which comments should be returned. (required)

bodyFormat - The content format type to be returned in the body field of the response. If available, the representation will be available under a response field of the same name under the body field. (optional)

cursor - Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results. (optional)

limit - Maximum number of comments per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results. (optional, defaults to 25)

sort - Used to sort the result by a particular field. (optional)

getCustomContentContentProperties

CompletableFuture<MultiEntityResultContentProperty> getCustomContentContentProperties(@NotNull
 @NotNull Long customContentId,
 @Nullable
 @Nullable String key,
 @Nullable
 @Nullable ContentPropertySortOrder sort,
 @Nullable
 @Nullable String cursor,
 @Nullable
 @Nullable Integer limit)

Get content properties for custom content

Retrieves Content Properties tied to a specified custom content. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the custom content. Authentication - Required Scopes: [read:custom-content:confluence]

Parameter:

customContentId - The ID of the custom content for which content properties should be returned. (required)

key - Filters the response to return a specific content property with matching key (case sensitive). (optional)

sort - Used to sort the result by a particular field. (optional)

cursor - Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results. (optional)

limit - Maximum number of attachments per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results. (optional, defaults to 25)

getCustomContentContentPropertiesById

CompletableFuture<ContentProperty> getCustomContentContentPropertiesById(@NotNull
 @NotNull Long customContentId,
 @NotNull
 @NotNull Long propertyId)

Get content property for custom content by id

Retrieves a specific Content Property by ID that is attached to a specified custom content. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the page. Authentication - Required Scopes: [read:custom-content:confluence]

Parameter:

customContentId - The ID of the custom content for which content properties should be returned. (required)

propertyId - The ID of the content property being requested. (required)

getCustomContentLabels

CompletableFuture<MultiEntityResultLabel> getCustomContentLabels(@NotNull
 @NotNull Long id,
 @Nullable
 @Nullable String prefix,
 @Nullable
 @Nullable List<LabelSortOrder> sort,
 @Nullable
 @Nullable String cursor,
 @Nullable
 @Nullable Integer limit)

Get labels for custom content

Returns the labels for a specific piece of custom content. The number of results is limited by the limit parameter and additional results (if available) will be available through the next URL present in the Link response header. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the custom content and its corresponding space. Authentication - Required Scopes: [read:custom-content:confluence]

Parameter:

id - The ID of the custom content for which labels should be returned. (required)

prefix - Filter the results to labels based on their prefix. (optional)

sort - Used to sort the result by a particular field. (optional)

cursor - Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results. (optional)

limit - Maximum number of labels per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results. (optional, defaults to 25)

getCustomContentOperations

CompletableFuture<PermittedOperationsResponse> getCustomContentOperations(@NotNull
 @NotNull Long id)

Get permitted operations for custom content

Returns the permitted operations on specific custom content. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the parent content of the custom content and its corresponding space. Authentication - Required Scopes: [read:custom-content:confluence]

Parameter:

id - The ID of the custom content for which operations should be returned. (required)

getCustomContentVersionDetails

CompletableFuture<DetailedVersion> getCustomContentVersionDetails(@NotNull
 @NotNull Long customContentId,
 @NotNull
 @NotNull Long versionNumber)

Get version details for custom content version

Retrieves version details for the specified custom content and version number. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the page. Authentication - Required Scopes: [read:custom-content:confluence]

Parameter:

customContentId - The ID of the custom content for which version details should be returned. (required)

versionNumber - The version number of the custom content to be returned. (required)

getCustomContentVersions

CompletableFuture<MultiEntityResultVersion3> getCustomContentVersions(@NotNull
 @NotNull Long customContentId,
 @Nullable
 @Nullable CustomContentBodyRepresentation bodyFormat,
 @Nullable
 @Nullable String cursor,
 @Nullable
 @Nullable Integer limit,
 @Nullable
 @Nullable VersionSortOrder sort)

Get custom content versions

Returns the versions of specific custom content. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the custom content and its corresponding page and space. Authentication - Required Scopes: [read:custom-content:confluence]

Parameter:

customContentId - The ID of the custom content to be queried for its versions. If you don't know the custom content ID, use Get custom-content by type and filter the results. (required)

bodyFormat - The content format types to be returned in the body field of the response. If available, the representation will be available under a response field of the same name under the body field. Note: If the custom content body type is storage, the storage and atlas_doc_format body formats are able to be returned. If the custom content body type is raw, only the raw body format is able to be returned. (optional)

cursor - Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results. (optional)

limit - Maximum number of versions per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results. (optional, defaults to 25)

sort - Used to sort the result by a particular field. (optional)

getDataPolicyMetadata

CompletableFuture<DataPolicyMetadata> getDataPolicyMetadata()

Get data policy metadata for the workspace (EAP)

Returns data policy metadata for the workspace. **[Permissions](#permissions) required:** Only apps can make this request. Permission to access the Confluence site ('Can use' global permission).

getDataPolicySpaces

CompletableFuture<MultiEntityResultDataPolicySpace> getDataPolicySpaces(@Nullable
 @Nullable List<Long> ids,
 @Nullable
 @Nullable List<String> keys,
 @Nullable
 @Nullable SpaceSortOrder sort,
 @Nullable
 @Nullable String cursor,
 @Nullable
 @Nullable Integer limit)

Get spaces with data policies (EAP)

Returns all spaces. The results will be sorted by id ascending. The number of results is limited by the limit parameter and additional results (if available) will be available through the next URL present in the Link response header. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Only apps can make this request. Permission to access the Confluence site ('Can use' global permission). Only spaces that the app has permission to view will be returned. Authentication - Required Scopes: [read:space:confluence]

Parameter:

ids - Filter the results to spaces based on their IDs. Multiple IDs can be specified as a comma-separated list. (optional)

keys - Filter the results to spaces based on their keys. Multiple keys can be specified as a comma-separated list. (optional)

sort - Used to sort the result by a particular field. (optional)

cursor - Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results. (optional)

limit - Maximum number of spaces per result to return. If more results exist, use the Link response header to retrieve a relative URL that will return the next set of results. (optional, defaults to 25)

getFooterCommentById

CompletableFuture<FooterCommentModel> getFooterCommentById(@NotNull
 @NotNull Long commentId,
 @Nullable
 @Nullable PrimaryBodyRepresentationSingle bodyFormat,
 @Nullable
 @Nullable Integer version)

Get footer comment by id

Retrieves a footer comment by id **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content of the container and its corresponding space. Authentication - Required Scopes: [read:comment:confluence]

Parameter:

commentId - The ID of the comment to be retrieved. (required)

bodyFormat - The content format type to be returned in the body field of the response. If available, the representation will be available under a response field of the same name under the body field. (optional)

version - Allows you to retrieve a previously published version. Specify the previous version's number to retrieve its details. (optional)

getFooterCommentChildren

CompletableFuture<MultiEntityResultChildrenCommentModel> getFooterCommentChildren(@NotNull
 @NotNull Long id,
 @Nullable
 @Nullable PrimaryBodyRepresentation bodyFormat,
 @Nullable
 @Nullable CommentSortOrder sort,
 @Nullable
 @Nullable String cursor,
 @Nullable
 @Nullable Integer limit)

Get children footer comments

Returns the children footer comments of specific comment. The number of results is limited by the limit parameter and additional results (if available) will be available through the next URL present in the Link response header. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content of the page and its corresponding space. Authentication - Required Scopes: [read:comment:confluence]

Parameter:

id - The ID of the parent comment for which footer comment children should be returned. (required)

bodyFormat - The content format type to be returned in the body field of the response. If available, the representation will be available under a response field of the same name under the body field. (optional)

sort - Used to sort the result by a particular field. (optional)

cursor - Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results. (optional)

limit - Maximum number of footer comments per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results. (optional, defaults to 25)

getFooterCommentOperations

CompletableFuture<PermittedOperationsResponse> getFooterCommentOperations(@NotNull
 @NotNull Long id)

Get permitted operations for footer comment

Returns the permitted operations on specific footer comment. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the parent content of the footer comment and its corresponding space. Authentication - Required Scopes: [read:comment:confluence]

Parameter:

id - The ID of the footer comment for which operations should be returned. (required)

getFooterCommentVersionDetails

CompletableFuture<DetailedVersion> getFooterCommentVersionDetails(@NotNull
 @NotNull Long id,
 @NotNull
 @NotNull Long versionNumber)

Get version details for footer comment version

Retrieves version details for the specified footer comment version. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content of the page or blog post and its corresponding space. Authentication - Required Scopes: [read:comment:confluence]

Parameter:

id - The ID of the footer comment for which version details should be returned. (required)

versionNumber - The version number of the footer comment to be returned. (required)

getFooterCommentVersions

CompletableFuture<MultiEntityResultVersion4> getFooterCommentVersions(@NotNull
 @NotNull Long id,
 @Nullable
 @Nullable PrimaryBodyRepresentation bodyFormat,
 @Nullable
 @Nullable String cursor,
 @Nullable
 @Nullable Integer limit,
 @Nullable
 @Nullable VersionSortOrder sort)

Get footer comment versions

Retrieves the versions of the specified footer comment. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content of the page or blog post and its corresponding space. Authentication - Required Scopes: [read:comment:confluence]

Parameter:

id - The ID of the footer comment for which versions should be returned (required)

bodyFormat - The content format types to be returned in the body field of the response. If available, the representation will be available under a response field of the same name under the body field. (optional)

cursor - Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results. (optional)

limit - Maximum number of versions per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results. (optional, defaults to 25)

sort - Used to sort the result by a particular field. (optional)

getFooterComments

CompletableFuture<MultiEntityResultFooterCommentModel> getFooterComments(@Nullable
 @Nullable PrimaryBodyRepresentation bodyFormat,
 @Nullable
 @Nullable CommentSortOrder sort,
 @Nullable
 @Nullable String cursor,
 @Nullable
 @Nullable Integer limit)

Get footer comments

Returns all footer comments. The number of results is limited by the limit parameter and additional results (if available) will be available through the next URL present in the Link response header. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content of the container and its corresponding space. Authentication - Required Scopes: [read:comment:confluence]

Parameter:

bodyFormat - The content format type to be returned in the body field of the response. If available, the representation will be available under a response field of the same name under the body field. (optional)

sort - Used to sort the result by a particular field. (optional)

cursor - Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results. (optional)

limit - Maximum number of footer comments per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results. (optional, defaults to 25)

getFooterLikeCount

CompletableFuture<Integer> getFooterLikeCount(@NotNull
 @NotNull Long id)

Get like count for footer comment

Returns the count of likes of specific footer comment. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content of the page/blogpost and its corresponding space. Authentication - Required Scopes: [read:comment:confluence]

Parameter:

id - The ID of the footer comment for which like count should be returned. (required)

getFooterLikeUsers

CompletableFuture<MultiEntityResultString> getFooterLikeUsers(@NotNull
 @NotNull Long id,
 @Nullable
 @Nullable String cursor,
 @Nullable
 @Nullable Integer limit)

Get account IDs of likes for footer comment

Returns the account IDs of likes of specific footer comment. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content of the page/blogpost and its corresponding space. Authentication - Required Scopes: [read:comment:confluence]

Parameter:

id - The ID of the footer comment for which like count should be returned. (required)

cursor - Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results. (optional)

limit - Maximum number of account IDs per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results. (optional, defaults to 25)

getInlineCommentById

CompletableFuture<InlineCommentModel> getInlineCommentById(@NotNull
 @NotNull Long commentId,
 @Nullable
 @Nullable PrimaryBodyRepresentationSingle bodyFormat,
 @Nullable
 @Nullable Integer version)

Get inline comment by id

Retrieves an inline comment by id **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content of the page or blogpost and its corresponding space. Authentication - Required Scopes: [read:comment:confluence]

Parameter:

commentId - The ID of the comment to be retrieved. (required)

bodyFormat - The content format type to be returned in the body field of the response. If available, the representation will be available under a response field of the same name under the body field. (optional)

version - Allows you to retrieve a previously published version. Specify the previous version's number to retrieve its details. (optional)

getInlineCommentChildren

CompletableFuture<MultiEntityResultInlineCommentChildrenModel> getInlineCommentChildren(@NotNull
 @NotNull Long id,
 @Nullable
 @Nullable PrimaryBodyRepresentation bodyFormat,
 @Nullable
 @Nullable CommentSortOrder sort,
 @Nullable
 @Nullable String cursor,
 @Nullable
 @Nullable Integer limit)

Get children inline comments

Returns the children inline comments of specific comment. The number of results is limited by the limit parameter and additional results (if available) will be available through the next URL present in the Link response header. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content of the page and its corresponding space. Authentication - Required Scopes: [read:comment:confluence]

Parameter:

id - The ID of the parent comment for which inline comment children should be returned. (required)

bodyFormat - The content format type to be returned in the body field of the response. If available, the representation will be available under a response field of the same name under the body field. (optional)

sort - Used to sort the result by a particular field. (optional)

cursor - Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results. (optional)

limit - Maximum number of footer comments per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results. (optional, defaults to 25)

getInlineCommentOperations

CompletableFuture<PermittedOperationsResponse> getInlineCommentOperations(@NotNull
 @NotNull Long id)

Get permitted operations for inline comment

Returns the permitted operations on specific inline comment. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the parent content of the inline comment and its corresponding space. Authentication - Required Scopes: [read:comment:confluence]

Parameter:

id - The ID of the inline comment for which operations should be returned. (required)

getInlineCommentVersionDetails

CompletableFuture<DetailedVersion> getInlineCommentVersionDetails(@NotNull
 @NotNull Long id,
 @NotNull
 @NotNull Long versionNumber)

Get version details for inline comment version

Retrieves version details for the specified inline comment version. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content of the page or blog post and its corresponding space. Authentication - Required Scopes: [read:comment:confluence]

Parameter:

id - The ID of the inline comment for which version details should be returned. (required)

versionNumber - The version number of the inline comment to be returned. (required)

getInlineCommentVersions

CompletableFuture<MultiEntityResultVersion4> getInlineCommentVersions(@NotNull
 @NotNull Long id,
 @Nullable
 @Nullable PrimaryBodyRepresentation bodyFormat,
 @Nullable
 @Nullable String cursor,
 @Nullable
 @Nullable Integer limit,
 @Nullable
 @Nullable VersionSortOrder sort)

Get inline comment versions

Retrieves the versions of the specified inline comment. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content of the page or blog post and its corresponding space. Authentication - Required Scopes: [read:comment:confluence]

Parameter:

id - The ID of the inline comment for which versions should be returned (required)

bodyFormat - The content format types to be returned in the body field of the response. If available, the representation will be available under a response field of the same name under the body field. (optional)

cursor - Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results. (optional)

limit - Maximum number of versions per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results. (optional, defaults to 25)

sort - Used to sort the result by a particular field. (optional)

getInlineComments

CompletableFuture<MultiEntityResultInlineCommentModel> getInlineComments(@Nullable
 @Nullable PrimaryBodyRepresentation bodyFormat,
 @Nullable
 @Nullable CommentSortOrder sort,
 @Nullable
 @Nullable String cursor,
 @Nullable
 @Nullable Integer limit)

Get inline comments

Returns all inline comments. The number of results is limited by the limit parameter and additional results (if available) will be available through the next URL present in the Link response header. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content of the page and its corresponding space. Authentication - Required Scopes: [read:comment:confluence]

Parameter:

bodyFormat - The content format type to be returned in the body field of the response. If available, the representation will be available under a response field of the same name under the body field. (optional)

sort - Used to sort the result by a particular field. (optional)

cursor - Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results. (optional)

limit - Maximum number of footer comments per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results. (optional, defaults to 25)

getInlineLikeCount

CompletableFuture<Integer> getInlineLikeCount(@NotNull
 @NotNull Long id)

Get like count for inline comment

Returns the count of likes of specific inline comment. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content of the page/blogpost and its corresponding space. Authentication - Required Scopes: [read:comment:confluence]

Parameter:

id - The ID of the inline comment for which like count should be returned. (required)

getInlineLikeUsers

CompletableFuture<MultiEntityResultString> getInlineLikeUsers(@NotNull
 @NotNull Long id,
 @Nullable
 @Nullable String cursor,
 @Nullable
 @Nullable Integer limit)

Get account IDs of likes for inline comment

Returns the account IDs of likes of specific inline comment. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content of the page/blogpost and its corresponding space. Authentication - Required Scopes: [read:comment:confluence]

Parameter:

id - The ID of the inline comment for which like count should be returned. (required)

cursor - Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results. (optional)

limit - Maximum number of account IDs per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results. (optional, defaults to 25)

getLabelAttachments

CompletableFuture<MultiEntityResultAttachment1> getLabelAttachments(@NotNull
 @NotNull Long id,
 @Nullable
 @Nullable AttachmentSortOrder sort,
 @Nullable
 @Nullable String cursor,
 @Nullable
 @Nullable Integer limit)

Get attachments for label

Returns the attachments of specified label. The number of results is limited by the limit parameter and additional results (if available) will be available through the next URL present in the Link response header. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the attachment and its corresponding space. Authentication - Required Scopes: [read:attachment:confluence]

Parameter:

id - The ID of the label for which attachments should be returned. (required)

sort - Used to sort the result by a particular field. (optional)

cursor - Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results. (optional)

limit - Maximum number of pages per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results. (optional, defaults to 25)

getLabelBlogPosts

CompletableFuture<MultiEntityResultBlogPost> getLabelBlogPosts(@NotNull
 @NotNull Long id,
 @Nullable
 @Nullable List<Long> spaceId,
 @Nullable
 @Nullable PrimaryBodyRepresentation bodyFormat,
 @Nullable
 @Nullable BlogPostSortOrder sort,
 @Nullable
 @Nullable String cursor,
 @Nullable
 @Nullable Integer limit)

Get blog posts for label

Returns the blogposts of specified label. The number of results is limited by the limit parameter and additional results (if available) will be available through the next URL present in the Link response header. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content of the page and its corresponding space. Authentication - Required Scopes: [read:page:confluence]

Parameter:

id - The ID of the label for which blog posts should be returned. (required)

spaceId - Filter the results based on space ids. Multiple space ids can be specified as a comma-separated list. (optional)

bodyFormat - The content format types to be returned in the body field of the response. If available, the representation will be available under a response field of the same name under the body field. (optional)

sort - Used to sort the result by a particular field. (optional)

cursor - Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results. (optional)

limit - Maximum number of blog posts per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results. (optional, defaults to 25)

getLabelPages

CompletableFuture<MultiEntityResultPage> getLabelPages(@NotNull
 @NotNull Long id,
 @Nullable
 @Nullable List<Long> spaceId,
 @Nullable
 @Nullable PrimaryBodyRepresentation bodyFormat,
 @Nullable
 @Nullable PageSortOrder sort,
 @Nullable
 @Nullable String cursor,
 @Nullable
 @Nullable Integer limit)

Get pages for label

Returns the pages of specified label. The number of results is limited by the limit parameter and additional results (if available) will be available through the next URL present in the Link response header. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content of the page and its corresponding space. Authentication - Required Scopes: [read:page:confluence]

Parameter:

id - The ID of the label for which pages should be returned. (required)

spaceId - Filter the results based on space ids. Multiple space ids can be specified as a comma-separated list. (optional)

bodyFormat - The content format types to be returned in the body field of the response. If available, the representation will be available under a response field of the same name under the body field. (optional)

sort - Used to sort the result by a particular field. (optional)

cursor - Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results. (optional)

limit - Maximum number of pages per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results. (optional, defaults to 25)

getLabels

CompletableFuture<MultiEntityResultLabel1> getLabels(@Nullable
 @Nullable List<Long> labelId,
 @Nullable
 @Nullable List<String> prefix,
 @Nullable
 @Nullable String cursor,
 @Nullable
 @Nullable List<LabelSortOrder> sort,
 @Nullable
 @Nullable Integer limit)

Get labels

Returns all labels. The number of results is limited by the limit parameter and additional results (if available) will be available through the next URL present in the Link response header. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site ('Can use' global permission). Only labels that the user has permission to view will be returned.

Parameter:

labelId - Filters on label ID. Multiple IDs can be specified as a comma-separated list. (optional)

prefix - Filters on label prefix. Multiple IDs can be specified as a comma-separated list. (optional)

cursor - Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results. (optional)

sort - Used to sort the result by a particular field. (optional)

limit - Maximum number of labels per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results. (optional, defaults to 25)

getPageAncestors

CompletableFuture<MultiEntityResultAncestor> getPageAncestors(@NotNull
 @NotNull Long id,
 @Nullable
 @Nullable Integer limit)

Get all ancestors of page

Returns all ancestors for a given page by ID in top-to-bottom order (that is, the highest ancestor is the first item in the response payload). The number of results is limited by the limit parameter and additional results (if available) will be available by calling this endpoint with the ID of first ancestor in the response payload. This endpoint returns minimal information about each ancestor. To fetch more details, use a related endpoint, such as [Get page by id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-page/#api-pages-id-get). **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site ('Can use' global permission).

Parameter:

id - The ID of the page. (required)

limit - Maximum number of pages per result to return. If more results exist, call this endpoint with the highest ancestor's ID to fetch the next set of results. (optional, defaults to 25)

getPageAttachments

CompletableFuture<MultiEntityResultAttachment> getPageAttachments(@NotNull
 @NotNull Long id,
 @Nullable
 @Nullable AttachmentSortOrder sort,
 @Nullable
 @Nullable String cursor,
 @Nullable
 @Nullable List<String> status,
 @Nullable
 @Nullable String mediaType,
 @Nullable
 @Nullable String filename,
 @Nullable
 @Nullable Integer limit)

Get attachments for page

Returns the attachments of specific page. The number of results is limited by the limit parameter and additional results (if available) will be available through the next URL present in the Link response header. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content of the page and its corresponding space. Authentication - Required Scopes: [read:attachment:confluence]

Parameter:

id - The ID of the page for which attachments should be returned. (required)

sort - Used to sort the result by a particular field. (optional)

cursor - Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results. (optional)

status - Filter the results to attachments based on their status. By default, current and archived are used. (optional)

mediaType - Filters on the mediaType of attachments. Only one may be specified. (optional)

filename - Filters on the file-name of attachments. Only one may be specified. (optional)

limit - Maximum number of attachments per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results. (optional, defaults to 50)

getPageById

CompletableFuture<PageSingle> getPageById(@NotNull
 @NotNull Long id,
 @Nullable
 @Nullable PrimaryBodyRepresentationSingle bodyFormat,
 @Nullable
 @Nullable Boolean getDraft,
 @Nullable
 @Nullable Integer version)

Get page by id

Returns a specific page. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the page and its corresponding space. Authentication - Required Scopes: [read:page:confluence]

Parameter:

id - The ID of the page to be returned. If you don't know the page ID, use Get pages and filter the results. (required)

bodyFormat - The content format types to be returned in the body field of the response. If available, the representation will be available under a response field of the same name under the body field. (optional)

getDraft - Retrieve the draft version of this page. (optional, defaults to false)

version - Allows you to retrieve a previously published version. Specify the previous version's number to retrieve its details. (optional)

getPageContentProperties

CompletableFuture<MultiEntityResultContentProperty> getPageContentProperties(@NotNull
 @NotNull Long pageId,
 @Nullable
 @Nullable String key,
 @Nullable
 @Nullable ContentPropertySortOrder sort,
 @Nullable
 @Nullable String cursor,
 @Nullable
 @Nullable Integer limit)

Get content properties for page

Retrieves Content Properties tied to a specified page. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the page. Authentication - Required Scopes: [read:page:confluence]

Parameter:

pageId - The ID of the page for which content properties should be returned. (required)

key - Filters the response to return a specific content property with matching key (case sensitive). (optional)

sort - Used to sort the result by a particular field. (optional)

cursor - Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results. (optional)

limit - Maximum number of attachments per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results. (optional, defaults to 25)

getPageContentPropertiesById

CompletableFuture<ContentProperty> getPageContentPropertiesById(@NotNull
 @NotNull Long pageId,
 @NotNull
 @NotNull Long propertyId)

Get content property for page by id

Retrieves a specific Content Property by ID that is attached to a specified page. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the page. Authentication - Required Scopes: [read:page:confluence]

Parameter:

pageId - The ID of the page for which content properties should be returned. (required)

propertyId - The ID of the content property being requested. (required)

getPageFooterComments

CompletableFuture<MultiEntityResultPageCommentModel> getPageFooterComments(@NotNull
 @NotNull Long id,
 @Nullable
 @Nullable PrimaryBodyRepresentation bodyFormat,
 @Nullable
 @Nullable CommentSortOrder sort,
 @Nullable
 @Nullable String cursor,
 @Nullable
 @Nullable Integer limit)

Get footer comments for page

Returns the root footer comments of specific page. The number of results is limited by the limit parameter and additional results (if available) will be available through the next URL present in the Link response header. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content of the page and its corresponding space. Authentication - Required Scopes: [read:comment:confluence]

Parameter:

id - The ID of the page for which footer comments should be returned. (required)

bodyFormat - The content format type to be returned in the body field of the response. If available, the representation will be available under a response field of the same name under the body field. (optional)

sort - Used to sort the result by a particular field. (optional)

cursor - Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results. (optional)

limit - Maximum number of footer comments per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results. (optional, defaults to 25)

getPageInlineComments

CompletableFuture<MultiEntityResultPageInlineCommentModel> getPageInlineComments(@NotNull
 @NotNull Long id,
 @Nullable
 @Nullable PrimaryBodyRepresentation bodyFormat,
 @Nullable
 @Nullable CommentSortOrder sort,
 @Nullable
 @Nullable String cursor,
 @Nullable
 @Nullable Integer limit)

Get inline comments for page

Returns the root inline comments of specific page. The number of results is limited by the limit parameter and additional results (if available) will be available through the next URL present in the Link response header. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content of the page and its corresponding space. Authentication - Required Scopes: [read:comment:confluence]

Parameter:

id - The ID of the page for which inline comments should be returned. (required)

bodyFormat - The content format type to be returned in the body field of the response. If available, the representation will be available under a response field of the same name under the body field. (optional)

sort - Used to sort the result by a particular field. (optional)

cursor - Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results. (optional)

limit - Maximum number of inline comments per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results. (optional, defaults to 25)

getPageLabels

CompletableFuture<MultiEntityResultLabel> getPageLabels(@NotNull
 @NotNull Long id,
 @Nullable
 @Nullable String prefix,
 @Nullable
 @Nullable List<LabelSortOrder> sort,
 @Nullable
 @Nullable String cursor,
 @Nullable
 @Nullable Integer limit)

Get labels for page

Returns the labels of specific page. The number of results is limited by the limit parameter and additional results (if available) will be available through the next URL present in the Link response header. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content of the page and its corresponding space. Authentication - Required Scopes: [read:page:confluence]

Parameter:

id - The ID of the page for which labels should be returned. (required)

prefix - Filter the results to labels based on their prefix. (optional)

sort - Used to sort the result by a particular field. (optional)

cursor - Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results. (optional)

limit - Maximum number of labels per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results. (optional, defaults to 25)

getPageLikeCount

CompletableFuture<Integer> getPageLikeCount(@NotNull
 @NotNull Long id)

Get like count for page

Returns the count of likes of specific page. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content of the page and its corresponding space. Authentication - Required Scopes: [read:page:confluence]

Parameter:

id - The ID of the page for which like count should be returned. (required)

getPageLikeUsers

CompletableFuture<MultiEntityResultString> getPageLikeUsers(@NotNull
 @NotNull Long id,
 @Nullable
 @Nullable String cursor,
 @Nullable
 @Nullable Integer limit)

Get account IDs of likes for page

Returns the account IDs of likes of specific page. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content of the page and its corresponding space. Authentication - Required Scopes: [read:page:confluence]

Parameter:

id - The ID of the page for which like count should be returned. (required)

cursor - Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results. (optional)

limit - Maximum number of account IDs per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results. (optional, defaults to 25)

getPageOperations

CompletableFuture<PermittedOperationsResponse> getPageOperations(@NotNull
 @NotNull Long id)

Get permitted operations for page

Returns the permitted operations on specific page. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the parent content of the page and its corresponding space. Authentication - Required Scopes: [read:page:confluence]

Parameter:

id - The ID of the page for which operations should be returned. (required)

getPageVersionDetails

CompletableFuture<DetailedVersion> getPageVersionDetails(@NotNull
 @NotNull Long pageId,
 @NotNull
 @NotNull Long versionNumber)

Get version details for page version

Retrieves version details for the specified page and version number. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the page. Authentication - Required Scopes: [read:page:confluence]

Parameter:

pageId - The ID of the page for which version details should be returned. (required)

versionNumber - The version number of the page to be returned. (required)

getPageVersions

CompletableFuture<MultiEntityResultVersion2> getPageVersions(@NotNull
 @NotNull Long id,
 @Nullable
 @Nullable PrimaryBodyRepresentation bodyFormat,
 @Nullable
 @Nullable String cursor,
 @Nullable
 @Nullable Integer limit,
 @Nullable
 @Nullable VersionSortOrder sort)

Get page versions

Returns the versions of specific page. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the page and its corresponding space. Authentication - Required Scopes: [read:page:confluence]

Parameter:

id - The ID of the page to be queried for its versions. If you don't know the page ID, use Get pages and filter the results. (required)

bodyFormat - The content format types to be returned in the body field of the response. If available, the representation will be available under a response field of the same name under the body field. (optional)

cursor - Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results. (optional)

limit - Maximum number of versions per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results. (optional, defaults to 25)

sort - Used to sort the result by a particular field. (optional)

getPages

CompletableFuture<MultiEntityResultPage> getPages(@Nullable
 @Nullable List<Long> id,
 @Nullable
 @Nullable List<Long> spaceId,
 @Nullable
 @Nullable PageSortOrder sort,
 @Nullable
 @Nullable List<String> status,
 @Nullable
 @Nullable String title,
 @Nullable
 @Nullable PrimaryBodyRepresentation bodyFormat,
 @Nullable
 @Nullable String cursor,
 @Nullable
 @Nullable Integer limit)

Get pages

Returns all pages. The number of results is limited by the limit parameter and additional results (if available) will be available through the next URL present in the Link response header. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site ('Can use' global permission). Only pages that the user has permission to view will be returned. Authentication - Required Scopes: [read:page:confluence]

Parameter:

id - Filter the results based on page ids. Multiple page ids can be specified as a comma-separated list. (optional)

spaceId - Filter the results based on space ids. Multiple space ids can be specified as a comma-separated list. (optional)

sort - Used to sort the result by a particular field. (optional)

status - Filter the results to pages based on their status. By default, current and archived are used. (optional)

title - Filter the results to pages based on their title. (optional)

bodyFormat - The content format types to be returned in the body field of the response. If available, the representation will be available under a response field of the same name under the body field. (optional)

cursor - Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results. (optional)

limit - Maximum number of pages per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results. (optional, defaults to 25)

getPagesInSpace

CompletableFuture<MultiEntityResultPage> getPagesInSpace(@NotNull
 @NotNull Long id,
 @Nullable
 @Nullable String depth,
 @Nullable
 @Nullable PageSortOrder sort,
 @Nullable
 @Nullable List<String> status,
 @Nullable
 @Nullable String title,
 @Nullable
 @Nullable PrimaryBodyRepresentation bodyFormat,
 @Nullable
 @Nullable String cursor,
 @Nullable
 @Nullable Integer limit)

Get pages in space

Returns all pages in a space. The number of results is limited by the limit parameter and additional results (if available) will be available through the next URL present in the Link response header. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site ('Can use' global permission) and 'View' permission for the space. Only pages that the user has permission to view will be returned. Authentication - Required Scopes: [read:page:confluence]

Parameter:

id - The ID of the space for which pages should be returned. (required)

depth - Filter the results to pages at the root level of the space or to all pages in the space. (optional, defaults to all)

sort - Used to sort the result by a particular field. (optional)

status - Filter the results to pages based on their status. By default, current and archived are used. (optional)

title - Filter the results to pages based on their title. (optional)

bodyFormat - The content format types to be returned in the body field of the response. If available, the representation will be available under a response field of the same name under the body field. (optional)

cursor - Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results. (optional)

limit - Maximum number of pages per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results. (optional, defaults to 25)

getSpaceById

CompletableFuture<Space> getSpaceById(@NotNull
 @NotNull Long id,
 @Nullable
 @Nullable SpaceDescriptionBodyRepresentation descriptionFormat,
 @Nullable
 @Nullable Boolean includeIcon)

Get space by id

Returns a specific space. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the space. Authentication - Required Scopes: [read:space:confluence]

Parameter:

id - The ID of the space to be returned. (required)

descriptionFormat - The content format type to be returned in the description field of the response. If available, the representation will be available under a response field of the same name under the description field. (optional)

includeIcon - If the icon for the space should be fetched or not. (optional, defaults to false)

getSpaceContentLabels

CompletableFuture<MultiEntityResultLabel> getSpaceContentLabels(@NotNull
 @NotNull Long id,
 @Nullable
 @Nullable String prefix,
 @Nullable
 @Nullable List<LabelSortOrder> sort,
 @Nullable
 @Nullable String cursor,
 @Nullable
 @Nullable Integer limit)

Get labels for space content

Returns the labels of space content (pages, blogposts etc). The number of results is limited by the limit parameter and additional results (if available) will be available through the next URL present in the Link response header. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the space. Authentication - Required Scopes: [read:space:confluence]

Parameter:

id - The ID of the space for which labels should be returned. (required)

prefix - Filter the results to labels based on their prefix. (optional, defaults to my, team)

sort - Used to sort the result by a particular field. (optional)

cursor - Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results. (optional)

limit - Maximum number of labels per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results. (optional, defaults to 25)

getSpaceLabels

CompletableFuture<MultiEntityResultLabel> getSpaceLabels(@NotNull
 @NotNull Long id,
 @Nullable
 @Nullable String prefix,
 @Nullable
 @Nullable List<LabelSortOrder> sort,
 @Nullable
 @Nullable String cursor,
 @Nullable
 @Nullable Integer limit)

Get labels for space

Returns the labels of specific space. The number of results is limited by the limit parameter and additional results (if available) will be available through the next URL present in the Link response header. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the space. Authentication - Required Scopes: [read:space:confluence]

Parameter:

id - The ID of the space for which labels should be returned. (required)

prefix - Filter the results to labels based on their prefix. (optional, defaults to my, team)

sort - Used to sort the result by a particular field. (optional)

cursor - Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results. (optional)

limit - Maximum number of labels per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results. (optional, defaults to 25)

getSpaceOperations

CompletableFuture<PermittedOperationsResponse> getSpaceOperations(@NotNull
 @NotNull Long id)

Get permitted operations for space

Returns the permitted operations on specific space. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the corresponding space. Authentication - Required Scopes: [read:space:confluence]

Parameter:

id - The ID of the space for which operations should be returned. (required)

getSpacePermissions

CompletableFuture<MultiEntityResultSpacePermission> getSpacePermissions(@NotNull
 @NotNull Long id,
 @Nullable
 @Nullable String cursor,
 @Nullable
 @Nullable Integer limit)

Get space permissions

Returns space permissions for a specific space. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the space.

Parameter:

id - The ID of the space to be returned. (required)

cursor - Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results. (optional)

limit - Maximum number of spaces per result to return. If more results exist, use the Link response header to retrieve a relative URL that will return the next set of results. (optional, defaults to 25)

getSpaceProperties

CompletableFuture<MultiEntityResultSpaceProperty> getSpaceProperties(@NotNull
 @NotNull Long spaceId,
 @Nullable
 @Nullable String key,
 @Nullable
 @Nullable String cursor,
 @Nullable
 @Nullable Integer limit)

Get space properties in space

Returns all properties for the given space. Space properties are a key-value storage associated with a space. The limit parameter specifies the maximum number of results returned in a single response. Use the link response header to paginate through additional results. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site ('Can use' global permission) and 'View' permission for the space. Authentication - Required Scopes: [read:space:confluence]

Parameter:

spaceId - The ID of the space for which space properties should be returned. (required)

key - The key of the space property to retrieve. This should be used when a user knows the key of their property, but needs to retrieve the id for use in other methods. (optional)

cursor - Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results. (optional)

limit - Maximum number of pages per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results. (optional, defaults to 25)

getSpacePropertyById

CompletableFuture<SpaceProperty> getSpacePropertyById(@NotNull
 @NotNull Long spaceId,
 @NotNull
 @NotNull Long propertyId)

Get space property by id

Retrieve a space property by its id. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site ('Can use' global permission) and 'View' permission for the space. Authentication - Required Scopes: [read:space:confluence]

Parameter:

spaceId - The ID of the space the property belongs to. (required)

propertyId - The ID of the property to be retrieved. (required)

getSpaces

CompletableFuture<MultiEntityResultSpace> getSpaces(@Nullable
 @Nullable List<Long> ids,
 @Nullable
 @Nullable List<String> keys,
 @Nullable
 @Nullable String type,
 @Nullable
 @Nullable String status,
 @Nullable
 @Nullable List<String> labels,
 @Nullable
 @Nullable SpaceSortOrder sort,
 @Nullable
 @Nullable SpaceDescriptionBodyRepresentation descriptionFormat,
 @Nullable
 @Nullable Boolean includeIcon,
 @Nullable
 @Nullable String cursor,
 @Nullable
 @Nullable Integer limit)

Get spaces

Returns all spaces. The results will be sorted by id ascending. The number of results is limited by the limit parameter and additional results (if available) will be available through the next URL present in the Link response header. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site ('Can use' global permission). Only spaces that the user has permission to view will be returned. Authentication - Required Scopes: [read:space:confluence]

Parameter:

ids - Filter the results to spaces based on their IDs. Multiple IDs can be specified as a comma-separated list. (optional)

keys - Filter the results to spaces based on their keys. Multiple keys can be specified as a comma-separated list. (optional)

type - Filter the results to spaces based on their type. (optional)

status - Filter the results to spaces based on their status. (optional)

labels - Filter the results to spaces based on their labels. Multiple labels can be specified as a comma-separated list. (optional)

sort - Used to sort the result by a particular field. (optional)

descriptionFormat - The content format type to be returned in the description field of the response. If available, the representation will be available under a response field of the same name under the description field. (optional)

includeIcon - If the icon for the space should be fetched or not. (optional, defaults to false)

cursor - Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results. (optional)

limit - Maximum number of spaces per result to return. If more results exist, use the Link response header to retrieve a relative URL that will return the next set of results. (optional, defaults to 25)

getTaskById

CompletableFuture<Task> getTaskById(@NotNull
 @NotNull Long id,
 @Nullable
 @Nullable PrimaryBodyRepresentation bodyFormat)

Get task by id

Returns a specific task. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the containing page or blog post and its corresponding space. Authentication - Required Scopes: [read:task:confluence]

Parameter:

id - The ID of the task to be returned. If you don't know the task ID, use Get tasks and filter the results. (required)

bodyFormat - The content format types to be returned in the body field of the response. If available, the representation will be available under a response field of the same name under the body field. (optional)

getTasks

CompletableFuture<MultiEntityResultTask> getTasks(@Nullable
 @Nullable PrimaryBodyRepresentation bodyFormat,
 @Nullable
 @Nullable Boolean includeBlankTasks,
 @Nullable
 @Nullable String status,
 @Nullable
 @Nullable List<Long> taskId,
 @Nullable
 @Nullable List<Long> spaceId,
 @Nullable
 @Nullable List<Long> pageId,
 @Nullable
 @Nullable List<Long> blogpostId,
 @Nullable
 @Nullable List<String> createdBy,
 @Nullable
 @Nullable List<String> assignedTo,
 @Nullable
 @Nullable List<String> completedBy,
 @Nullable
 @Nullable Long createdAtFrom,
 @Nullable
 @Nullable Long createdAtTo,
 @Nullable
 @Nullable Long dueAtFrom,
 @Nullable
 @Nullable Long dueAtTo,
 @Nullable
 @Nullable Long completedAtFrom,
 @Nullable
 @Nullable Long completedAtTo,
 @Nullable
 @Nullable String cursor,
 @Nullable
 @Nullable Integer limit)

Get tasks

Returns all tasks. The number of results is limited by the limit parameter and additional results (if available) will be available through the next URL present in the Link response header. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site ('Can use' global permission). Only tasks that the user has permission to view will be returned. Authentication - Required Scopes: [read:task:confluence]

Parameter:

bodyFormat - The content format types to be returned in the body field of the response. If available, the representation will be available under a response field of the same name under the body field. (optional)

includeBlankTasks - Specifies whether to include blank tasks in the response. Defaults to true. (optional)

status - Filters on the status of the task. (optional)

taskId - Filters on task ID. Multiple IDs can be specified. (optional)

spaceId - Filters on the space ID of the task. Multiple IDs can be specified. (optional)

pageId - Filters on the page ID of the task. Multiple IDs can be specified. Note - page and blog post filters can be used in conjunction. (optional)

blogpostId - Filters on the blog post ID of the task. Multiple IDs can be specified. Note - page and blog post filters can be used in conjunction. (optional)

createdBy - Filters on the Account ID of the user who created this task. Multiple IDs can be specified. (optional)

assignedTo - Filters on the Account ID of the user to whom this task is assigned. Multiple IDs can be specified. (optional)

completedBy - Filters on the Account ID of the user who completed this task. Multiple IDs can be specified. (optional)

createdAtFrom - Filters on start of date-time range of task based on creation date (inclusive). Input is epoch time in milliseconds. (optional)

createdAtTo - Filters on end of date-time range of task based on creation date (inclusive). Input is epoch time in milliseconds. (optional)

dueAtFrom - Filters on start of date-time range of task based on due date (inclusive). Input is epoch time in milliseconds. (optional)

dueAtTo - Filters on end of date-time range of task based on due date (inclusive). Input is epoch time in milliseconds. (optional)

completedAtFrom - Filters on start of date-time range of task based on completion date (inclusive). Input is epoch time in milliseconds. (optional)

completedAtTo - Filters on end of date-time range of task based on completion date (inclusive). Input is epoch time in milliseconds. (optional)

cursor - Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results. (optional)

limit - Maximum number of tasks per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results. (optional, defaults to 25)

getWhiteboardAncestors

CompletableFuture<MultiEntityResultAncestor> getWhiteboardAncestors(@NotNull
 @NotNull Long id,
 @Nullable
 @Nullable Integer limit)

Get all ancestors of the whiteboard

Returns all ancestors for a given whiteboard by ID in top-to-bottom order (that is, the highest ancestor is the first item in the response payload). The number of results is limited by the limit parameter and additional results (if available) will be available by calling this endpoint with the ID of first ancestor in the response payload. This endpoint returns minimal information about each ancestor. To fetch more details, use a related endpoint, such as [Get page by id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-page/#api-pages-id-get). **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site ('Can use' global permission). Permission to view the whiteboard and its corresponding space

Parameter:

id - The ID of the whiteboard. (required)

limit - Maximum number of items per result to return. If more results exist, call the endpoint with the highest ancestor's ID to fetch the next set of results. (optional, defaults to 25)

getWhiteboardById

CompletableFuture<WhiteboardSingle> getWhiteboardById(@NotNull
 @NotNull Long id)

Get whiteboard by id

Returns a specific whiteboard. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the whiteboard and its corresponding space. Authentication - Required Scopes: [read:whiteboard:confluence]

Parameter:

id - The ID of the whiteboard to be returned (required)

getWhiteboardContentProperties

CompletableFuture<MultiEntityResultContentProperty> getWhiteboardContentProperties(@NotNull
 @NotNull Long id,
 @Nullable
 @Nullable String key,
 @Nullable
 @Nullable ContentPropertySortOrder sort,
 @Nullable
 @Nullable String cursor,
 @Nullable
 @Nullable Integer limit)

Get content properties for whiteboard

Retrieves Content Properties tied to a specified whiteboard. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the whiteboard. Authentication - Required Scopes: [read:whiteboard:confluence]

Parameter:

id - The ID of the whiteboard for which content properties should be returned. (required)

key - Filters the response to return a specific content property with matching key (case sensitive). (optional)

sort - Used to sort the result by a particular field. (optional)

cursor - Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results. (optional)

limit - Maximum number of attachments per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results. (optional, defaults to 25)

getWhiteboardContentPropertiesById

CompletableFuture<ContentProperty> getWhiteboardContentPropertiesById(@NotNull
 @NotNull Long whiteboardId,
 @NotNull
 @NotNull Long propertyId)

Get content property for whiteboard by id

Retrieves a specific Content Property by ID that is attached to a specified whiteboard. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the whiteboard. Authentication - Required Scopes: [read:whiteboard:confluence]

Parameter:

whiteboardId - The ID of the whiteboard for which content properties should be returned. (required)

propertyId - The ID of the content property being requested. (required)

getWhiteboardOperations

CompletableFuture<PermittedOperationsResponse> getWhiteboardOperations(@NotNull
 @NotNull Long id)

Get permitted operations for a whiteboard

Returns the permitted operations on specific whiteboard. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the whiteboard and its corresponding space. Authentication - Required Scopes: [read:whiteboard:confluence]

Parameter:

id - The ID of the whiteboard for which operations should be returned. (required)

inviteByEmail

CompletableFuture<Void> inviteByEmail(@NotNull
 @NotNull CheckAccessByEmailRequest checkAccessByEmailRequest)

Invite a list of emails to the site

Invite a list of emails to the site. Ignores all invalid emails and no action is taken for the emails that already have access to the site. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site ('Can use' global permission).

Parameter:

checkAccessByEmailRequest - (required)

updateAttachmentPropertyById

CompletableFuture<ContentProperty> updateAttachmentPropertyById(@NotNull
 @NotNull String attachmentId,
 @NotNull
 @NotNull Long propertyId,
 @NotNull
 @NotNull ContentPropertyUpdateRequest contentPropertyUpdateRequest)

Update content property for attachment by id

Update a content property for attachment by its id. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to edit the attachment. Authentication - Required Scopes: [read:attachment:confluence]

Parameter:

attachmentId - The ID of the attachment the property belongs to. (required)

propertyId - The ID of the property to be updated. (required)

contentPropertyUpdateRequest - The content property to be updated. (required)

updateBlogPost

CompletableFuture<BlogPostSingle> updateBlogPost(@NotNull
 @NotNull Long id,
 @NotNull
 @NotNull UpdateBlogPostRequest updateBlogPostRequest)

Update blog post

Update a blog post by id. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the blog post and its corresponding space. Permission to update blog posts in the space. Authentication - Required Scopes: [write:page:confluence]

Parameter:

id - The ID of the blog post to be updated. If you don't know the blog post ID, use Get Blog Posts and filter the results. (required)

updateBlogPostRequest - (required)

updateBlogpostPropertyById

CompletableFuture<ContentProperty> updateBlogpostPropertyById(@NotNull
 @NotNull Long blogpostId,
 @NotNull
 @NotNull Long propertyId,
 @NotNull
 @NotNull ContentPropertyUpdateRequest contentPropertyUpdateRequest)

Update content property for blog post by id

Update a content property for blog post by its id. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to edit the blog post. Authentication - Required Scopes: [read:page:confluence, write:page:confluence]

Parameter:

blogpostId - The ID of the blog post the property belongs to. (required)

propertyId - The ID of the property to be updated. (required)

contentPropertyUpdateRequest - The content property to be updated. (required)

updateCommentPropertyById

CompletableFuture<ContentProperty> updateCommentPropertyById(@NotNull
 @NotNull Long commentId,
 @NotNull
 @NotNull Long propertyId,
 @NotNull
 @NotNull ContentPropertyUpdateRequest contentPropertyUpdateRequest)

Update content property for comment by id

Update a content property for a comment by its id. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to edit the comment. Authentication - Required Scopes: [read:comment:confluence, write:comment:confluence]

Parameter:

commentId - The ID of the comment the property belongs to. (required)

propertyId - The ID of the property to be updated. (required)

contentPropertyUpdateRequest - The content property to be updated. (required)

updateCustomContent

CompletableFuture<CustomContentSingle> updateCustomContent(@NotNull
 @NotNull Long id,
 @NotNull
 @NotNull UpdateCustomContentRequest updateCustomContentRequest)

Update custom content

Update a custom content by id. spaceId is always required and maximum one of pageId, blogPostId, or customContentId is allowed in the request body. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content of the page or blogpost and its corresponding space. Permission to update custom content in the space. Authentication - Required Scopes: [write:custom-content:confluence]

Parameter:

id - The ID of the custom content to be updated. If you don't know the custom content ID, use Get Custom Content by Type and filter the results. (required)

updateCustomContentRequest - (required)

updateCustomContentPropertyById

CompletableFuture<ContentProperty> updateCustomContentPropertyById(@NotNull
 @NotNull Long customContentId,
 @NotNull
 @NotNull Long propertyId,
 @NotNull
 @NotNull ContentPropertyUpdateRequest contentPropertyUpdateRequest)

Update content property for custom content by id

Update a content property for a piece of custom content by its id. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to edit the custom content. Authentication - Required Scopes: [read:custom-content:confluence, write:custom-content:confluence]

Parameter:

customContentId - The ID of the custom content the property belongs to. (required)

propertyId - The ID of the property to be updated. (required)

contentPropertyUpdateRequest - The content property to be updated. (required)

updateFooterComment

CompletableFuture<FooterCommentModel> updateFooterComment(@NotNull
 @NotNull Long commentId,
 @NotNull
 @NotNull UpdateFooterCommentModel updateFooterCommentModel)

Update footer comment

Update a footer comment. This can be used to update the body text of a comment. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content of the page or blogpost and its corresponding space. Permission to create comments in the space. Authentication - Required Scopes: [write:comment:confluence]

Parameter:

commentId - The ID of the comment to be retrieved. (required)

updateFooterCommentModel - The footer comment to be created (required)

updateInlineComment

CompletableFuture<InlineCommentModel> updateInlineComment(@NotNull
 @NotNull Long commentId,
 @NotNull
 @NotNull UpdateInlineCommentModel updateInlineCommentModel)

Update inline comment

Update an inline comment. This can be used to update the body text of a comment and/or to resolve the comment **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content of the page or blogpost and its corresponding space. Permission to create comments in the space. Authentication - Required Scopes: [write:comment:confluence]

Parameter:

commentId - The ID of the comment to be retrieved. (required)

updateInlineCommentModel - The inline comment to be updated (required)

updatePage

CompletableFuture<PageSingle> updatePage(@NotNull
 @NotNull Long id,
 @NotNull
 @NotNull UpdatePageRequest updatePageRequest)

Update page

Update a page by id. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the page and its corresponding space. Permission to update pages in the space. Authentication - Required Scopes: [write:page:confluence]

Parameter:

id - The ID of the page to be updated. If you don't know the page ID, use Get Pages and filter the results. (required)

updatePageRequest - (required)

updatePagePropertyById

CompletableFuture<ContentProperty> updatePagePropertyById(@NotNull
 @NotNull Long pageId,
 @NotNull
 @NotNull Long propertyId,
 @NotNull
 @NotNull ContentPropertyUpdateRequest contentPropertyUpdateRequest)

Update content property for page by id

Update a content property for a page by its id. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to edit the page. Authentication - Required Scopes: [read:page:confluence, write:page:confluence]

Parameter:

pageId - The ID of the page the property belongs to. (required)

propertyId - The ID of the property to be updated. (required)

contentPropertyUpdateRequest - The content property to be updated. (required)

updateSpacePropertyById

CompletableFuture<SpaceProperty> updateSpacePropertyById(@NotNull
 @NotNull Long spaceId,
 @NotNull
 @NotNull Long propertyId,
 @NotNull
 @NotNull SpacePropertyUpdateRequest spacePropertyUpdateRequest)

Update space property by id

Update a space property by its id. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site ('Can use' global permission) and 'Admin' permission for the space. Authentication - Required Scopes: [read:space:confluence, write:space:confluence]

Parameter:

spaceId - The ID of the space the property belongs to. (required)

propertyId - The ID of the property to be updated. (required)

spacePropertyUpdateRequest - The space property to be updated. (required)

updateTask

CompletableFuture<Task> updateTask(@NotNull
 @NotNull Long id,
 @NotNull
 @NotNull UpdateTaskRequest updateTaskRequest)

Update task

Update a task by id. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to edit the containing page or blog post and view its corresponding space.

Parameter:

id - The ID of the task to be updated. If you don't know the task ID, use Get tasks and filter the results. (required)

updateTaskRequest - (required)

updateWhiteboardPropertyById

CompletableFuture<ContentProperty> updateWhiteboardPropertyById(@NotNull
 @NotNull Long whiteboardId,
 @NotNull
 @NotNull Long propertyId,
 @NotNull
 @NotNull ContentPropertyUpdateRequest contentPropertyUpdateRequest)

Update content property for whiteboard by id

Update a content property for a whiteboard by its id. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to edit the whiteboard. Authentication - Required Scopes: [read:whiteboard:confluence, write:whiteboard:confluence]

Parameter:

whiteboardId - The ID of the whiteboard the property belongs to. (required)

propertyId - The ID of the property to be updated. (required)

contentPropertyUpdateRequest - The content property to be updated. (required)