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

Klasse ConfluenceRESTV2AsyncConsumerApi

java.lang.Object
io.github.primelib.confluence4j.rest.v2.api.ConfluenceRESTV2AsyncConsumerApi
@Generated("io.github.primelib.primecodegen.javafeign.JavaFeignGenerator") public class ConfluenceRESTV2AsyncConsumerApi extends Object

  • Konstruktordetails

  • Methodendetails

    • checkAccessByEmail

      public CompletableFuture<CheckAccessByEmail200Response> checkAccessByEmail(Consumer<CheckAccessByEmailOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • checkAccessByEmailRequest:

    • convertContentIdsToContentTypes

      public CompletableFuture<ContentIdToContentTypeResponse> convertContentIdsToContentTypes(Consumer<ConvertContentIdsToContentTypesOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • convertContentIdsToContentTypesRequest:

    • createAttachmentProperty

      public CompletableFuture<ContentProperty> createAttachmentProperty(Consumer<CreateAttachmentPropertyOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • attachmentId: The ID of the attachment to create a property for.
      • contentPropertyCreateRequest: The content property to be created

    • createBlogPost

      public CompletableFuture<BlogPostSingle> createBlogPost(Consumer<CreateBlogPostOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • createBlogPostRequest:
      • _private: The blog post will be private. Only the user who creates this blog post will have permission to view and edit one.

    • createBlogpostProperty

      public CompletableFuture<ContentProperty> createBlogpostProperty(Consumer<CreateBlogpostPropertyOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • blogpostId: The ID of the blog post to create a property for.
      • contentPropertyCreateRequest: The content property to be created

    • createCommentProperty

      public CompletableFuture<ContentProperty> createCommentProperty(Consumer<CreateCommentPropertyOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • commentId: The ID of the comment to create a property for.
      • contentPropertyCreateRequest: The content property to be created

    • createCustomContent

      public CompletableFuture<CustomContentSingle> createCustomContent(Consumer<CreateCustomContentOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • createCustomContentRequest:

    • createCustomContentProperty

      public CompletableFuture<ContentProperty> createCustomContentProperty(Consumer<CreateCustomContentPropertyOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • customContentId: The ID of the custom content to create a property for.
      • contentPropertyCreateRequest: The content property to be created

    • createFooterComment

      public CompletableFuture<FooterCommentModel> createFooterComment(Consumer<CreateFooterCommentOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • createFooterCommentModel: The footer comment to be created

    • createInlineComment

      public CompletableFuture<InlineCommentModel> createInlineComment(Consumer<CreateInlineCommentOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • createInlineCommentModel: The inline comment to be created

    • createPage

      public CompletableFuture<PageSingle> createPage(Consumer<CreatePageOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • createPageRequest:
      • embedded: Tag the content as embedded and content will be created in NCS.
      • _private: The page will be private. Only the user who creates this page will have permission to view and edit one.
      • rootLevel: The page will be created at the root level of the space (outside the space homepage tree).

    • createPageProperty

      public CompletableFuture<ContentProperty> createPageProperty(Consumer<CreatePagePropertyOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • pageId: The ID of the page to create a property for.
      • contentPropertyCreateRequest: The content property to be created

    • createSpaceProperty

      public CompletableFuture<SpaceProperty> createSpaceProperty(Consumer<CreateSpacePropertyOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • spaceId: The ID of the space for which space properties should be returned.
      • spacePropertyCreateRequest: The space property to be created

    • createWhiteboard

      public CompletableFuture<WhiteboardSingle> createWhiteboard(Consumer<CreateWhiteboardOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • createWhiteboardRequest:
      • _private: The whiteboard will be private. Only the user who creates this whiteboard will have permission to view and edit one.

    • createWhiteboardProperty

      public CompletableFuture<ContentProperty> createWhiteboardProperty(Consumer<CreateWhiteboardPropertyOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • id: The ID of the whiteboard to create a property for.
      • contentPropertyCreateRequest: The content property to be created

    • deleteAttachment

      public CompletableFuture<Void> deleteAttachment(Consumer<DeleteAttachmentOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • id: The ID of the attachment to be deleted.
      • purge: If attempting to purge the attachment.

    • deleteAttachmentPropertyById

      public CompletableFuture<Void> deleteAttachmentPropertyById(Consumer<DeleteAttachmentPropertyByIdOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • attachmentId: The ID of the attachment the property belongs to.
      • propertyId: The ID of the property to be deleted.

    • deleteBlogPost

      public CompletableFuture<Void> deleteBlogPost(Consumer<DeleteBlogPostOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • id: The ID of the blog post to be deleted.
      • purge: If attempting to purge the blog post.
      • draft: If attempting to delete a blog post that is a draft.

    • deleteBlogpostPropertyById

      public CompletableFuture<Void> deleteBlogpostPropertyById(Consumer<DeleteBlogpostPropertyByIdOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • blogpostId: The ID of the blog post the property belongs to.
      • propertyId: The ID of the property to be deleted.

    • deleteCommentPropertyById

      public CompletableFuture<Void> deleteCommentPropertyById(Consumer<DeleteCommentPropertyByIdOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • commentId: The ID of the comment the property belongs to.
      • propertyId: The ID of the property to be deleted.

    • deleteCustomContent

      public CompletableFuture<Void> deleteCustomContent(Consumer<DeleteCustomContentOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • id: The ID of the custom content to be deleted.
      • purge: If attempting to purge the custom content.

    • deleteCustomContentPropertyById

      public CompletableFuture<Void> deleteCustomContentPropertyById(Consumer<DeleteCustomContentPropertyByIdOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • customContentId: The ID of the custom content the property belongs to.
      • propertyId: The ID of the property to be deleted.

    • deleteFooterComment

      public CompletableFuture<Void> deleteFooterComment(Consumer<DeleteFooterCommentOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • commentId: The ID of the comment to be retrieved.

    • deleteInlineComment

      public CompletableFuture<Void> deleteInlineComment(Consumer<DeleteInlineCommentOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • commentId: The ID of the comment to be deleted.

    • deletePage

      public CompletableFuture<Void> deletePage(Consumer<DeletePageOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • id: The ID of the page to be deleted.
      • purge: If attempting to purge the page.
      • draft: If attempting to delete a page that is a draft.

    • deletePagePropertyById

      public CompletableFuture<Void> deletePagePropertyById(Consumer<DeletePagePropertyByIdOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • pageId: The ID of the page the property belongs to.
      • propertyId: The ID of the property to be deleted.

    • deleteSpacePropertyById

      public CompletableFuture<Void> deleteSpacePropertyById(Consumer<DeleteSpacePropertyByIdOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • spaceId: The ID of the space the property belongs to.
      • propertyId: The ID of the property to be deleted.

    • deleteWhiteboard

      public CompletableFuture<Void> deleteWhiteboard(Consumer<DeleteWhiteboardOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • id: The ID of the whiteboard to be deleted.

    • deleteWhiteboardPropertyById

      public CompletableFuture<Void> deleteWhiteboardPropertyById(Consumer<DeleteWhiteboardPropertyByIdOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • whiteboardId: The ID of the whiteboard the property belongs to.
      • propertyId: The ID of the property to be deleted.

    • getAttachmentById

      public CompletableFuture<Attachment> getAttachmentById(Consumer<GetAttachmentByIdOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • 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.
      • version: Allows you to retrieve a previously published version. Specify the previous version's number to retrieve its details.

    • getAttachmentComments

      public CompletableFuture<MultiEntityResultAttachmentCommentModel> getAttachmentComments(Consumer<GetAttachmentCommentsOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • id: The ID of the attachment for which comments should be returned.
      • 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.
      • 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.
      • 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.
      • sort: Used to sort the result by a particular field.

    • getAttachmentContentProperties

      public CompletableFuture<MultiEntityResultContentProperty> getAttachmentContentProperties(Consumer<GetAttachmentContentPropertiesOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • attachmentId: The ID of the attachment for which content properties should be returned.
      • key: Filters the response to return a specific content property with matching key (case sensitive).
      • sort: Used to sort the result by a particular field.
      • 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.
      • 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.

    • getAttachmentContentPropertiesById

      public CompletableFuture<ContentProperty> getAttachmentContentPropertiesById(Consumer<GetAttachmentContentPropertiesByIdOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • attachmentId: The ID of the attachment for which content properties should be returned.
      • propertyId: The ID of the content property to be returned

    • getAttachmentLabels

      public CompletableFuture<MultiEntityResultLabel> getAttachmentLabels(Consumer<GetAttachmentLabelsOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • id: The ID of the attachment for which labels should be returned.
      • prefix: Filter the results to labels based on their prefix.
      • sort: Used to sort the result by a particular field.
      • 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.
      • 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.

    • getAttachmentOperations

      public CompletableFuture<PermittedOperationsResponse> getAttachmentOperations(Consumer<GetAttachmentOperationsOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • id: The ID of the attachment for which operations should be returned.

    • getAttachmentVersionDetails

      public CompletableFuture<DetailedVersion> getAttachmentVersionDetails(Consumer<GetAttachmentVersionDetailsOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • attachmentId: The ID of the attachment for which version details should be returned.
      • versionNumber: The version number of the attachment to be returned.

    • getAttachmentVersions

      public CompletableFuture<MultiEntityResultVersion> getAttachmentVersions(Consumer<GetAttachmentVersionsOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • 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.
      • 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.
      • 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.
      • sort: Used to sort the result by a particular field.

    • getAttachments

      public CompletableFuture<MultiEntityResultAttachment> getAttachments(Consumer<GetAttachmentsOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • sort: Used to sort the result by a particular field.
      • 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.
      • status: Filter the results to attachments based on their status. By default, current and archived are used.
      • mediaType: Filters on the mediaType of attachments. Only one may be specified.
      • filename: Filters on the file-name of attachments. Only one may be specified.
      • 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.

    • getBlogPostById

      public CompletableFuture<BlogPostSingle> getBlogPostById(Consumer<GetBlogPostByIdOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • 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.
      • 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.
      • getDraft: Retrieve the draft version of this blog post.
      • version: Allows you to retrieve a previously published version. Specify the previous version's number to retrieve its details.

    • getBlogPostFooterComments

      public CompletableFuture<MultiEntityResultBlogPostCommentModel> getBlogPostFooterComments(Consumer<GetBlogPostFooterCommentsOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • id: The ID of the blog post for which footer comments should be returned.
      • 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.
      • sort: Used to sort the result by a particular field.
      • 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.
      • 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.

    • getBlogPostInlineComments

      public CompletableFuture<MultiEntityResultBlogPostInlineCommentModel> getBlogPostInlineComments(Consumer<GetBlogPostInlineCommentsOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • id: The ID of the blog post for which inline comments should be returned.
      • 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.
      • sort: Used to sort the result by a particular field.
      • 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.
      • 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.

    • getBlogPostLabels

      public CompletableFuture<MultiEntityResultLabel> getBlogPostLabels(Consumer<GetBlogPostLabelsOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • id: The ID of the blog post for which labels should be returned.
      • prefix: Filter the results to labels based on their prefix.
      • sort: Used to sort the result by a particular field.
      • 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.
      • 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.

    • getBlogPostLikeCount

      public CompletableFuture<Integer> getBlogPostLikeCount(Consumer<GetBlogPostLikeCountOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • id: The ID of the blog post for which like count should be returned.

    • getBlogPostLikeUsers

      public CompletableFuture<MultiEntityResultString> getBlogPostLikeUsers(Consumer<GetBlogPostLikeUsersOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • id: The ID of the blog post for which account IDs should be returned.
      • 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.
      • 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.

    • getBlogPostOperations

      public CompletableFuture<PermittedOperationsResponse> getBlogPostOperations(Consumer<GetBlogPostOperationsOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • id: The ID of the blog post for which operations should be returned.

    • getBlogPostVersionDetails

      public CompletableFuture<DetailedVersion> getBlogPostVersionDetails(Consumer<GetBlogPostVersionDetailsOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • blogpostId: The ID of the blog post for which version details should be returned.
      • versionNumber: The version number of the blog post to be returned.

    • getBlogPostVersions

      public CompletableFuture<MultiEntityResultVersion1> getBlogPostVersions(Consumer<GetBlogPostVersionsOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • 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.
      • 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.
      • 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.
      • 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.
      • sort: Used to sort the result by a particular field.

    • getBlogPosts

      public CompletableFuture<MultiEntityResultBlogPost> getBlogPosts(Consumer<GetBlogPostsOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • id: Filter the results based on blog post ids. Multiple blog post ids can be specified as a comma-separated list.
      • spaceId: Filter the results based on space ids. Multiple space ids can be specified as a comma-separated list.
      • sort: Used to sort the result by a particular field.
      • status: Filter the results to blog posts based on their status. By default, current is used.
      • title: Filter the results to blog posts based on their title.
      • 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.
      • 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.
      • 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.

    • getBlogPostsInSpace

      public CompletableFuture<MultiEntityResultBlogPost> getBlogPostsInSpace(Consumer<GetBlogPostsInSpaceOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • id: The ID of the space for which blog posts should be returned.
      • sort: Used to sort the result by a particular field.
      • status: Filter the results to blog posts based on their status. By default, current is used.
      • title: Filter the results to blog posts based on their title.
      • 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.
      • 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.
      • 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.

    • getBlogpostAttachments

      public CompletableFuture<MultiEntityResultAttachment> getBlogpostAttachments(Consumer<GetBlogpostAttachmentsOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • id: The ID of the blog post for which attachments should be returned.
      • sort: Used to sort the result by a particular field.
      • 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.
      • status: Filter the results to attachments based on their status. By default, current and archived are used.
      • mediaType: Filters on the mediaType of attachments. Only one may be specified.
      • filename: Filters on the file-name of attachments. Only one may be specified.
      • 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.

    • getBlogpostContentProperties

      public CompletableFuture<MultiEntityResultContentProperty> getBlogpostContentProperties(Consumer<GetBlogpostContentPropertiesOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • blogpostId: The ID of the blog post for which content properties should be returned.
      • key: Filters the response to return a specific content property with matching key (case sensitive).
      • sort: Used to sort the result by a particular field.
      • 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.
      • 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.

    • getBlogpostContentPropertiesById

      public CompletableFuture<ContentProperty> getBlogpostContentPropertiesById(Consumer<GetBlogpostContentPropertiesByIdOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • blogpostId: The ID of the blog post for which content properties should be returned.
      • propertyId: The ID of the property being requested

    • getChildCustomContent

      public CompletableFuture<MultiEntityResultChildCustomContent> getChildCustomContent(Consumer<GetChildCustomContentOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • 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.
      • 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.
      • 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.
      • sort: Used to sort the result by a particular field.

    • getChildPages

      public CompletableFuture<MultiEntityResultChildPage> getChildPages(Consumer<GetChildPagesOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • id: The ID of the parent page. If you don't know the page ID, use Get pages and filter the results.
      • 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.
      • 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.
      • sort: Used to sort the result by a particular field.

    • getCommentContentProperties

      public CompletableFuture<MultiEntityResultContentProperty> getCommentContentProperties(Consumer<GetCommentContentPropertiesOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • commentId: The ID of the comment for which content properties should be returned.
      • key: Filters the response to return a specific content property with matching key (case sensitive).
      • sort: Used to sort the result by a particular field.
      • 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.
      • 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.

    • getCommentContentPropertiesById

      public CompletableFuture<ContentProperty> getCommentContentPropertiesById(Consumer<GetCommentContentPropertiesByIdOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • commentId: The ID of the comment for which content properties should be returned.
      • propertyId: The ID of the content property being requested.

    • getCustomContentAttachments

      public CompletableFuture<MultiEntityResultAttachment> getCustomContentAttachments(Consumer<GetCustomContentAttachmentsOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • id: The ID of the custom content for which attachments should be returned.
      • sort: Used to sort the result by a particular field.
      • 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.
      • status: Filter the results to attachments based on their status. By default, current and archived are used.
      • mediaType: Filters on the mediaType of attachments. Only one may be specified.
      • filename: Filters on the file-name of attachments. Only one may be specified.
      • 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.

    • getCustomContentById

      public CompletableFuture<CustomContentSingle> getCustomContentById(Consumer<GetCustomContentByIdOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • 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.
      • 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.
      • version: Allows you to retrieve a previously published version. Specify the previous version's number to retrieve its details.

    • getCustomContentByType

      public CompletableFuture<MultiEntityResultCustomContent> getCustomContentByType(Consumer<GetCustomContentByTypeOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • type: The type of custom content being requested. See: https://developer.atlassian.com/cloud/confluence/custom-content/ for additional details on custom content.
      • id: Filter the results based on custom content ids. Multiple custom content ids can be specified as a comma-separated list.
      • spaceId: Filter the results based on space ids. Multiple space ids can be specified as a comma-separated list.
      • sort: Used to sort the result by a particular field.
      • 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.
      • 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.
      • 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.

    • getCustomContentByTypeInBlogPost

      public CompletableFuture<MultiEntityResultCustomContent> getCustomContentByTypeInBlogPost(Consumer<GetCustomContentByTypeInBlogPostOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • id: The ID of the blog post for which custom content should be returned.
      • type: The type of custom content being requested. See: https://developer.atlassian.com/cloud/confluence/custom-content/ for additional details on custom content.
      • sort: Used to sort the result by a particular field.
      • 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.
      • 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.
      • 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.

    • getCustomContentByTypeInPage

      public CompletableFuture<MultiEntityResultCustomContent> getCustomContentByTypeInPage(Consumer<GetCustomContentByTypeInPageOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • id: The ID of the page for which custom content should be returned.
      • type: The type of custom content being requested. See: https://developer.atlassian.com/cloud/confluence/custom-content/ for additional details on custom content.
      • sort: Used to sort the result by a particular field.
      • 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.
      • 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.
      • 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.

    • getCustomContentByTypeInSpace

      public CompletableFuture<MultiEntityResultCustomContent> getCustomContentByTypeInSpace(Consumer<GetCustomContentByTypeInSpaceOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • id: The ID of the space for which custom content should be returned.
      • type: The type of custom content being requested. See: https://developer.atlassian.com/cloud/confluence/custom-content/ for additional details on custom content.
      • 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.
      • 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.
      • 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.

    • getCustomContentComments

      public CompletableFuture<MultiEntityResultCustomContentCommentModel> getCustomContentComments(Consumer<GetCustomContentCommentsOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • id: The ID of the custom content for which comments should be returned.
      • 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.
      • 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.
      • 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.
      • sort: Used to sort the result by a particular field.

    • getCustomContentContentProperties

      public CompletableFuture<MultiEntityResultContentProperty> getCustomContentContentProperties(Consumer<GetCustomContentContentPropertiesOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • customContentId: The ID of the custom content for which content properties should be returned.
      • key: Filters the response to return a specific content property with matching key (case sensitive).
      • sort: Used to sort the result by a particular field.
      • 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.
      • 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.

    • getCustomContentContentPropertiesById

      public CompletableFuture<ContentProperty> getCustomContentContentPropertiesById(Consumer<GetCustomContentContentPropertiesByIdOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • customContentId: The ID of the custom content for which content properties should be returned.
      • propertyId: The ID of the content property being requested.

    • getCustomContentLabels

      public CompletableFuture<MultiEntityResultLabel> getCustomContentLabels(Consumer<GetCustomContentLabelsOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • id: The ID of the custom content for which labels should be returned.
      • prefix: Filter the results to labels based on their prefix.
      • sort: Used to sort the result by a particular field.
      • 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.
      • 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.

    • getCustomContentOperations

      public CompletableFuture<PermittedOperationsResponse> getCustomContentOperations(Consumer<GetCustomContentOperationsOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • id: The ID of the custom content for which operations should be returned.

    • getCustomContentVersionDetails

      public CompletableFuture<DetailedVersion> getCustomContentVersionDetails(Consumer<GetCustomContentVersionDetailsOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • customContentId: The ID of the custom content for which version details should be returned.
      • versionNumber: The version number of the custom content to be returned.

    • getCustomContentVersions

      public CompletableFuture<MultiEntityResultVersion3> getCustomContentVersions(Consumer<GetCustomContentVersionsOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • 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.
      • 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.
      • 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.
      • 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.
      • sort: Used to sort the result by a particular field.

    • getDataPolicyMetadata

      public 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

      public CompletableFuture<MultiEntityResultDataPolicySpace> getDataPolicySpaces(Consumer<GetDataPolicySpacesOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • ids: Filter the results to spaces based on their IDs. Multiple IDs can be specified as a comma-separated list.
      • keys: Filter the results to spaces based on their keys. Multiple keys can be specified as a comma-separated list.
      • sort: Used to sort the result by a particular field.
      • 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.
      • 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.

    • getFooterCommentById

      public CompletableFuture<FooterCommentModel> getFooterCommentById(Consumer<GetFooterCommentByIdOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • commentId: The ID of the comment to be retrieved.
      • 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.
      • version: Allows you to retrieve a previously published version. Specify the previous version's number to retrieve its details.

    • getFooterCommentChildren

      public CompletableFuture<MultiEntityResultChildrenCommentModel> getFooterCommentChildren(Consumer<GetFooterCommentChildrenOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • id: The ID of the parent comment for which footer comment children should be returned.
      • 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.
      • sort: Used to sort the result by a particular field.
      • 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.
      • 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.

    • getFooterCommentOperations

      public CompletableFuture<PermittedOperationsResponse> getFooterCommentOperations(Consumer<GetFooterCommentOperationsOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • id: The ID of the footer comment for which operations should be returned.

    • getFooterCommentVersionDetails

      public CompletableFuture<DetailedVersion> getFooterCommentVersionDetails(Consumer<GetFooterCommentVersionDetailsOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • id: The ID of the footer comment for which version details should be returned.
      • versionNumber: The version number of the footer comment to be returned.

    • getFooterCommentVersions

      public CompletableFuture<MultiEntityResultVersion4> getFooterCommentVersions(Consumer<GetFooterCommentVersionsOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • id: The ID of the footer comment for which versions should be returned
      • 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.
      • 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.
      • 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.
      • sort: Used to sort the result by a particular field.

    • getFooterComments

      public CompletableFuture<MultiEntityResultFooterCommentModel> getFooterComments(Consumer<GetFooterCommentsOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • 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.
      • sort: Used to sort the result by a particular field.
      • 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.
      • 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.

    • getFooterLikeCount

      public CompletableFuture<Integer> getFooterLikeCount(Consumer<GetFooterLikeCountOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • id: The ID of the footer comment for which like count should be returned.

    • getFooterLikeUsers

      public CompletableFuture<MultiEntityResultString> getFooterLikeUsers(Consumer<GetFooterLikeUsersOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • id: The ID of the footer comment for which like count should be returned.
      • 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.
      • 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.

    • getInlineCommentById

      public CompletableFuture<InlineCommentModel> getInlineCommentById(Consumer<GetInlineCommentByIdOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • commentId: The ID of the comment to be retrieved.
      • 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.
      • version: Allows you to retrieve a previously published version. Specify the previous version's number to retrieve its details.

    • getInlineCommentChildren

      public CompletableFuture<MultiEntityResultInlineCommentChildrenModel> getInlineCommentChildren(Consumer<GetInlineCommentChildrenOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • id: The ID of the parent comment for which inline comment children should be returned.
      • 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.
      • sort: Used to sort the result by a particular field.
      • 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.
      • 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.

    • getInlineCommentOperations

      public CompletableFuture<PermittedOperationsResponse> getInlineCommentOperations(Consumer<GetInlineCommentOperationsOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • id: The ID of the inline comment for which operations should be returned.

    • getInlineCommentVersionDetails

      public CompletableFuture<DetailedVersion> getInlineCommentVersionDetails(Consumer<GetInlineCommentVersionDetailsOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • id: The ID of the inline comment for which version details should be returned.
      • versionNumber: The version number of the inline comment to be returned.

    • getInlineCommentVersions

      public CompletableFuture<MultiEntityResultVersion4> getInlineCommentVersions(Consumer<GetInlineCommentVersionsOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • id: The ID of the inline comment for which versions should be returned
      • 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.
      • 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.
      • 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.
      • sort: Used to sort the result by a particular field.

    • getInlineComments

      public CompletableFuture<MultiEntityResultInlineCommentModel> getInlineComments(Consumer<GetInlineCommentsOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • 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.
      • sort: Used to sort the result by a particular field.
      • 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.
      • 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.

    • getInlineLikeCount

      public CompletableFuture<Integer> getInlineLikeCount(Consumer<GetInlineLikeCountOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • id: The ID of the inline comment for which like count should be returned.

    • getInlineLikeUsers

      public CompletableFuture<MultiEntityResultString> getInlineLikeUsers(Consumer<GetInlineLikeUsersOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • id: The ID of the inline comment for which like count should be returned.
      • 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.
      • 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.

    • getLabelAttachments

      public CompletableFuture<MultiEntityResultAttachment1> getLabelAttachments(Consumer<GetLabelAttachmentsOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • id: The ID of the label for which attachments should be returned.
      • sort: Used to sort the result by a particular field.
      • 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.
      • 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.

    • getLabelBlogPosts

      public CompletableFuture<MultiEntityResultBlogPost> getLabelBlogPosts(Consumer<GetLabelBlogPostsOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • id: The ID of the label for which blog posts should be returned.
      • spaceId: Filter the results based on space ids. Multiple space ids can be specified as a comma-separated list.
      • 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.
      • sort: Used to sort the result by a particular field.
      • 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.
      • 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.

    • getLabelPages

      public CompletableFuture<MultiEntityResultPage> getLabelPages(Consumer<GetLabelPagesOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • id: The ID of the label for which pages should be returned.
      • spaceId: Filter the results based on space ids. Multiple space ids can be specified as a comma-separated list.
      • 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.
      • sort: Used to sort the result by a particular field.
      • 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.
      • 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.

    • getLabels

      public CompletableFuture<MultiEntityResultLabel1> getLabels(Consumer<GetLabelsOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • labelId: Filters on label ID. Multiple IDs can be specified as a comma-separated list.
      • prefix: Filters on label prefix. Multiple IDs can be specified as a comma-separated list.
      • 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.
      • sort: Used to sort the result by a particular field.
      • 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.

    • getPageAncestors

      public CompletableFuture<MultiEntityResultAncestor> getPageAncestors(Consumer<GetPageAncestorsOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • id: The ID of the page.
      • 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.

    • getPageAttachments

      public CompletableFuture<MultiEntityResultAttachment> getPageAttachments(Consumer<GetPageAttachmentsOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • id: The ID of the page for which attachments should be returned.
      • sort: Used to sort the result by a particular field.
      • 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.
      • status: Filter the results to attachments based on their status. By default, current and archived are used.
      • mediaType: Filters on the mediaType of attachments. Only one may be specified.
      • filename: Filters on the file-name of attachments. Only one may be specified.
      • 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.

    • getPageById

      public CompletableFuture<PageSingle> getPageById(Consumer<GetPageByIdOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • id: The ID of the page to be returned. If you don't know the page ID, use Get pages and filter the results.
      • 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.
      • getDraft: Retrieve the draft version of this page.
      • version: Allows you to retrieve a previously published version. Specify the previous version's number to retrieve its details.

    • getPageContentProperties

      public CompletableFuture<MultiEntityResultContentProperty> getPageContentProperties(Consumer<GetPageContentPropertiesOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • pageId: The ID of the page for which content properties should be returned.
      • key: Filters the response to return a specific content property with matching key (case sensitive).
      • sort: Used to sort the result by a particular field.
      • 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.
      • 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.

    • getPageContentPropertiesById

      public CompletableFuture<ContentProperty> getPageContentPropertiesById(Consumer<GetPageContentPropertiesByIdOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • pageId: The ID of the page for which content properties should be returned.
      • propertyId: The ID of the content property being requested.

    • getPageFooterComments

      public CompletableFuture<MultiEntityResultPageCommentModel> getPageFooterComments(Consumer<GetPageFooterCommentsOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • id: The ID of the page for which footer comments should be returned.
      • 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.
      • sort: Used to sort the result by a particular field.
      • 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.
      • 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.

    • getPageInlineComments

      public CompletableFuture<MultiEntityResultPageInlineCommentModel> getPageInlineComments(Consumer<GetPageInlineCommentsOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • id: The ID of the page for which inline comments should be returned.
      • 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.
      • sort: Used to sort the result by a particular field.
      • 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.
      • 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.

    • getPageLabels

      public CompletableFuture<MultiEntityResultLabel> getPageLabels(Consumer<GetPageLabelsOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • id: The ID of the page for which labels should be returned.
      • prefix: Filter the results to labels based on their prefix.
      • sort: Used to sort the result by a particular field.
      • 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.
      • 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.

    • getPageLikeCount

      public CompletableFuture<Integer> getPageLikeCount(Consumer<GetPageLikeCountOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • id: The ID of the page for which like count should be returned.

    • getPageLikeUsers

      public CompletableFuture<MultiEntityResultString> getPageLikeUsers(Consumer<GetPageLikeUsersOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • id: The ID of the page for which like count should be returned.
      • 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.
      • 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.

    • getPageOperations

      public CompletableFuture<PermittedOperationsResponse> getPageOperations(Consumer<GetPageOperationsOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • id: The ID of the page for which operations should be returned.

    • getPageVersionDetails

      public CompletableFuture<DetailedVersion> getPageVersionDetails(Consumer<GetPageVersionDetailsOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • pageId: The ID of the page for which version details should be returned.
      • versionNumber: The version number of the page to be returned.

    • getPageVersions

      public CompletableFuture<MultiEntityResultVersion2> getPageVersions(Consumer<GetPageVersionsOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • 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.
      • 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.
      • 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.
      • 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.
      • sort: Used to sort the result by a particular field.

    • getPages

      public CompletableFuture<MultiEntityResultPage> getPages(Consumer<GetPagesOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • id: Filter the results based on page ids. Multiple page ids can be specified as a comma-separated list.
      • spaceId: Filter the results based on space ids. Multiple space ids can be specified as a comma-separated list.
      • sort: Used to sort the result by a particular field.
      • status: Filter the results to pages based on their status. By default, current and archived are used.
      • title: Filter the results to pages based on their title.
      • 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.
      • 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.
      • 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.

    • getPagesInSpace

      public CompletableFuture<MultiEntityResultPage> getPagesInSpace(Consumer<GetPagesInSpaceOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • id: The ID of the space for which pages should be returned.
      • depth: Filter the results to pages at the root level of the space or to all pages in the space.
      • sort: Used to sort the result by a particular field.
      • status: Filter the results to pages based on their status. By default, current and archived are used.
      • title: Filter the results to pages based on their title.
      • 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.
      • 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.
      • 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.

    • getSpaceById

      public CompletableFuture<Space> getSpaceById(Consumer<GetSpaceByIdOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • id: The ID of the space to be returned.
      • 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.
      • includeIcon: If the icon for the space should be fetched or not.

    • getSpaceContentLabels

      public CompletableFuture<MultiEntityResultLabel> getSpaceContentLabels(Consumer<GetSpaceContentLabelsOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • id: The ID of the space for which labels should be returned.
      • prefix: Filter the results to labels based on their prefix.
      • sort: Used to sort the result by a particular field.
      • 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.
      • 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.

    • getSpaceLabels

      public CompletableFuture<MultiEntityResultLabel> getSpaceLabels(Consumer<GetSpaceLabelsOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • id: The ID of the space for which labels should be returned.
      • prefix: Filter the results to labels based on their prefix.
      • sort: Used to sort the result by a particular field.
      • 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.
      • 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.

    • getSpaceOperations

      public CompletableFuture<PermittedOperationsResponse> getSpaceOperations(Consumer<GetSpaceOperationsOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • id: The ID of the space for which operations should be returned.

    • getSpacePermissions

      public CompletableFuture<MultiEntityResultSpacePermission> getSpacePermissions(Consumer<GetSpacePermissionsOperationSpec> spec)
      Get space permissions

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

      Parameter:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • id: The ID of the space to be returned.
      • 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.
      • 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.

    • getSpaceProperties

      public CompletableFuture<MultiEntityResultSpaceProperty> getSpaceProperties(Consumer<GetSpacePropertiesOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • spaceId: The ID of the space for which space properties should be returned.
      • 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.
      • 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.
      • 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.

    • getSpacePropertyById

      public CompletableFuture<SpaceProperty> getSpacePropertyById(Consumer<GetSpacePropertyByIdOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • spaceId: The ID of the space the property belongs to.
      • propertyId: The ID of the property to be retrieved.

    • getSpaces

      public CompletableFuture<MultiEntityResultSpace> getSpaces(Consumer<GetSpacesOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • ids: Filter the results to spaces based on their IDs. Multiple IDs can be specified as a comma-separated list.
      • keys: Filter the results to spaces based on their keys. Multiple keys can be specified as a comma-separated list.
      • type: Filter the results to spaces based on their type.
      • status: Filter the results to spaces based on their status.
      • labels: Filter the results to spaces based on their labels. Multiple labels can be specified as a comma-separated list.
      • sort: Used to sort the result by a particular field.
      • 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.
      • includeIcon: If the icon for the space should be fetched or not.
      • 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.
      • 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.

    • getTaskById

      public CompletableFuture<Task> getTaskById(Consumer<GetTaskByIdOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • id: The ID of the task to be returned. If you don't know the task ID, use Get tasks and filter the results.
      • 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.

    • getTasks

      public CompletableFuture<MultiEntityResultTask> getTasks(Consumer<GetTasksOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • 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.
      • includeBlankTasks: Specifies whether to include blank tasks in the response. Defaults to true.
      • status: Filters on the status of the task.
      • taskId: Filters on task ID. Multiple IDs can be specified.
      • spaceId: Filters on the space ID of the task. Multiple IDs can be specified.
      • 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.
      • 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.
      • createdBy: Filters on the Account ID of the user who created this task. Multiple IDs can be specified.
      • assignedTo: Filters on the Account ID of the user to whom this task is assigned. Multiple IDs can be specified.
      • completedBy: Filters on the Account ID of the user who completed this task. Multiple IDs can be specified.
      • createdAtFrom: Filters on start of date-time range of task based on creation date (inclusive). Input is epoch time in milliseconds.
      • createdAtTo: Filters on end of date-time range of task based on creation date (inclusive). Input is epoch time in milliseconds.
      • dueAtFrom: Filters on start of date-time range of task based on due date (inclusive). Input is epoch time in milliseconds.
      • dueAtTo: Filters on end of date-time range of task based on due date (inclusive). Input is epoch time in milliseconds.
      • completedAtFrom: Filters on start of date-time range of task based on completion date (inclusive). Input is epoch time in milliseconds.
      • completedAtTo: Filters on end of date-time range of task based on completion date (inclusive). Input is epoch time in milliseconds.
      • 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.
      • 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.

    • getWhiteboardAncestors

      public CompletableFuture<MultiEntityResultAncestor> getWhiteboardAncestors(Consumer<GetWhiteboardAncestorsOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • id: The ID of the whiteboard.
      • 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.

    • getWhiteboardById

      public CompletableFuture<WhiteboardSingle> getWhiteboardById(Consumer<GetWhiteboardByIdOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • id: The ID of the whiteboard to be returned

    • getWhiteboardContentProperties

      public CompletableFuture<MultiEntityResultContentProperty> getWhiteboardContentProperties(Consumer<GetWhiteboardContentPropertiesOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • id: The ID of the whiteboard for which content properties should be returned.
      • key: Filters the response to return a specific content property with matching key (case sensitive).
      • sort: Used to sort the result by a particular field.
      • 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.
      • 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.

    • getWhiteboardContentPropertiesById

      public CompletableFuture<ContentProperty> getWhiteboardContentPropertiesById(Consumer<GetWhiteboardContentPropertiesByIdOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • whiteboardId: The ID of the whiteboard for which content properties should be returned.
      • propertyId: The ID of the content property being requested.

    • getWhiteboardOperations

      public CompletableFuture<PermittedOperationsResponse> getWhiteboardOperations(Consumer<GetWhiteboardOperationsOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • id: The ID of the whiteboard for which operations should be returned.

    • inviteByEmail

      public CompletableFuture<Void> inviteByEmail(Consumer<InviteByEmailOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • checkAccessByEmailRequest:

    • updateAttachmentPropertyById

      public CompletableFuture<ContentProperty> updateAttachmentPropertyById(Consumer<UpdateAttachmentPropertyByIdOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • attachmentId: The ID of the attachment the property belongs to.
      • propertyId: The ID of the property to be updated.
      • contentPropertyUpdateRequest: The content property to be updated.

    • updateBlogPost

      public CompletableFuture<BlogPostSingle> updateBlogPost(Consumer<UpdateBlogPostOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • 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.
      • updateBlogPostRequest:

    • updateBlogpostPropertyById

      public CompletableFuture<ContentProperty> updateBlogpostPropertyById(Consumer<UpdateBlogpostPropertyByIdOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • blogpostId: The ID of the blog post the property belongs to.
      • propertyId: The ID of the property to be updated.
      • contentPropertyUpdateRequest: The content property to be updated.

    • updateCommentPropertyById

      public CompletableFuture<ContentProperty> updateCommentPropertyById(Consumer<UpdateCommentPropertyByIdOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • commentId: The ID of the comment the property belongs to.
      • propertyId: The ID of the property to be updated.
      • contentPropertyUpdateRequest: The content property to be updated.

    • updateCustomContent

      public CompletableFuture<CustomContentSingle> updateCustomContent(Consumer<UpdateCustomContentOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • 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.
      • updateCustomContentRequest:

    • updateCustomContentPropertyById

      public CompletableFuture<ContentProperty> updateCustomContentPropertyById(Consumer<UpdateCustomContentPropertyByIdOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • customContentId: The ID of the custom content the property belongs to.
      • propertyId: The ID of the property to be updated.
      • contentPropertyUpdateRequest: The content property to be updated.

    • updateFooterComment

      public CompletableFuture<FooterCommentModel> updateFooterComment(Consumer<UpdateFooterCommentOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • commentId: The ID of the comment to be retrieved.
      • updateFooterCommentModel: The footer comment to be created

    • updateInlineComment

      public CompletableFuture<InlineCommentModel> updateInlineComment(Consumer<UpdateInlineCommentOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • commentId: The ID of the comment to be retrieved.
      • updateInlineCommentModel: The inline comment to be updated

    • updatePage

      public CompletableFuture<PageSingle> updatePage(Consumer<UpdatePageOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • id: The ID of the page to be updated. If you don't know the page ID, use Get Pages and filter the results.
      • updatePageRequest:

    • updatePagePropertyById

      public CompletableFuture<ContentProperty> updatePagePropertyById(Consumer<UpdatePagePropertyByIdOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • pageId: The ID of the page the property belongs to.
      • propertyId: The ID of the property to be updated.
      • contentPropertyUpdateRequest: The content property to be updated.

    • updateSpacePropertyById

      public CompletableFuture<SpaceProperty> updateSpacePropertyById(Consumer<UpdateSpacePropertyByIdOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • spaceId: The ID of the space the property belongs to.
      • propertyId: The ID of the property to be updated.
      • spacePropertyUpdateRequest: The space property to be updated.

    • updateTask

      public CompletableFuture<Task> updateTask(Consumer<UpdateTaskOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • id: The ID of the task to be updated. If you don't know the task ID, use Get tasks and filter the results.
      • updateTaskRequest:

    • updateWhiteboardPropertyById

      public CompletableFuture<ContentProperty> updateWhiteboardPropertyById(Consumer<UpdateWhiteboardPropertyByIdOperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • whiteboardId: The ID of the whiteboard the property belongs to.
      • propertyId: The ID of the property to be updated.
      • contentPropertyUpdateRequest: The content property to be updated.