Schnittstelle ConfluenceRESTV2Api
-
Methodenübersicht
Modifizierer und TypMethodeBeschreibungcheckAccessByEmail(@NotNull CheckAccessByEmailRequest checkAccessByEmailRequest) Check site access for a list of emailsconvertContentIdsToContentTypes(@NotNull ConvertContentIdsToContentTypesRequest convertContentIdsToContentTypesRequest) Convert content ids to content typescreateAttachmentProperty(@NotNull String attachmentId, @NotNull ContentPropertyCreateRequest contentPropertyCreateRequest, @Nullable Boolean serializeIdsAsStrings) Create content property for attachmentcreateBlogPost(@NotNull CreateBlogPostRequest createBlogPostRequest, @Nullable Boolean serializeIdsAsStrings, @Nullable Boolean _private) Create blog postcreateBlogpostProperty(@NotNull Long blogpostId, @NotNull ContentPropertyCreateRequest contentPropertyCreateRequest, @Nullable Boolean serializeIdsAsStrings) Create content property for blog postcreateCommentProperty(@NotNull Long commentId, @NotNull ContentPropertyCreateRequest contentPropertyCreateRequest, @Nullable Boolean serializeIdsAsStrings) Create content property for commentcreateCustomContent(@NotNull CreateCustomContentRequest createCustomContentRequest, @Nullable Boolean serializeIdsAsStrings) Create custom contentcreateCustomContentProperty(@NotNull Long customContentId, @NotNull ContentPropertyCreateRequest contentPropertyCreateRequest, @Nullable Boolean serializeIdsAsStrings) Create content property for custom contentcreateFooterComment(@NotNull CreateFooterCommentModel createFooterCommentModel, @Nullable Boolean serializeIdsAsStrings) Create footer commentcreateInlineComment(@NotNull CreateInlineCommentModel createInlineCommentModel, @Nullable Boolean serializeIdsAsStrings) Create inline commentcreatePage(@NotNull CreatePageRequest createPageRequest, @Nullable Boolean serializeIdsAsStrings, @Nullable Boolean embedded, @Nullable Boolean _private) Create pagecreatePageProperty(@NotNull Long pageId, @NotNull ContentPropertyCreateRequest contentPropertyCreateRequest, @Nullable Boolean serializeIdsAsStrings) Create content property for pagecreateSpaceProperty(@NotNull Long spaceId, @NotNull SpacePropertyCreateRequest spacePropertyCreateRequest, @Nullable Boolean serializeIdsAsStrings) Create space property in spacevoiddeleteAttachment(@NotNull Long id) Delete attachmentvoiddeleteAttachmentPropertyById(@NotNull String attachmentId, @NotNull Long propertyId) Delete content property for attachment by idvoiddeleteBlogPost(@NotNull Long id) Delete blog postvoiddeleteBlogpostPropertyById(@NotNull Long blogpostId, @NotNull Long propertyId) Delete content property for blogpost by idvoiddeleteCommentPropertyById(@NotNull Long commentId, @NotNull Long propertyId) Delete content property for comment by idvoiddeleteCustomContent(@NotNull Long id) Delete custom contentvoiddeleteCustomContentPropertyById(@NotNull Long customContentId, @NotNull Long propertyId) Delete content property for custom content by idvoiddeleteFooterComment(@NotNull Long commentId) Delete footer commentvoiddeleteInlineComment(@NotNull Long commentId) Delete inline commentvoiddeletePage(@NotNull Long id) Delete pagevoiddeletePagePropertyById(@NotNull Long pageId, @NotNull Long propertyId) Delete content property for page by idvoiddeleteSpacePropertyById(@NotNull Long spaceId, @NotNull Long propertyId) Delete space property by idgetAttachmentById(@NotNull String id, @Nullable Integer version, @Nullable Boolean serializeIdsAsStrings) Get attachment by idgetAttachmentContentProperties(@NotNull String attachmentId, @Nullable String key, @Nullable ContentPropertySortOrder sort, @Nullable String cursor, @Nullable Integer limit, @Nullable Boolean serializeIdsAsStrings) Get content properties for attachmentgetAttachmentContentPropertiesById(@NotNull String attachmentId, @NotNull Long propertyId, @Nullable Boolean serializeIdsAsStrings) Get content property for attachment by idgetAttachmentLabels(@NotNull Long id, @Nullable String prefix, @Nullable List<LabelSortOrder> sort, @Nullable String cursor, @Nullable Integer limit, @Nullable Boolean serializeIdsAsStrings) Get labels for attachmentgetAttachmentOperations(@NotNull Long id) Get permitted operations for attachmentgetAttachments(@Nullable AttachmentSortOrder sort, @Nullable String cursor, @Nullable List<String> status, @Nullable String mediaType, @Nullable String filename, @Nullable Integer limit, @Nullable Boolean serializeIdsAsStrings) Get attachmentsgetAttachmentVersionDetails(@NotNull String attachmentId, @NotNull Long versionNumber) Get version details for attachment versiongetAttachmentVersions(@NotNull String id, @Nullable String cursor, @Nullable Integer limit, @Nullable VersionSortOrder sort) Get attachment versionsgetBlogpostAttachments(@NotNull Long id, @Nullable AttachmentSortOrder sort, @Nullable String cursor, @Nullable List<String> status, @Nullable String mediaType, @Nullable String filename, @Nullable Integer limit, @Nullable Boolean serializeIdsAsStrings) Get attachments for blog postgetBlogPostById(@NotNull Long id, @Nullable PrimaryBodyRepresentationSingle bodyFormat, @Nullable Boolean getDraft, @Nullable Integer version, @Nullable Boolean serializeIdsAsStrings) Get blog post by idgetBlogpostContentProperties(@NotNull Long blogpostId, @Nullable String key, @Nullable ContentPropertySortOrder sort, @Nullable String cursor, @Nullable Integer limit, @Nullable Boolean serializeIdsAsStrings) Get content properties for blog postgetBlogpostContentPropertiesById(@NotNull Long blogpostId, @NotNull Long propertyId, @Nullable Boolean serializeIdsAsStrings) Get content property for blog post by idgetBlogPostFooterComments(@NotNull Long id, @Nullable PrimaryBodyRepresentation bodyFormat, @Nullable CommentSortOrder sort, @Nullable String cursor, @Nullable Integer limit, @Nullable Boolean serializeIdsAsStrings) Get footer comments for blog postgetBlogPostInlineComments(@NotNull Long id, @Nullable PrimaryBodyRepresentation bodyFormat, @Nullable CommentSortOrder sort, @Nullable String cursor, @Nullable Integer limit, @Nullable Boolean serializeIdsAsStrings) Get inline comments for blog postgetBlogPostLabels(@NotNull Long id, @Nullable String prefix, @Nullable List<LabelSortOrder> sort, @Nullable String cursor, @Nullable Integer limit, @Nullable Boolean serializeIdsAsStrings) Get labels for blog postgetBlogPostLikeCount(@NotNull Long id) Get like count for blog postgetBlogPostLikeUsers(@NotNull Long id, @Nullable String cursor, @Nullable Integer limit) Get account IDs of likes for blog postgetBlogPostOperations(@NotNull Long id) Get permitted operations for blog postgetBlogPosts(@Nullable List<Long> id, @Nullable List<Long> spaceId, @Nullable BlogPostSortOrder sort, @Nullable List<String> status, @Nullable String title, @Nullable PrimaryBodyRepresentation bodyFormat, @Nullable String cursor, @Nullable Integer limit, @Nullable Boolean serializeIdsAsStrings) Get blog postsgetBlogPostsInSpace(@NotNull Long id, @Nullable BlogPostSortOrder sort, @Nullable List<String> status, @Nullable String title, @Nullable PrimaryBodyRepresentation bodyFormat, @Nullable String cursor, @Nullable Integer limit, @Nullable Boolean serializeIdsAsStrings) Get blog posts in spacegetBlogPostVersionDetails(@NotNull Long blogpostId, @NotNull Long versionNumber) Get version details for blog post versiongetBlogPostVersions(@NotNull Long id, @Nullable PrimaryBodyRepresentation bodyFormat, @Nullable String cursor, @Nullable Integer limit, @Nullable VersionSortOrder sort) Get blog post versionsgetChildCustomContent(@NotNull Long id, @Nullable String cursor, @Nullable Integer limit, @Nullable List<ChildCustomContentSortOrder> sort, @Nullable Boolean serializeIdsAsStrings) Get child custom contentgetChildPages(@NotNull Long id, @Nullable String cursor, @Nullable Integer limit, @Nullable List<ChildPageSortOrder> sort, @Nullable Boolean serializeIdsAsStrings) Get child pagesgetCommentContentProperties(@NotNull Long commentId, @Nullable String key, @Nullable ContentPropertySortOrder sort, @Nullable String cursor, @Nullable Integer limit, @Nullable Boolean serializeIdsAsStrings) Get content properties for commentgetCommentContentPropertiesById(@NotNull Long commentId, @NotNull Long propertyId, @Nullable Boolean serializeIdsAsStrings) Get content property for comment by idgetCustomContentAttachments(@NotNull Long id, @Nullable AttachmentSortOrder sort, @Nullable String cursor, @Nullable List<String> status, @Nullable String mediaType, @Nullable String filename, @Nullable Integer limit, @Nullable Boolean serializeIdsAsStrings) Get attachments for custom contentgetCustomContentById(@NotNull Long id, @Nullable CustomContentBodyRepresentationSingle bodyFormat, @Nullable Integer version, @Nullable Boolean serializeIdsAsStrings) Get custom content by idgetCustomContentByType(@NotNull String type, @Nullable List<Long> id, @Nullable List<Long> spaceId, @Nullable CustomContentSortOrder sort, @Nullable String cursor, @Nullable Integer limit, @Nullable CustomContentBodyRepresentation bodyFormat, @Nullable Boolean serializeIdsAsStrings) Get custom content by typegetCustomContentByTypeInBlogPost(@NotNull Long id, @NotNull String type, @Nullable CustomContentSortOrder sort, @Nullable String cursor, @Nullable Integer limit, @Nullable CustomContentBodyRepresentation bodyFormat, @Nullable Boolean serializeIdsAsStrings) Get custom content by type in blog postgetCustomContentByTypeInPage(@NotNull Long id, @NotNull String type, @Nullable CustomContentSortOrder sort, @Nullable String cursor, @Nullable Integer limit, @Nullable CustomContentBodyRepresentation bodyFormat, @Nullable Boolean serializeIdsAsStrings) Get custom content by type in pagegetCustomContentByTypeInSpace(@NotNull Long id, @NotNull String type, @Nullable String cursor, @Nullable Integer limit, @Nullable CustomContentBodyRepresentation bodyFormat, @Nullable Boolean serializeIdsAsStrings) Get custom content by type in spacegetCustomContentContentProperties(@NotNull Long customContentId, @Nullable String key, @Nullable ContentPropertySortOrder sort, @Nullable String cursor, @Nullable Integer limit, @Nullable Boolean serializeIdsAsStrings) Get content properties for custom contentgetCustomContentContentPropertiesById(@NotNull Long customContentId, @NotNull Long propertyId, @Nullable Boolean serializeIdsAsStrings) Get content property for custom content by idgetCustomContentLabels(@NotNull Long id, @Nullable String prefix, @Nullable List<LabelSortOrder> sort, @Nullable String cursor, @Nullable Integer limit, @Nullable Boolean serializeIdsAsStrings) Get labels for custom contentgetCustomContentOperations(@NotNull Long id) Get permitted operations for custom contentgetCustomContentVersionDetails(@NotNull Long customContentId, @NotNull Long versionNumber) Get version details for custom content versiongetCustomContentVersions(@NotNull Long customContentId, @Nullable CustomContentBodyRepresentation bodyFormat, @Nullable String cursor, @Nullable Integer limit, @Nullable VersionSortOrder sort) Get custom content versionsgetFooterCommentById(@NotNull Long commentId, @Nullable PrimaryBodyRepresentationSingle bodyFormat, @Nullable Integer version, @Nullable Boolean serializeIdsAsStrings) Get footer comment by idgetFooterCommentChildren(@NotNull Long id, @Nullable PrimaryBodyRepresentation bodyFormat, @Nullable CommentSortOrder sort, @Nullable String cursor, @Nullable Integer limit, @Nullable Boolean serializeIdsAsStrings) Get children footer commentsgetFooterCommentOperations(@NotNull Long id) Get permitted operations for footer commentgetFooterComments(@Nullable PrimaryBodyRepresentation bodyFormat, @Nullable CommentSortOrder sort, @Nullable String cursor, @Nullable Integer limit, @Nullable Boolean serializeIdsAsStrings) Get footer commentsgetFooterCommentVersionDetails(@NotNull Long id, @NotNull Long versionNumber) Get version details for footer comment versiongetFooterCommentVersions(@NotNull Long id, @Nullable PrimaryBodyRepresentation bodyFormat, @Nullable String cursor, @Nullable Integer limit, @Nullable VersionSortOrder sort) Get footer comment versionsgetFooterLikeCount(@NotNull Long id) Get like count for footer commentgetFooterLikeUsers(@NotNull Long id, @Nullable String cursor, @Nullable Integer limit) Get account IDs of likes for footer commentgetInlineCommentById(@NotNull Long commentId, @Nullable PrimaryBodyRepresentationSingle bodyFormat, @Nullable Integer version, @Nullable Boolean serializeIdsAsStrings) Get inline comment by idgetInlineCommentChildren(@NotNull Long id, @Nullable Boolean serializeIdsAsStrings, @Nullable PrimaryBodyRepresentation bodyFormat, @Nullable CommentSortOrder sort, @Nullable String cursor, @Nullable Integer limit) Get children inline commentsgetInlineCommentOperations(@NotNull Long id) Get permitted operations for inline commentgetInlineComments(@Nullable Boolean serializeIdsAsStrings, @Nullable PrimaryBodyRepresentation bodyFormat, @Nullable CommentSortOrder sort, @Nullable String cursor, @Nullable Integer limit) Get inline commentsgetInlineCommentVersionDetails(@NotNull Long id, @NotNull Long versionNumber) Get version details for inline comment versiongetInlineCommentVersions(@NotNull Long id, @Nullable PrimaryBodyRepresentation bodyFormat, @Nullable String cursor, @Nullable Integer limit, @Nullable VersionSortOrder sort) Get inline comment versionsgetInlineLikeCount(@NotNull Long id) Get like count for inline commentgetInlineLikeUsers(@NotNull Long id, @Nullable String cursor, @Nullable Integer limit) Get account IDs of likes for inline commentgetLabelAttachments(@NotNull Long id, @Nullable AttachmentSortOrder sort, @Nullable String cursor, @Nullable Integer limit, @Nullable Boolean serializeIdsAsStrings) Get attachments for labelgetLabelBlogPosts(@NotNull Long id, @Nullable List<Long> spaceId, @Nullable PrimaryBodyRepresentation bodyFormat, @Nullable BlogPostSortOrder sort, @Nullable String cursor, @Nullable Integer limit, @Nullable Boolean serializeIdsAsStrings) Get blog posts for labelgetLabelPages(@NotNull Long id, @Nullable List<Long> spaceId, @Nullable PrimaryBodyRepresentation bodyFormat, @Nullable PageSortOrder sort, @Nullable String cursor, @Nullable Integer limit, @Nullable Boolean serializeIdsAsStrings) Get pages for labelgetPageAncestors(@NotNull Long id, @Nullable Integer limit) Get all ancestors of pagegetPageAttachments(@NotNull Long id, @Nullable AttachmentSortOrder sort, @Nullable String cursor, @Nullable List<String> status, @Nullable String mediaType, @Nullable String filename, @Nullable Integer limit, @Nullable Boolean serializeIdsAsStrings) Get attachments for pagegetPageById(@NotNull Long id, @Nullable PrimaryBodyRepresentationSingle bodyFormat, @Nullable Boolean getDraft, @Nullable Integer version, @Nullable Boolean serializeIdsAsStrings) Get page by idgetPageContentProperties(@NotNull Long pageId, @Nullable String key, @Nullable ContentPropertySortOrder sort, @Nullable String cursor, @Nullable Integer limit, @Nullable Boolean serializeIdsAsStrings) Get content properties for pagegetPageContentPropertiesById(@NotNull Long pageId, @NotNull Long propertyId, @Nullable Boolean serializeIdsAsStrings) Get content property for page by idgetPageFooterComments(@NotNull Long id, @Nullable PrimaryBodyRepresentation bodyFormat, @Nullable CommentSortOrder sort, @Nullable String cursor, @Nullable Integer limit, @Nullable Boolean serializeIdsAsStrings) Get footer comments for pagegetPageInlineComments(@NotNull Long id, @Nullable PrimaryBodyRepresentation bodyFormat, @Nullable CommentSortOrder sort, @Nullable String cursor, @Nullable Integer limit, @Nullable Boolean serializeIdsAsStrings) Get inline comments for pagegetPageLabels(@NotNull Long id, @Nullable String prefix, @Nullable List<LabelSortOrder> sort, @Nullable String cursor, @Nullable Integer limit, @Nullable Boolean serializeIdsAsStrings) Get labels for pagegetPageLikeCount(@NotNull Long id) Get like count for pagegetPageLikeUsers(@NotNull Long id, @Nullable String cursor, @Nullable Integer limit) Get account IDs of likes for pagegetPageOperations(@NotNull Long id) Get permitted operations for pagegetPages(@Nullable List<Long> id, @Nullable List<Long> spaceId, @Nullable PageSortOrder sort, @Nullable List<String> status, @Nullable String title, @Nullable PrimaryBodyRepresentation bodyFormat, @Nullable String cursor, @Nullable Integer limit, @Nullable Boolean serializeIdsAsStrings) Get pagesgetPagesInSpace(@NotNull Long id, @Nullable String depth, @Nullable PageSortOrder sort, @Nullable List<String> status, @Nullable String title, @Nullable PrimaryBodyRepresentation bodyFormat, @Nullable String cursor, @Nullable Integer limit, @Nullable Boolean serializeIdsAsStrings) Get pages in spacegetPageVersionDetails(@NotNull Long pageId, @NotNull Long versionNumber) Get version details for page versiongetPageVersions(@NotNull Long id, @Nullable PrimaryBodyRepresentation bodyFormat, @Nullable String cursor, @Nullable Integer limit, @Nullable VersionSortOrder sort) Get page versionsgetSpaceById(@NotNull Long id, @Nullable SpaceDescriptionBodyRepresentation descriptionFormat, @Nullable Boolean includeIcon, @Nullable Boolean serializeIdsAsStrings) Get space by idgetSpaceOperations(@NotNull Long id) Get permitted operations for spacegetSpacePermissions(@NotNull Long id, @Nullable String cursor, @Nullable Integer limit) Get space permissionsgetSpaceProperties(@NotNull Long spaceId, @Nullable String key, @Nullable String cursor, @Nullable Integer limit, @Nullable Boolean serializeIdsAsStrings) Get space properties in spacegetSpacePropertyById(@NotNull Long spaceId, @NotNull Long propertyId, @Nullable Boolean serializeIdsAsStrings) Get space property by idgetSpaces(@Nullable List<Long> ids, @Nullable List<String> keys, @Nullable String type, @Nullable String status, @Nullable List<String> labels, @Nullable SpaceSortOrder sort, @Nullable SpaceDescriptionBodyRepresentation descriptionFormat, @Nullable Boolean includeIcon, @Nullable String cursor, @Nullable Integer limit, @Nullable Boolean serializeIdsAsStrings) Get spacesgetTaskById(@NotNull Long id, @Nullable PrimaryBodyRepresentation bodyFormat, @Nullable Boolean serializeIdsAsStrings) Get task by idgetTasks(@Nullable PrimaryBodyRepresentation bodyFormat, @Nullable Boolean includeBlankTasks, @Nullable String status, @Nullable List<Long> taskId, @Nullable List<Long> spaceId, @Nullable List<Long> pageId, @Nullable List<Long> blogpostId, @Nullable List<String> createdBy, @Nullable List<String> assignedTo, @Nullable List<String> completedBy, @Nullable Long createdAtFrom, @Nullable Long createdAtTo, @Nullable Long dueAtFrom, @Nullable Long dueAtTo, @Nullable Long completedAtFrom, @Nullable Long completedAtTo, @Nullable String cursor, @Nullable Integer limit, @Nullable Boolean serializeIdsAsStrings) Get tasksvoidinviteByEmail(@NotNull CheckAccessByEmailRequest checkAccessByEmailRequest) Invite a list of emails to the siteupdateAttachmentPropertyById(@NotNull String attachmentId, @NotNull Long propertyId, @NotNull ContentPropertyUpdateRequest contentPropertyUpdateRequest, @Nullable Boolean serializeIdsAsStrings) Update content property for attachment by idupdateBlogPost(@NotNull Long id, @NotNull UpdateBlogPostRequest updateBlogPostRequest, @Nullable Boolean serializeIdsAsStrings) Update blog postupdateBlogpostPropertyById(@NotNull Long blogpostId, @NotNull Long propertyId, @NotNull ContentPropertyUpdateRequest contentPropertyUpdateRequest, @Nullable Boolean serializeIdsAsStrings) Update content property for blog post by idupdateCommentPropertyById(@NotNull Long commentId, @NotNull Long propertyId, @NotNull ContentPropertyUpdateRequest contentPropertyUpdateRequest, @Nullable Boolean serializeIdsAsStrings) Update content property for comment by idupdateCustomContent(@NotNull Long id, @NotNull UpdateCustomContentRequest updateCustomContentRequest, @Nullable Boolean serializeIdsAsStrings) Update custom contentupdateCustomContentPropertyById(@NotNull Long customContentId, @NotNull Long propertyId, @NotNull ContentPropertyUpdateRequest contentPropertyUpdateRequest, @Nullable Boolean serializeIdsAsStrings) Update content property for custom content by idupdateFooterComment(@NotNull Long commentId, @NotNull UpdateFooterCommentModel updateFooterCommentModel, @Nullable Boolean serializeIdsAsStrings) Update footer commentupdateInlineComment(@NotNull Long commentId, @NotNull UpdateInlineCommentModel updateInlineCommentModel, @Nullable Boolean serializeIdsAsStrings) Update inline commentupdatePage(@NotNull Long id, @NotNull UpdatePageRequest updatePageRequest, @Nullable Boolean serializeIdsAsStrings) Update pageupdatePagePropertyById(@NotNull Long pageId, @NotNull Long propertyId, @NotNull ContentPropertyUpdateRequest contentPropertyUpdateRequest, @Nullable Boolean serializeIdsAsStrings) Update content property for page by idupdateSpacePropertyById(@NotNull Long spaceId, @NotNull Long propertyId, @NotNull SpacePropertyUpdateRequest spacePropertyUpdateRequest, @Nullable Boolean serializeIdsAsStrings) Update space property by idupdateTask(@NotNull Long id, @NotNull UpdateTaskRequest updateTaskRequest, @Nullable Boolean serializeIdsAsStrings) Update task
-
Methodendetails
-
checkAccessByEmail
CheckAccessByEmail200Response checkAccessByEmail(@NotNull @NotNull CheckAccessByEmailRequest checkAccessByEmailRequest) Check site access for a list of emailsReturns the list of emails from the input list that do not have access to site. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site ('Can use' global permission).
- Parameter:
checkAccessByEmailRequest- (required)
-
convertContentIdsToContentTypes
ContentIdToContentTypeResponse convertContentIdsToContentTypes(@NotNull @NotNull ConvertContentIdsToContentTypesRequest convertContentIdsToContentTypesRequest) Convert content ids to content typesConverts 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-commentfor inline comments andfooter-commentfor footer comments, which is distinct from them both being represented bycommentin 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 tonullin the response.- Parameter:
convertContentIdsToContentTypesRequest- (required)
-
createAttachmentProperty
ContentProperty createAttachmentProperty(@NotNull @NotNull String attachmentId, @NotNull @NotNull ContentPropertyCreateRequest contentPropertyCreateRequest, @Nullable @Nullable Boolean serializeIdsAsStrings) Create content property for attachmentCreates a new content property for an attachment. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to update the attachment. Authentication - Required Scopes: [read:attachment:confluence]
- Parameter:
attachmentId- The ID of the attachment to create a property for. (required)contentPropertyCreateRequest- The content property to be created (required)serializeIdsAsStrings- Due to JavaScript's max integer representation of 2^53-1, the type of any IDs returned in the response body for this endpoint will be changed from a numeric type to a string type at the end of the deprecation period. In the meantime, this query param can be passed to this endpoint to opt-in to this change now. See this [changelog](https://developer.atlassian.com/cloud/confluence/changelog/#CHANGE-905) for more detail. (optional, defaults to false)
-
createBlogPost
BlogPostSingle createBlogPost(@NotNull @NotNull CreateBlogPostRequest createBlogPostRequest, @Nullable @Nullable Boolean serializeIdsAsStrings, @Nullable @Nullable Boolean _private) Create blog postCreates a new blog post in the space specified by the spaceId. By default this will create the blog post as a non-draft, unless the status is specified as draft. If creating a non-draft, the title must not be empty. Currently only supports the storage representation specified in the body.representation enums below Authentication - Required Scopes: [write:page:confluence]
- Parameter:
createBlogPostRequest- (required)serializeIdsAsStrings- Due to JavaScript's max integer representation of 2^53-1, the type of any IDs returned in the response body for this endpoint will be changed from a numeric type to a string type at the end of the deprecation period. In the meantime, this query param can be passed to this endpoint to opt-in to this change now. See this [changelog](https://developer.atlassian.com/cloud/confluence/changelog/#CHANGE-905) for more detail. (optional, defaults to false)_private- The blog post will be private. Only the user who creates this blog post will have permission to view and edit one. (optional, defaults to false)
-
createBlogpostProperty
ContentProperty createBlogpostProperty(@NotNull @NotNull Long blogpostId, @NotNull @NotNull ContentPropertyCreateRequest contentPropertyCreateRequest, @Nullable @Nullable Boolean serializeIdsAsStrings) Create content property for blog postCreates a new property for a blogpost. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to update the blog post. Authentication - Required Scopes: [read:page:confluence, write:page:confluence]
- Parameter:
blogpostId- The ID of the blog post to create a property for. (required)contentPropertyCreateRequest- The content property to be created (required)serializeIdsAsStrings- Due to JavaScript's max integer representation of 2^53-1, the type of any IDs returned in the response body for this endpoint will be changed from a numeric type to a string type at the end of the deprecation period. In the meantime, this query param can be passed to this endpoint to opt-in to this change now. See this [changelog](https://developer.atlassian.com/cloud/confluence/changelog/#CHANGE-905) for more detail. (optional, defaults to false)
-
createCommentProperty
ContentProperty createCommentProperty(@NotNull @NotNull Long commentId, @NotNull @NotNull ContentPropertyCreateRequest contentPropertyCreateRequest, @Nullable @Nullable Boolean serializeIdsAsStrings) Create content property for commentCreates a new content property for a comment. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to update the comment. Authentication - Required Scopes: [read:comment:confluence, write:comment:confluence]
- Parameter:
commentId- The ID of the comment to create a property for. (required)contentPropertyCreateRequest- The content property to be created (required)serializeIdsAsStrings- Due to JavaScript's max integer representation of 2^53-1, the type of any IDs returned in the response body for this endpoint will be changed from a numeric type to a string type at the end of the deprecation period. In the meantime, this query param can be passed to this endpoint to opt-in to this change now. See this [changelog](https://developer.atlassian.com/cloud/confluence/changelog/#CHANGE-905) for more detail. (optional, defaults to false)
-
createCustomContent
CustomContentSingle createCustomContent(@NotNull @NotNull CreateCustomContentRequest createCustomContentRequest, @Nullable @Nullable Boolean serializeIdsAsStrings) Create custom contentCreates a new custom content in the given space, page, blogpost or other custom content. Only one of
spaceId,pageId,blogPostId, orcustomContentIdis required in the request body. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content of the page or blogpost and its corresponding space. Permission to create custom content in the space. Authentication - Required Scopes: [write:custom-content:confluence]- Parameter:
createCustomContentRequest- (required)serializeIdsAsStrings- Due to JavaScript's max integer representation of 2^53-1, the type of any IDs returned in the response body for this endpoint will be changed from a numeric type to a string type at the end of the deprecation period. In the meantime, this query param can be passed to this endpoint to opt-in to this change now. See this [changelog](https://developer.atlassian.com/cloud/confluence/changelog/#CHANGE-905) for more detail. (optional, defaults to false)
-
createCustomContentProperty
ContentProperty createCustomContentProperty(@NotNull @NotNull Long customContentId, @NotNull @NotNull ContentPropertyCreateRequest contentPropertyCreateRequest, @Nullable @Nullable Boolean serializeIdsAsStrings) Create content property for custom contentCreates a new content property for a piece of custom content. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to update the custom content. Authentication - Required Scopes: [read:custom-content:confluence, write:custom-content:confluence]
- Parameter:
customContentId- The ID of the custom content to create a property for. (required)contentPropertyCreateRequest- The content property to be created (required)serializeIdsAsStrings- Due to JavaScript's max integer representation of 2^53-1, the type of any IDs returned in the response body for this endpoint will be changed from a numeric type to a string type at the end of the deprecation period. In the meantime, this query param can be passed to this endpoint to opt-in to this change now. See this [changelog](https://developer.atlassian.com/cloud/confluence/changelog/#CHANGE-905) for more detail. (optional, defaults to false)
-
createInlineComment
InlineCommentModel createInlineComment(@NotNull @NotNull CreateInlineCommentModel createInlineCommentModel, @Nullable @Nullable Boolean serializeIdsAsStrings) Create inline commentCreate an inline comment. This can be at the top level (specifying pageId or blogPostId in the request body) or as a reply (specifying parentCommentId in the request body). Note the inlineCommentProperties object in the request body is used to select the text the inline comment should be tied to. This is what determines the text highlighting when viewing a page in Confluence. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content of the page or blogpost and its corresponding space. Permission to create comments in the space. Authentication - Required Scopes: [write:comment:confluence]
- Parameter:
createInlineCommentModel- The inline comment to be created (required)serializeIdsAsStrings- Due to JavaScript's max integer representation of 2^53-1, the type of any IDs returned in the response body for this endpoint will be changed from a numeric type to a string type at the end of the deprecation period. In the meantime, this query param can be passed to this endpoint to opt-in to this change now. See this [changelog](https://developer.atlassian.com/cloud/confluence/changelog/#CHANGE-905) for more detail. (optional, defaults to false)
-
createPage
PageSingle createPage(@NotNull @NotNull CreatePageRequest createPageRequest, @Nullable @Nullable Boolean serializeIdsAsStrings, @Nullable @Nullable Boolean embedded, @Nullable @Nullable Boolean _private) Create pageCreates a page in the space. Pages are created as published by default unless specified as a draft in the status field. If creating a published page, the title must be specified. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the corresponding space. Permission to create a page in the space. Authentication - Required Scopes: [write:page:confluence]
- Parameter:
createPageRequest- (required)serializeIdsAsStrings- Due to JavaScript's max integer representation of 2^53-1, the type of any IDs returned in the response body for this endpoint will be changed from a numeric type to a string type at the end of the deprecation period. In the meantime, this query param can be passed to this endpoint to opt-in to this change now. See this [changelog](https://developer.atlassian.com/cloud/confluence/changelog/#CHANGE-905) for more detail. (optional, defaults to false)embedded- Tag the content as embedded and content will be created in NCS. (optional, defaults to false)_private- The page will be private. Only the user who creates this page will have permission to view and edit one. (optional, defaults to false)
-
createPageProperty
ContentProperty createPageProperty(@NotNull @NotNull Long pageId, @NotNull @NotNull ContentPropertyCreateRequest contentPropertyCreateRequest, @Nullable @Nullable Boolean serializeIdsAsStrings) Create content property for pageCreates a new content property for a page. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to update the page. Authentication - Required Scopes: [read:page:confluence, write:page:confluence]
- Parameter:
pageId- The ID of the page to create a property for. (required)contentPropertyCreateRequest- The content property to be created (required)serializeIdsAsStrings- Due to JavaScript's max integer representation of 2^53-1, the type of any IDs returned in the response body for this endpoint will be changed from a numeric type to a string type at the end of the deprecation period. In the meantime, this query param can be passed to this endpoint to opt-in to this change now. See this [changelog](https://developer.atlassian.com/cloud/confluence/changelog/#CHANGE-905) for more detail. (optional, defaults to false)
-
createSpaceProperty
SpaceProperty createSpaceProperty(@NotNull @NotNull Long spaceId, @NotNull @NotNull SpacePropertyCreateRequest spacePropertyCreateRequest, @Nullable @Nullable Boolean serializeIdsAsStrings) Create space property in spaceCreates a new space property. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site ('Can use' global permission) and 'Admin' permission for the space. Authentication - Required Scopes: [read:space:confluence, write:space:confluence]
- Parameter:
spaceId- The ID of the space for which space properties should be returned. (required)spacePropertyCreateRequest- The space property to be created (required)serializeIdsAsStrings- Due to JavaScript's max integer representation of 2^53-1, the type of any IDs returned in the response body for this endpoint will be changed from a numeric type to a string type at the end of the deprecation period. In the meantime, this query param can be passed to this endpoint to opt-in to this change now. See this [changelog](https://developer.atlassian.com/cloud/confluence/changelog/#CHANGE-905) for more detail. (optional, defaults to false)
-
deleteAttachment
Delete attachmentDelete an attachment by id. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the container of the attachment. Permission to delete attachments in the space.
- Parameter:
id- The ID of the attachment to be deleted. (required)
-
deleteAttachmentPropertyById
void deleteAttachmentPropertyById(@NotNull @NotNull String attachmentId, @NotNull @NotNull Long propertyId) Delete content property for attachment by idDeletes a content property for an attachment by its id. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to attachment the page. Authentication - Required Scopes: [read:attachment:confluence]
- Parameter:
attachmentId- The ID of the attachment the property belongs to. (required)propertyId- The ID of the property to be deleted. (required)
-
deleteBlogPost
Delete blog postDelete 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 delete blog posts in the space. Authentication - Required Scopes: [delete:page:confluence]
- Parameter:
id- The ID of the blog post to be deleted. (required)
-
deleteBlogpostPropertyById
void deleteBlogpostPropertyById(@NotNull @NotNull Long blogpostId, @NotNull @NotNull Long propertyId) Delete content property for blogpost by idDeletes a content property for a blogpost by its id. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to edit the blog post. Authentication - Required Scopes: [read:page:confluence, write:page:confluence]
- Parameter:
blogpostId- The ID of the blog post the property belongs to. (required)propertyId- The ID of the property to be deleted. (required)
-
deleteCommentPropertyById
Delete content property for comment by idDeletes a content property for a comment by its id. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to edit the comment. Authentication - Required Scopes: [read:comment:confluence, write:comment:confluence]
- Parameter:
commentId- The ID of the comment the property belongs to. (required)propertyId- The ID of the property to be deleted. (required)
-
deleteCustomContent
Delete custom contentDelete a custom content by id. **[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. Authentication - Required Scopes: [delete:custom-content:confluence]
- Parameter:
id- The ID of the custom content to be deleted. (required)
-
deleteCustomContentPropertyById
void deleteCustomContentPropertyById(@NotNull @NotNull Long customContentId, @NotNull @NotNull Long propertyId) Delete content property for custom content by idDeletes a content property for a piece of custom content by its id. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to edit the custom content. Authentication - Required Scopes: [read:custom-content:confluence, write:custom-content:confluence]
- Parameter:
customContentId- The ID of the custom content the property belongs to. (required)propertyId- The ID of the property to be deleted. (required)
-
deleteInlineComment
Delete inline commentDeletes an inline comment. This is a permanent deletion and cannot be reverted. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content of the page or blogpost and its corresponding space. Permission to delete comments in the space. Authentication - Required Scopes: [delete:comment:confluence]
- Parameter:
commentId- The ID of the comment to be deleted. (required)
-
deletePage
Delete pageDelete a page by id. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the page and its corresponding space. Permission to delete pages in the space. Authentication - Required Scopes: [delete:page:confluence]
- Parameter:
id- The ID of the page to be deleted. (required)
-
deletePagePropertyById
Delete content property for page by idDeletes a content property for a page by its id. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to edit the page. Authentication - Required Scopes: [read:page:confluence, write:page:confluence]
- Parameter:
pageId- The ID of the page the property belongs to. (required)propertyId- The ID of the property to be deleted. (required)
-
deleteSpacePropertyById
Delete space property by idDeletes a space property by its id. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site ('Can use' global permission) and 'Admin' permission for the space. Authentication - Required Scopes: [read:space:confluence, write:space:confluence]
- Parameter:
spaceId- The ID of the space the property belongs to. (required)propertyId- The ID of the property to be deleted. (required)
-
getAttachmentById
Attachment getAttachmentById(@NotNull @NotNull String id, @Nullable @Nullable Integer version, @Nullable @Nullable Boolean serializeIdsAsStrings) Get attachment by idReturns a specific attachment. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the attachment's container. Authentication - Required Scopes: [read:attachment:confluence]
- Parameter:
id- The ID of the attachment to be returned. If you don't know the attachment's ID, use Get attachments for page/blogpost/custom content. (required)version- Allows you to retrieve a previously published version. Specify the previous version's number to retrieve its details. (optional)serializeIdsAsStrings- Due to JavaScript's max integer representation of 2^53-1, the type of any IDs returned in the response body for this endpoint will be changed from a numeric type to a string type at the end of the deprecation period. In the meantime, this query param can be passed to this endpoint to opt-in to this change now. See this [changelog](https://developer.atlassian.com/cloud/confluence/changelog/#CHANGE-905) for more detail. (optional, defaults to false)
-
getAttachmentContentProperties
MultiEntityResultContentProperty getAttachmentContentProperties(@NotNull @NotNull String attachmentId, @Nullable @Nullable String key, @Nullable @Nullable ContentPropertySortOrder sort, @Nullable @Nullable String cursor, @Nullable @Nullable Integer limit, @Nullable @Nullable Boolean serializeIdsAsStrings) Get content properties for attachmentRetrieves all Content Properties tied to a specified attachment. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the attachment. Authentication - Required Scopes: [read:attachment:confluence]
- Parameter:
attachmentId- The ID of the attachment for which content properties should be returned. (required)key- Filters the response to return a specific content property with matching key (case sensitive). (optional)sort- Used to sort the result by a particular field. (optional)cursor- Used for pagination, this opaque cursor will be returned in thenextURL in theLinkresponse header. Use the relative URL in theLinkheader to retrieve thenextset of results. (optional)limit- Maximum number of attachments per result to return. If more results exist, use theLinkheader to retrieve a relative URL that will return the next set of results. (optional, defaults to 25)serializeIdsAsStrings- Due to JavaScript's max integer representation of 2^53-1, the type of any IDs returned in the response body for this endpoint will be changed from a numeric type to a string type at the end of the deprecation period. In the meantime, this query param can be passed to this endpoint to opt-in to this change now. See this [changelog](https://developer.atlassian.com/cloud/confluence/changelog/#CHANGE-905) for more detail. (optional, defaults to false)
-
getAttachmentContentPropertiesById
ContentProperty getAttachmentContentPropertiesById(@NotNull @NotNull String attachmentId, @NotNull @NotNull Long propertyId, @Nullable @Nullable Boolean serializeIdsAsStrings) Get content property for attachment by idRetrieves a specific Content Property by ID that is attached to a specified attachment. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the attachment. Authentication - Required Scopes: [read:attachment:confluence]
- Parameter:
attachmentId- The ID of the attachment for which content properties should be returned. (required)propertyId- The ID of the content property to be returned (required)serializeIdsAsStrings- Due to JavaScript's max integer representation of 2^53-1, the type of any IDs returned in the response body for this endpoint will be changed from a numeric type to a string type at the end of the deprecation period. In the meantime, this query param can be passed to this endpoint to opt-in to this change now. See this [changelog](https://developer.atlassian.com/cloud/confluence/changelog/#CHANGE-905) for more detail. (optional, defaults to false)
-
getAttachmentLabels
MultiEntityResultLabel getAttachmentLabels(@NotNull @NotNull Long id, @Nullable @Nullable String prefix, @Nullable @Nullable List<LabelSortOrder> sort, @Nullable @Nullable String cursor, @Nullable @Nullable Integer limit, @Nullable @Nullable Boolean serializeIdsAsStrings) Get labels for attachmentReturns the labels of specific attachment. The number of results is limited by the
limitparameter and additional results (if available) will be available through thenextURL present in theLinkresponse header. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the parent content of the attachment and its corresponding space. Authentication - Required Scopes: [read:attachment:confluence]- Parameter:
id- The ID of the attachment for which labels should be returned. (required)prefix- Filter the results to labels based on their prefix. (optional)sort- Used to sort the result by a particular field. (optional)cursor- Used for pagination, this opaque cursor will be returned in thenextURL in theLinkresponse header. Use the relative URL in theLinkheader to retrieve thenextset of results. (optional)limit- Maximum number of labels per result to return. If more results exist, use theLinkheader to retrieve a relative URL that will return the next set of results. (optional, defaults to 25)serializeIdsAsStrings- Due to JavaScript's max integer representation of 2^53-1, the type of any IDs returned in the response body for this endpoint will be changed from a numeric type to a string type at the end of the deprecation period. In the meantime, this query param can be passed to this endpoint to opt-in to this change now. See this [changelog](https://developer.atlassian.com/cloud/confluence/changelog/#CHANGE-905) for more detail. (optional, defaults to false)
-
getAttachmentOperations
Get permitted operations for attachmentReturns the permitted operations on specific attachment. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the parent content of the attachment and its corresponding space. Authentication - Required Scopes: [read:attachment:confluence]
- Parameter:
id- The ID of the attachment for which operations should be returned. (required)
-
getAttachmentVersionDetails
DetailedVersion getAttachmentVersionDetails(@NotNull @NotNull String attachmentId, @NotNull @NotNull Long versionNumber) Get version details for attachment versionRetrieves version details for the specified attachment and version number. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the attachment. Authentication - Required Scopes: [read:attachment:confluence]
- Parameter:
attachmentId- The ID of the attachment for which version details should be returned. (required)versionNumber- The version number of the attachment to be returned. (required)
-
getAttachmentVersions
MultiEntityResultVersion getAttachmentVersions(@NotNull @NotNull String id, @Nullable @Nullable String cursor, @Nullable @Nullable Integer limit, @Nullable @Nullable VersionSortOrder sort) Get attachment versionsReturns the versions of specific attachment. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the attachment and its corresponding space. Authentication - Required Scopes: [read:attachment:confluence]
- Parameter:
id- The ID of the attachment to be queried for its versions. If you don't know the attachment ID, use Get attachments and filter the results. (required)cursor- Used for pagination, this opaque cursor will be returned in thenextURL in theLinkresponse header. Use the relative URL in theLinkheader to retrieve thenextset of results. (optional)limit- Maximum number of versions per result to return. If more results exist, use theLinkheader to retrieve a relative URL that will return the next set of results. (optional, defaults to 25)sort- Used to sort the result by a particular field. (optional)
-
getAttachments
MultiEntityResultAttachment getAttachments(@Nullable @Nullable AttachmentSortOrder sort, @Nullable @Nullable String cursor, @Nullable @Nullable List<String> status, @Nullable @Nullable String mediaType, @Nullable @Nullable String filename, @Nullable @Nullable Integer limit, @Nullable @Nullable Boolean serializeIdsAsStrings) Get attachmentsReturns all attachments. The number of results is limited by the
limitparameter and additional results (if available) will be available through thenextURL present in theLinkresponse header. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the container of the attachment. Authentication - Required Scopes: [read:attachment:confluence]- Parameter:
sort- Used to sort the result by a particular field. (optional)cursor- Used for pagination, this opaque cursor will be returned in thenextURL in theLinkresponse header. Use the relative URL in theLinkheader to retrieve thenextset of results. (optional)status- Filter the results to attachments based on their status. By default,currentandarchivedare used. (optional)mediaType- Filters on the mediaType of attachments. Only one may be specified. (optional)filename- Filters on the file-name of attachments. Only one may be specified. (optional)limit- Maximum number of attachments per result to return. If more results exist, use theLinkheader to retrieve a relative URL that will return the next set of results. (optional, defaults to 50)serializeIdsAsStrings- Due to JavaScript's max integer representation of 2^53-1, the type of any IDs returned in the response body for this endpoint will be changed from a numeric type to a string type at the end of the deprecation period. In the meantime, this query param can be passed to this endpoint to opt-in to this change now. See this [changelog](https://developer.atlassian.com/cloud/confluence/changelog/#CHANGE-905) for more detail. (optional, defaults to false)
-
getBlogPostById
BlogPostSingle getBlogPostById(@NotNull @NotNull Long id, @Nullable @Nullable PrimaryBodyRepresentationSingle bodyFormat, @Nullable @Nullable Boolean getDraft, @Nullable @Nullable Integer version, @Nullable @Nullable Boolean serializeIdsAsStrings) Get blog post by idReturns a specific blog post. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the blog post and its corresponding space. Authentication - Required Scopes: [read:page:confluence]
- Parameter:
id- The ID of the blog post to be returned. If you don't know the blog post ID, use Get blog posts and filter the results. (required)bodyFormat- The content format types to be returned in thebodyfield of the response. If available, the representation will be available under a response field of the same name under thebodyfield. (optional)getDraft- Retrieve the draft version of this blog post. (optional, defaults to false)version- Allows you to retrieve a previously published version. Specify the previous version's number to retrieve its details. (optional)serializeIdsAsStrings- Due to JavaScript's max integer representation of 2^53-1, the type of any IDs returned in the response body for this endpoint will be changed from a numeric type to a string type at the end of the deprecation period. In the meantime, this query param can be passed to this endpoint to opt-in to this change now. See this [changelog](https://developer.atlassian.com/cloud/confluence/changelog/#CHANGE-905) for more detail. (optional, defaults to false)
-
getBlogPostInlineComments
MultiEntityResultBlogPostInlineCommentModel getBlogPostInlineComments(@NotNull @NotNull Long id, @Nullable @Nullable PrimaryBodyRepresentation bodyFormat, @Nullable @Nullable CommentSortOrder sort, @Nullable @Nullable String cursor, @Nullable @Nullable Integer limit, @Nullable @Nullable Boolean serializeIdsAsStrings) Get inline comments for blog postReturns the root inline comments of specific blog post. The number of results is limited by the
limitparameter and additional results (if available) will be available through thenextURL present in theLinkresponse header. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content of the blog post and its corresponding space. Authentication - Required Scopes: [read:comment:confluence]- Parameter:
id- The ID of the blog post for which inline comments should be returned. (required)bodyFormat- The content format type to be returned in thebodyfield of the response. If available, the representation will be available under a response field of the same name under thebodyfield. (optional)sort- Used to sort the result by a particular field. (optional)cursor- Used for pagination, this opaque cursor will be returned in thenextURL in theLinkresponse header. Use the relative URL in theLinkheader to retrieve thenextset of results. (optional)limit- Maximum number of inline comments per result to return. If more results exist, use theLinkheader to retrieve a relative URL that will return the next set of results. (optional, defaults to 25)serializeIdsAsStrings- Due to JavaScript's max integer representation of 2^53-1, the type of any IDs returned in the response body for this endpoint will be changed from a numeric type to a string type at the end of the deprecation period. In the meantime, this query param can be passed to this endpoint to opt-in to this change now. See this [changelog](https://developer.atlassian.com/cloud/confluence/changelog/#CHANGE-905) for more detail. (optional, defaults to false)
-
getBlogPostLabels
MultiEntityResultLabel getBlogPostLabels(@NotNull @NotNull Long id, @Nullable @Nullable String prefix, @Nullable @Nullable List<LabelSortOrder> sort, @Nullable @Nullable String cursor, @Nullable @Nullable Integer limit, @Nullable @Nullable Boolean serializeIdsAsStrings) Get labels for blog postReturns the labels of specific blog post. The number of results is limited by the
limitparameter and additional results (if available) will be available through thenextURL present in theLinkresponse header. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content of the blog post and its corresponding space. Authentication - Required Scopes: [read:page:confluence]- Parameter:
id- The ID of the blog post for which labels should be returned. (required)prefix- Filter the results to labels based on their prefix. (optional)sort- Used to sort the result by a particular field. (optional)cursor- Used for pagination, this opaque cursor will be returned in thenextURL in theLinkresponse header. Use the relative URL in theLinkheader to retrieve thenextset of results. (optional)limit- Maximum number of labels per result to return. If more results exist, use theLinkheader to retrieve a relative URL that will return the next set of results. (optional, defaults to 25)serializeIdsAsStrings- Due to JavaScript's max integer representation of 2^53-1, the type of any IDs returned in the response body for this endpoint will be changed from a numeric type to a string type at the end of the deprecation period. In the meantime, this query param can be passed to this endpoint to opt-in to this change now. See this [changelog](https://developer.atlassian.com/cloud/confluence/changelog/#CHANGE-905) for more detail. (optional, defaults to false)
-
getBlogPostLikeCount
Get like count for blog postReturns the count of likes of specific blog post. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content of the blog post and its corresponding space. Authentication - Required Scopes: [read:page:confluence]
- Parameter:
id- The ID of the blog post for which like count should be returned. (required)
-
getBlogPostLikeUsers
MultiEntityResultString getBlogPostLikeUsers(@NotNull @NotNull Long id, @Nullable @Nullable String cursor, @Nullable @Nullable Integer limit) Get account IDs of likes for blog postReturns the account IDs of likes of specific blog post. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content of the blog post and its corresponding space. Authentication - Required Scopes: [read:page:confluence]
- Parameter:
id- The ID of the blog post for which account IDs should be returned. (required)cursor- Used for pagination, this opaque cursor will be returned in thenextURL in theLinkresponse header. Use the relative URL in theLinkheader to retrieve thenextset of results. (optional)limit- Maximum number of account IDs per result to return. If more results exist, use theLinkheader to retrieve a relative URL that will return the next set of results. (optional, defaults to 25)
-
getBlogPostOperations
Get permitted operations for blog postReturns the permitted operations on specific blog post. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the parent content of the blog post and its corresponding space. Authentication - Required Scopes: [read:page:confluence]
- Parameter:
id- The ID of the blog post for which operations should be returned. (required)
-
getBlogPostVersionDetails
DetailedVersion getBlogPostVersionDetails(@NotNull @NotNull Long blogpostId, @NotNull @NotNull Long versionNumber) Get version details for blog post versionRetrieves version details for the specified blog post and version number. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the blog post. Authentication - Required Scopes: [read:page:confluence]
- Parameter:
blogpostId- The ID of the blog post for which version details should be returned. (required)versionNumber- The version number of the blog post to be returned. (required)
-
getBlogPostVersions
MultiEntityResultVersion1 getBlogPostVersions(@NotNull @NotNull Long id, @Nullable @Nullable PrimaryBodyRepresentation bodyFormat, @Nullable @Nullable String cursor, @Nullable @Nullable Integer limit, @Nullable @Nullable VersionSortOrder sort) Get blog post versionsReturns the versions of specific blog post. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the blog post and its corresponding space. Authentication - Required Scopes: [read:page:confluence]
- Parameter:
id- The ID of the blog post to be queried for its versions. If you don't know the blog post ID, use Get blog posts and filter the results. (required)bodyFormat- The content format types to be returned in thebodyfield of the response. If available, the representation will be available under a response field of the same name under thebodyfield. (optional)cursor- Used for pagination, this opaque cursor will be returned in thenextURL in theLinkresponse header. Use the relative URL in theLinkheader to retrieve thenextset of results. (optional)limit- Maximum number of versions per result to return. If more results exist, use theLinkheader to retrieve a relative URL that will return the next set of results. (optional, defaults to 25)sort- Used to sort the result by a particular field. (optional)
-
getBlogPosts
MultiEntityResultBlogPost getBlogPosts(@Nullable @Nullable List<Long> id, @Nullable @Nullable List<Long> spaceId, @Nullable @Nullable BlogPostSortOrder sort, @Nullable @Nullable List<String> status, @Nullable @Nullable String title, @Nullable @Nullable PrimaryBodyRepresentation bodyFormat, @Nullable @Nullable String cursor, @Nullable @Nullable Integer limit, @Nullable @Nullable Boolean serializeIdsAsStrings) Get blog postsReturns all blog posts. The number of results is limited by the
limitparameter and additional results (if available) will be available through thenextURL present in theLinkresponse header. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site ('Can use' global permission). Only blog posts that the user has permission to view will be returned. Authentication - Required Scopes: [read:page:confluence]- Parameter:
id- Filter the results based on blog post ids. Multiple blog post ids can be specified as a comma-separated list. (optional)spaceId- Filter the results based on space ids. Multiple space ids can be specified as a comma-separated list. (optional)sort- Used to sort the result by a particular field. (optional)status- Filter the results to blog posts based on their status. By default,currentis used. (optional)title- Filter the results to blog posts based on their title. (optional)bodyFormat- The content format types to be returned in thebodyfield of the response. If available, the representation will be available under a response field of the same name under thebodyfield. (optional)cursor- Used for pagination, this opaque cursor will be returned in thenextURL in theLinkresponse header. Use the relative URL in theLinkheader to retrieve thenextset of results. (optional)limit- Maximum number of blog posts per result to return. If more results exist, use theLinkresponse header to retrieve a relative URL that will return the next set of results. (optional, defaults to 25)serializeIdsAsStrings- Due to JavaScript's max integer representation of 2^53-1, the type of any IDs returned in the response body for this endpoint will be changed from a numeric type to a string type at the end of the deprecation period. In the meantime, this query param can be passed to this endpoint to opt-in to this change now. See this [changelog](https://developer.atlassian.com/cloud/confluence/changelog/#CHANGE-905) for more detail. (optional, defaults to false)
-
getBlogPostsInSpace
MultiEntityResultBlogPost getBlogPostsInSpace(@NotNull @NotNull Long id, @Nullable @Nullable BlogPostSortOrder sort, @Nullable @Nullable List<String> status, @Nullable @Nullable String title, @Nullable @Nullable PrimaryBodyRepresentation bodyFormat, @Nullable @Nullable String cursor, @Nullable @Nullable Integer limit, @Nullable @Nullable Boolean serializeIdsAsStrings) Get blog posts in spaceReturns all blog posts in a space. The number of results is limited by the
limitparameter and additional results (if available) will be available through thenextURL present in theLinkresponse header. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site ('Can use' global permission) and view the space. Only blog posts that the user has permission to view will be returned. Authentication - Required Scopes: [read:page:confluence]- Parameter:
id- The ID of the space for which blog posts should be returned. (required)sort- Used to sort the result by a particular field. (optional)status- Filter the results to blog posts based on their status. By default,currentis used. (optional)title- Filter the results to blog posts based on their title. (optional)bodyFormat- The content format types to be returned in thebodyfield of the response. If available, the representation will be available under a response field of the same name under thebodyfield. (optional)cursor- Used for pagination, this opaque cursor will be returned in thenextURL in theLinkresponse header. Use the relative URL in theLinkheader to retrieve thenextset of results. (optional)limit- Maximum number of blog posts per result to return. If more results exist, use theLinkheader to retrieve a relative URL that will return the next set of results. (optional, defaults to 25)serializeIdsAsStrings- Due to JavaScript's max integer representation of 2^53-1, the type of any IDs returned in the response body for this endpoint will be changed from a numeric type to a string type at the end of the deprecation period. In the meantime, this query param can be passed to this endpoint to opt-in to this change now. See this [changelog](https://developer.atlassian.com/cloud/confluence/changelog/#CHANGE-905) for more detail. (optional, defaults to false)
-
getBlogpostAttachments
MultiEntityResultAttachment getBlogpostAttachments(@NotNull @NotNull Long id, @Nullable @Nullable AttachmentSortOrder sort, @Nullable @Nullable String cursor, @Nullable @Nullable List<String> status, @Nullable @Nullable String mediaType, @Nullable @Nullable String filename, @Nullable @Nullable Integer limit, @Nullable @Nullable Boolean serializeIdsAsStrings) Get attachments for blog postReturns the attachments of specific blog post. The number of results is limited by the
limitparameter and additional results (if available) will be available through thenextURL present in theLinkresponse header. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content of the blog post and its corresponding space. Authentication - Required Scopes: [read:attachment:confluence]- Parameter:
id- The ID of the blog post for which attachments should be returned. (required)sort- Used to sort the result by a particular field. (optional)cursor- Used for pagination, this opaque cursor will be returned in thenextURL in theLinkresponse header. Use the relative URL in theLinkheader to retrieve thenextset of results. (optional)status- Filter the results to attachments based on their status. By default,currentandarchivedare used. (optional)mediaType- Filters on the mediaType of attachments. Only one may be specified. (optional)filename- Filters on the file-name of attachments. Only one may be specified. (optional)limit- Maximum number of attachments per result to return. If more results exist, use theLinkheader to retrieve a relative URL that will return the next set of results. (optional, defaults to 50)serializeIdsAsStrings- Due to JavaScript's max integer representation of 2^53-1, the type of any IDs returned in the response body for this endpoint will be changed from a numeric type to a string type at the end of the deprecation period. In the meantime, this query param can be passed to this endpoint to opt-in to this change now. See this [changelog](https://developer.atlassian.com/cloud/confluence/changelog/#CHANGE-905) for more detail. (optional, defaults to false)
-
getBlogpostContentProperties
MultiEntityResultContentProperty getBlogpostContentProperties(@NotNull @NotNull Long blogpostId, @Nullable @Nullable String key, @Nullable @Nullable ContentPropertySortOrder sort, @Nullable @Nullable String cursor, @Nullable @Nullable Integer limit, @Nullable @Nullable Boolean serializeIdsAsStrings) Get content properties for blog postRetrieves all Content Properties tied to a specified blog post. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the blog post. Authentication - Required Scopes: [read:page:confluence]
- Parameter:
blogpostId- The ID of the blog post for which content properties should be returned. (required)key- Filters the response to return a specific content property with matching key (case sensitive). (optional)sort- Used to sort the result by a particular field. (optional)cursor- Used for pagination, this opaque cursor will be returned in thenextURL in theLinkresponse header. Use the relative URL in theLinkheader to retrieve thenextset of results. (optional)limit- Maximum number of attachments per result to return. If more results exist, use theLinkheader to retrieve a relative URL that will return the next set of results. (optional, defaults to 25)serializeIdsAsStrings- Due to JavaScript's max integer representation of 2^53-1, the type of any IDs returned in the response body for this endpoint will be changed from a numeric type to a string type at the end of the deprecation period. In the meantime, this query param can be passed to this endpoint to opt-in to this change now. See this [changelog](https://developer.atlassian.com/cloud/confluence/changelog/#CHANGE-905) for more detail. (optional, defaults to false)
-
getBlogpostContentPropertiesById
ContentProperty getBlogpostContentPropertiesById(@NotNull @NotNull Long blogpostId, @NotNull @NotNull Long propertyId, @Nullable @Nullable Boolean serializeIdsAsStrings) Get content property for blog post by idRetrieves a specific Content Property by ID that is attached to a specified blog post. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the blog post. Authentication - Required Scopes: [read:page:confluence]
- Parameter:
blogpostId- The ID of the blog post for which content properties should be returned. (required)propertyId- The ID of the property being requested (required)serializeIdsAsStrings- Due to JavaScript's max integer representation of 2^53-1, the type of any IDs returned in the response body for this endpoint will be changed from a numeric type to a string type at the end of the deprecation period. In the meantime, this query param can be passed to this endpoint to opt-in to this change now. See this [changelog](https://developer.atlassian.com/cloud/confluence/changelog/#CHANGE-905) for more detail. (optional, defaults to false)
-
getChildCustomContent
MultiEntityResultChildCustomContent getChildCustomContent(@NotNull @NotNull Long id, @Nullable @Nullable String cursor, @Nullable @Nullable Integer limit, @Nullable @Nullable List<ChildCustomContentSortOrder> sort, @Nullable @Nullable Boolean serializeIdsAsStrings) Get child custom contentReturns all child custom content for given custom content id. The number of results is limited by the
limitparameter and additional results (if available) will be available through thenextURL present in theLinkresponse header. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site ('Can use' global permission). Only custom content that the user has permission to view will be returned. Authentication - Required Scopes: [read:custom-content:confluence]- Parameter:
id- The ID of the parent custom content. If you don't know the custom content ID, use Get custom-content and filter the results. (required)cursor- Used for pagination, this opaque cursor will be returned in thenextURL in theLinkresponse header. Use the relative URL in theLinkheader to retrieve thenextset of results. (optional)limit- Maximum number of pages per result to return. If more results exist, use theLinkheader to retrieve a relative URL that will return the next set of results. (optional, defaults to 25)sort- Used to sort the result by a particular field. (optional)serializeIdsAsStrings- Due to JavaScript's max integer representation of 2^53-1, the type of any IDs returned in the response body for this endpoint will be changed from a numeric type to a string type at the end of the deprecation period. In the meantime, this query param can be passed to this endpoint to opt-in to this change now. See this [changelog](https://developer.atlassian.com/cloud/confluence/changelog/#CHANGE-905) for more detail. (optional, defaults to false)
-
getChildPages
MultiEntityResultChildPage getChildPages(@NotNull @NotNull Long id, @Nullable @Nullable String cursor, @Nullable @Nullable Integer limit, @Nullable @Nullable List<ChildPageSortOrder> sort, @Nullable @Nullable Boolean serializeIdsAsStrings) Get child pagesReturns all child pages for given page id. The number of results is limited by the
limitparameter and additional results (if available) will be available through thenextURL present in theLinkresponse header. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site ('Can use' global permission). Only pages that the user has permission to view will be returned. Authentication - Required Scopes: [read:page:confluence]- Parameter:
id- The ID of the parent page. If you don't know the page ID, use Get pages and filter the results. (required)cursor- Used for pagination, this opaque cursor will be returned in thenextURL in theLinkresponse header. Use the relative URL in theLinkheader to retrieve thenextset of results. (optional)limit- Maximum number of pages per result to return. If more results exist, use theLinkheader to retrieve a relative URL that will return the next set of results. (optional, defaults to 25)sort- Used to sort the result by a particular field. (optional)serializeIdsAsStrings- Due to JavaScript's max integer representation of 2^53-1, the type of any IDs returned in the response body for this endpoint will be changed from a numeric type to a string type at the end of the deprecation period. In the meantime, this query param can be passed to this endpoint to opt-in to this change now. See this [changelog](https://developer.atlassian.com/cloud/confluence/changelog/#CHANGE-905) for more detail. (optional, defaults to false)
-
getCommentContentProperties
MultiEntityResultContentProperty getCommentContentProperties(@NotNull @NotNull Long commentId, @Nullable @Nullable String key, @Nullable @Nullable ContentPropertySortOrder sort, @Nullable @Nullable String cursor, @Nullable @Nullable Integer limit, @Nullable @Nullable Boolean serializeIdsAsStrings) Get content properties for commentRetrieves Content Properties attached to a specified comment. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the comment. Authentication - Required Scopes: [read:comment:confluence]
- Parameter:
commentId- The ID of the comment for which content properties should be returned. (required)key- Filters the response to return a specific content property with matching key (case sensitive). (optional)sort- Used to sort the result by a particular field. (optional)cursor- Used for pagination, this opaque cursor will be returned in thenextURL in theLinkresponse header. Use the relative URL in theLinkheader to retrieve thenextset of results. (optional)limit- Maximum number of attachments per result to return. If more results exist, use theLinkheader to retrieve a relative URL that will return the next set of results. (optional, defaults to 25)serializeIdsAsStrings- Due to JavaScript's max integer representation of 2^53-1, the type of any IDs returned in the response body for this endpoint will be changed from a numeric type to a string type at the end of the deprecation period. In the meantime, this query param can be passed to this endpoint to opt-in to this change now. See this [changelog](https://developer.atlassian.com/cloud/confluence/changelog/#CHANGE-905) for more detail. (optional, defaults to false)
-
getCommentContentPropertiesById
ContentProperty getCommentContentPropertiesById(@NotNull @NotNull Long commentId, @NotNull @NotNull Long propertyId, @Nullable @Nullable Boolean serializeIdsAsStrings) Get content property for comment by idRetrieves a specific Content Property by ID that is attached to a specified comment. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the comment. Authentication - Required Scopes: [read:comment:confluence]
- Parameter:
commentId- The ID of the comment for which content properties should be returned. (required)propertyId- The ID of the content property being requested. (required)serializeIdsAsStrings- Due to JavaScript's max integer representation of 2^53-1, the type of any IDs returned in the response body for this endpoint will be changed from a numeric type to a string type at the end of the deprecation period. In the meantime, this query param can be passed to this endpoint to opt-in to this change now. See this [changelog](https://developer.atlassian.com/cloud/confluence/changelog/#CHANGE-905) for more detail. (optional, defaults to false)
-
getCustomContentAttachments
MultiEntityResultAttachment getCustomContentAttachments(@NotNull @NotNull Long id, @Nullable @Nullable AttachmentSortOrder sort, @Nullable @Nullable String cursor, @Nullable @Nullable List<String> status, @Nullable @Nullable String mediaType, @Nullable @Nullable String filename, @Nullable @Nullable Integer limit, @Nullable @Nullable Boolean serializeIdsAsStrings) Get attachments for custom contentReturns the attachments of specific custom content. The number of results is limited by the
limitparameter and additional results (if available) will be available through thenextURL present in theLinkresponse header. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content of the custom content and its corresponding space. Authentication - Required Scopes: [read:attachment:confluence]- Parameter:
id- The ID of the custom content for which attachments should be returned. (required)sort- Used to sort the result by a particular field. (optional)cursor- Used for pagination, this opaque cursor will be returned in thenextURL in theLinkresponse header. Use the relative URL in theLinkheader to retrieve thenextset of results. (optional)status- Filter the results to attachments based on their status. By default,currentandarchivedare used. (optional)mediaType- Filters on the mediaType of attachments. Only one may be specified. (optional)filename- Filters on the file-name of attachments. Only one may be specified. (optional)limit- Maximum number of attachments per result to return. If more results exist, use theLinkheader to retrieve a relative URL that will return the next set of results. (optional, defaults to 50)serializeIdsAsStrings- Due to JavaScript's max integer representation of 2^53-1, the type of any IDs returned in the response body for this endpoint will be changed from a numeric type to a string type at the end of the deprecation period. In the meantime, this query param can be passed to this endpoint to opt-in to this change now. See this [changelog](https://developer.atlassian.com/cloud/confluence/changelog/#CHANGE-905) for more detail. (optional, defaults to false)
-
getCustomContentById
CustomContentSingle getCustomContentById(@NotNull @NotNull Long id, @Nullable @Nullable CustomContentBodyRepresentationSingle bodyFormat, @Nullable @Nullable Integer version, @Nullable @Nullable Boolean serializeIdsAsStrings) Get custom content by idReturns a specific piece of custom content. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the custom content, the container of the custom content, and the corresponding space (if different from the container). Authentication - Required Scopes: [read:custom-content:confluence]
- Parameter:
id- The ID of the custom content to be returned. If you don't know the custom content ID, use Get Custom Content by Type and filter the results. (required)bodyFormat- The content format types to be returned in thebodyfield of the response. If available, the representation will be available under a response field of the same name under thebodyfield. Note: If the custom content body type isstorage, thestorageandatlas_doc_formatbody formats are able to be returned. If the custom content body type israw, only therawbody format is able to be returned. (optional)version- Allows you to retrieve a previously published version. Specify the previous version's number to retrieve its details. (optional)serializeIdsAsStrings- Due to JavaScript's max integer representation of 2^53-1, the type of any IDs returned in the response body for this endpoint will be changed from a numeric type to a string type at the end of the deprecation period. In the meantime, this query param can be passed to this endpoint to opt-in to this change now. See this [changelog](https://developer.atlassian.com/cloud/confluence/changelog/#CHANGE-905) for more detail. (optional, defaults to false)
-
getCustomContentByType
MultiEntityResultCustomContent getCustomContentByType(@NotNull @NotNull String type, @Nullable @Nullable List<Long> id, @Nullable @Nullable List<Long> spaceId, @Nullable @Nullable CustomContentSortOrder sort, @Nullable @Nullable String cursor, @Nullable @Nullable Integer limit, @Nullable @Nullable CustomContentBodyRepresentation bodyFormat, @Nullable @Nullable Boolean serializeIdsAsStrings) Get custom content by typeReturns all custom content for a given type. The number of results is limited by the
limitparameter and additional results (if available) will be available through thenextURL present in theLinkresponse header. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the custom content, the container of the custom content, and the corresponding space (if different from the container). Authentication - Required Scopes: [read:custom-content:confluence]- Parameter:
type- The type of custom content being requested. See: https://developer.atlassian.com/cloud/confluence/custom-content/ for additional details on custom content. (required)id- Filter the results based on custom content ids. Multiple custom content ids can be specified as a comma-separated list. (optional)spaceId- Filter the results based on space ids. Multiple space ids can be specified as a comma-separated list. (optional)sort- Used to sort the result by a particular field. (optional)cursor- Used for pagination, this opaque cursor will be returned in thenextURL in theLinkresponse header. Use the relative URL in theLinkheader to retrieve thenextset of results. (optional)limit- Maximum number of pages per result to return. If more results exist, use theLinkheader to retrieve a relative URL that will return the next set of results. (optional, defaults to 25)bodyFormat- The content format types to be returned in thebodyfield of the response. If available, the representation will be available under a response field of the same name under thebodyfield. Note: If the custom content body type isstorage, thestorageandatlas_doc_formatbody formats are able to be returned. If the custom content body type israw, only therawbody format is able to be returned. (optional)serializeIdsAsStrings- Due to JavaScript's max integer representation of 2^53-1, the type of any IDs returned in the response body for this endpoint will be changed from a numeric type to a string type at the end of the deprecation period. In the meantime, this query param can be passed to this endpoint to opt-in to this change now. See this [changelog](https://developer.atlassian.com/cloud/confluence/changelog/#CHANGE-905) for more detail. (optional, defaults to false)
-
getCustomContentByTypeInBlogPost
MultiEntityResultCustomContent getCustomContentByTypeInBlogPost(@NotNull @NotNull Long id, @NotNull @NotNull String type, @Nullable @Nullable CustomContentSortOrder sort, @Nullable @Nullable String cursor, @Nullable @Nullable Integer limit, @Nullable @Nullable CustomContentBodyRepresentation bodyFormat, @Nullable @Nullable Boolean serializeIdsAsStrings) Get custom content by type in blog postReturns all custom content for a given type within a given blogpost. The number of results is limited by the
limitparameter and additional results (if available) will be available through thenextURL present in theLinkresponse header. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the custom content, the container of the custom content (blog post), and the corresponding space. Authentication - Required Scopes: [read:custom-content:confluence]- Parameter:
id- The ID of the blog post for which custom content should be returned. (required)type- The type of custom content being requested. See: https://developer.atlassian.com/cloud/confluence/custom-content/ for additional details on custom content. (required)sort- Used to sort the result by a particular field. (optional)cursor- Used for pagination, this opaque cursor will be returned in thenextURL in theLinkresponse header. Use the relative URL in theLinkheader to retrieve thenextset of results. (optional)limit- Maximum number of pages per result to return. If more results exist, use theLinkheader to retrieve a relative URL that will return the next set of results. (optional, defaults to 25)bodyFormat- The content format types to be returned in thebodyfield of the response. If available, the representation will be available under a response field of the same name under thebodyfield. Note: If the custom content body type isstorage, thestorageandatlas_doc_formatbody formats are able to be returned. If the custom content body type israw, only therawbody format is able to be returned. (optional)serializeIdsAsStrings- Due to JavaScript's max integer representation of 2^53-1, the type of any IDs returned in the response body for this endpoint will be changed from a numeric type to a string type at the end of the deprecation period. In the meantime, this query param can be passed to this endpoint to opt-in to this change now. See this [changelog](https://developer.atlassian.com/cloud/confluence/changelog/#CHANGE-905) for more detail. (optional, defaults to false)
-
getCustomContentByTypeInPage
MultiEntityResultCustomContent getCustomContentByTypeInPage(@NotNull @NotNull Long id, @NotNull @NotNull String type, @Nullable @Nullable CustomContentSortOrder sort, @Nullable @Nullable String cursor, @Nullable @Nullable Integer limit, @Nullable @Nullable CustomContentBodyRepresentation bodyFormat, @Nullable @Nullable Boolean serializeIdsAsStrings) Get custom content by type in pageReturns all custom content for a given type within a given page. The number of results is limited by the
limitparameter and additional results (if available) will be available through thenextURL present in theLinkresponse header. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the custom content, the container of the custom content (page), and the corresponding space. Authentication - Required Scopes: [read:custom-content:confluence]- Parameter:
id- The ID of the page for which custom content should be returned. (required)type- The type of custom content being requested. See: https://developer.atlassian.com/cloud/confluence/custom-content/ for additional details on custom content. (required)sort- Used to sort the result by a particular field. (optional)cursor- Used for pagination, this opaque cursor will be returned in thenextURL in theLinkresponse header. Use the relative URL in theLinkheader to retrieve thenextset of results. (optional)limit- Maximum number of pages per result to return. If more results exist, use theLinkheader to retrieve a relative URL that will return the next set of results. (optional, defaults to 25)bodyFormat- The content format types to be returned in thebodyfield of the response. If available, the representation will be available under a response field of the same name under thebodyfield. Note: If the custom content body type isstorage, thestorageandatlas_doc_formatbody formats are able to be returned. If the custom content body type israw, only therawbody format is able to be returned. (optional)serializeIdsAsStrings- Due to JavaScript's max integer representation of 2^53-1, the type of any IDs returned in the response body for this endpoint will be changed from a numeric type to a string type at the end of the deprecation period. In the meantime, this query param can be passed to this endpoint to opt-in to this change now. See this [changelog](https://developer.atlassian.com/cloud/confluence/changelog/#CHANGE-905) for more detail. (optional, defaults to false)
-
getCustomContentByTypeInSpace
MultiEntityResultCustomContent getCustomContentByTypeInSpace(@NotNull @NotNull Long id, @NotNull @NotNull String type, @Nullable @Nullable String cursor, @Nullable @Nullable Integer limit, @Nullable @Nullable CustomContentBodyRepresentation bodyFormat, @Nullable @Nullable Boolean serializeIdsAsStrings) Get custom content by type in spaceReturns all custom content for a given type within a given space. The number of results is limited by the
limitparameter and additional results (if available) will be available through thenextURL present in theLinkresponse header. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the custom content and the corresponding space. Authentication - Required Scopes: [read:custom-content:confluence]- Parameter:
id- The ID of the space for which custom content should be returned. (required)type- The type of custom content being requested. See: https://developer.atlassian.com/cloud/confluence/custom-content/ for additional details on custom content. (required)cursor- Used for pagination, this opaque cursor will be returned in thenextURL in theLinkresponse header. Use the relative URL in theLinkheader to retrieve thenextset of results. (optional)limit- Maximum number of pages per result to return. If more results exist, use theLinkheader to retrieve a relative URL that will return the next set of results. (optional, defaults to 25)bodyFormat- The content format types to be returned in thebodyfield of the response. If available, the representation will be available under a response field of the same name under thebodyfield. Note: If the custom content body type isstorage, thestorageandatlas_doc_formatbody formats are able to be returned. If the custom content body type israw, only therawbody format is able to be returned. (optional)serializeIdsAsStrings- Due to JavaScript's max integer representation of 2^53-1, the type of any IDs returned in the response body for this endpoint will be changed from a numeric type to a string type at the end of the deprecation period. In the meantime, this query param can be passed to this endpoint to opt-in to this change now. See this [changelog](https://developer.atlassian.com/cloud/confluence/changelog/#CHANGE-905) for more detail. (optional, defaults to false)
-
getCustomContentContentProperties
MultiEntityResultContentProperty getCustomContentContentProperties(@NotNull @NotNull Long customContentId, @Nullable @Nullable String key, @Nullable @Nullable ContentPropertySortOrder sort, @Nullable @Nullable String cursor, @Nullable @Nullable Integer limit, @Nullable @Nullable Boolean serializeIdsAsStrings) Get content properties for custom contentRetrieves Content Properties tied to a specified custom content. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the custom content. Authentication - Required Scopes: [read:custom-content:confluence]
- Parameter:
customContentId- The ID of the custom content for which content properties should be returned. (required)key- Filters the response to return a specific content property with matching key (case sensitive). (optional)sort- Used to sort the result by a particular field. (optional)cursor- Used for pagination, this opaque cursor will be returned in thenextURL in theLinkresponse header. Use the relative URL in theLinkheader to retrieve thenextset of results. (optional)limit- Maximum number of attachments per result to return. If more results exist, use theLinkheader to retrieve a relative URL that will return the next set of results. (optional, defaults to 25)serializeIdsAsStrings- Due to JavaScript's max integer representation of 2^53-1, the type of any IDs returned in the response body for this endpoint will be changed from a numeric type to a string type at the end of the deprecation period. In the meantime, this query param can be passed to this endpoint to opt-in to this change now. See this [changelog](https://developer.atlassian.com/cloud/confluence/changelog/#CHANGE-905) for more detail. (optional, defaults to false)
-
getCustomContentContentPropertiesById
ContentProperty getCustomContentContentPropertiesById(@NotNull @NotNull Long customContentId, @NotNull @NotNull Long propertyId, @Nullable @Nullable Boolean serializeIdsAsStrings) Get content property for custom content by idRetrieves a specific Content Property by ID that is attached to a specified custom content. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the page. Authentication - Required Scopes: [read:custom-content:confluence]
- Parameter:
customContentId- The ID of the custom content for which content properties should be returned. (required)propertyId- The ID of the content property being requested. (required)serializeIdsAsStrings- Due to JavaScript's max integer representation of 2^53-1, the type of any IDs returned in the response body for this endpoint will be changed from a numeric type to a string type at the end of the deprecation period. In the meantime, this query param can be passed to this endpoint to opt-in to this change now. See this [changelog](https://developer.atlassian.com/cloud/confluence/changelog/#CHANGE-905) for more detail. (optional, defaults to false)
-
getCustomContentLabels
MultiEntityResultLabel getCustomContentLabels(@NotNull @NotNull Long id, @Nullable @Nullable String prefix, @Nullable @Nullable List<LabelSortOrder> sort, @Nullable @Nullable String cursor, @Nullable @Nullable Integer limit, @Nullable @Nullable Boolean serializeIdsAsStrings) Get labels for custom contentReturns the labels for a specific piece of custom content. The number of results is limited by the
limitparameter and additional results (if available) will be available through thenextURL present in theLinkresponse header. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the custom content and its corresponding space. Authentication - Required Scopes: [read:custom-content:confluence]- Parameter:
id- The ID of the custom content for which labels should be returned. (required)prefix- Filter the results to labels based on their prefix. (optional)sort- Used to sort the result by a particular field. (optional)cursor- Used for pagination, this opaque cursor will be returned in thenextURL in theLinkresponse header. Use the relative URL in theLinkheader to retrieve thenextset of results. (optional)limit- Maximum number of labels per result to return. If more results exist, use theLinkheader to retrieve a relative URL that will return the next set of results. (optional, defaults to 25)serializeIdsAsStrings- Due to JavaScript's max integer representation of 2^53-1, the type of any IDs returned in the response body for this endpoint will be changed from a numeric type to a string type at the end of the deprecation period. In the meantime, this query param can be passed to this endpoint to opt-in to this change now. See this [changelog](https://developer.atlassian.com/cloud/confluence/changelog/#CHANGE-905) for more detail. (optional, defaults to false)
-
getCustomContentOperations
Get permitted operations for custom contentReturns the permitted operations on specific custom content. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the parent content of the custom content and its corresponding space. Authentication - Required Scopes: [read:custom-content:confluence]
- Parameter:
id- The ID of the custom content for which operations should be returned. (required)
-
getCustomContentVersionDetails
DetailedVersion getCustomContentVersionDetails(@NotNull @NotNull Long customContentId, @NotNull @NotNull Long versionNumber) Get version details for custom content versionRetrieves version details for the specified custom content and version number. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the page. Authentication - Required Scopes: [read:custom-content:confluence]
- Parameter:
customContentId- The ID of the custom content for which version details should be returned. (required)versionNumber- The version number of the custom content to be returned. (required)
-
getCustomContentVersions
MultiEntityResultVersion3 getCustomContentVersions(@NotNull @NotNull Long customContentId, @Nullable @Nullable CustomContentBodyRepresentation bodyFormat, @Nullable @Nullable String cursor, @Nullable @Nullable Integer limit, @Nullable @Nullable VersionSortOrder sort) Get custom content versionsReturns the versions of specific custom content. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the custom content and its corresponding page and space. Authentication - Required Scopes: [read:custom-content:confluence]
- Parameter:
customContentId- The ID of the custom content to be queried for its versions. If you don't know the custom content ID, use Get custom-content by type and filter the results. (required)bodyFormat- The content format types to be returned in thebodyfield of the response. If available, the representation will be available under a response field of the same name under thebodyfield. Note: If the custom content body type isstorage, thestorageandatlas_doc_formatbody formats are able to be returned. If the custom content body type israw, only therawbody format is able to be returned. (optional)cursor- Used for pagination, this opaque cursor will be returned in thenextURL in theLinkresponse header. Use the relative URL in theLinkheader to retrieve thenextset of results. (optional)limit- Maximum number of versions per result to return. If more results exist, use theLinkheader to retrieve a relative URL that will return the next set of results. (optional, defaults to 25)sort- Used to sort the result by a particular field. (optional)
-
getInlineCommentById
InlineCommentModel getInlineCommentById(@NotNull @NotNull Long commentId, @Nullable @Nullable PrimaryBodyRepresentationSingle bodyFormat, @Nullable @Nullable Integer version, @Nullable @Nullable Boolean serializeIdsAsStrings) Get inline comment by idRetrieves an inline comment by id **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content of the page or blogpost and its corresponding space. Authentication - Required Scopes: [read:comment:confluence]
- Parameter:
commentId- The ID of the comment to be retrieved. (required)bodyFormat- The content format type to be returned in thebodyfield of the response. If available, the representation will be available under a response field of the same name under thebodyfield. (optional)version- Allows you to retrieve a previously published version. Specify the previous version's number to retrieve its details. (optional)serializeIdsAsStrings- Due to JavaScript's max integer representation of 2^53-1, the type of any IDs returned in the response body for this endpoint will be changed from a numeric type to a string type at the end of the deprecation period. In the meantime, this query param can be passed to this endpoint to opt-in to this change now. See this [changelog](https://developer.atlassian.com/cloud/confluence/changelog/#CHANGE-905) for more detail. (optional, defaults to false)
-
getInlineCommentChildren
MultiEntityResultInlineCommentChildrenModel getInlineCommentChildren(@NotNull @NotNull Long id, @Nullable @Nullable Boolean serializeIdsAsStrings, @Nullable @Nullable PrimaryBodyRepresentation bodyFormat, @Nullable @Nullable CommentSortOrder sort, @Nullable @Nullable String cursor, @Nullable @Nullable Integer limit) Get children inline commentsReturns the children inline comments of specific comment. The number of results is limited by the
limitparameter and additional results (if available) will be available through thenextURL present in theLinkresponse header. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content of the page and its corresponding space. Authentication - Required Scopes: [read:comment:confluence]- Parameter:
id- The ID of the parent comment for which inline comment children should be returned. (required)serializeIdsAsStrings- Due to JavaScript's max integer representation of 2^53-1, the type of any IDs returned in the response body for this endpoint will be changed from a numeric type to a string type at the end of the deprecation period. In the meantime, this query param can be passed to this endpoint to opt-in to this change now. See this [changelog](https://developer.atlassian.com/cloud/confluence/changelog/#CHANGE-905) for more detail. (optional, defaults to false)bodyFormat- The content format type to be returned in thebodyfield of the response. If available, the representation will be available under a response field of the same name under thebodyfield. (optional)sort- Used to sort the result by a particular field. (optional)cursor- Used for pagination, this opaque cursor will be returned in thenextURL in theLinkresponse header. Use the relative URL in theLinkheader to retrieve thenextset of results. (optional)limit- Maximum number of footer comments per result to return. If more results exist, use theLinkheader to retrieve a relative URL that will return the next set of results. (optional, defaults to 25)
-
getInlineCommentOperations
Get permitted operations for inline commentReturns the permitted operations on specific inline comment. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the parent content of the inline comment and its corresponding space. Authentication - Required Scopes: [read:comment:confluence]
- Parameter:
id- The ID of the inline comment for which operations should be returned. (required)
-
getInlineCommentVersionDetails
DetailedVersion getInlineCommentVersionDetails(@NotNull @NotNull Long id, @NotNull @NotNull Long versionNumber) Get version details for inline comment versionRetrieves version details for the specified inline comment version. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content of the page or blog post and its corresponding space. Authentication - Required Scopes: [read:comment:confluence]
- Parameter:
id- The ID of the inline comment for which version details should be returned. (required)versionNumber- The version number of the inline comment to be returned. (required)
-
getInlineCommentVersions
MultiEntityResultVersion4 getInlineCommentVersions(@NotNull @NotNull Long id, @Nullable @Nullable PrimaryBodyRepresentation bodyFormat, @Nullable @Nullable String cursor, @Nullable @Nullable Integer limit, @Nullable @Nullable VersionSortOrder sort) Get inline comment versionsRetrieves the versions of the specified inline comment. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content of the page or blog post and its corresponding space. Authentication - Required Scopes: [read:comment:confluence]
- Parameter:
id- The ID of the inline comment for which versions should be returned (required)bodyFormat- The content format types to be returned in thebodyfield of the response. If available, the representation will be available under a response field of the same name under thebodyfield. (optional)cursor- Used for pagination, this opaque cursor will be returned in thenextURL in theLinkresponse header. Use the relative URL in theLinkheader to retrieve thenextset of results. (optional)limit- Maximum number of versions per result to return. If more results exist, use theLinkheader to retrieve a relative URL that will return the next set of results. (optional, defaults to 25)sort- Used to sort the result by a particular field. (optional)
-
getInlineComments
MultiEntityResultInlineCommentModel getInlineComments(@Nullable @Nullable Boolean serializeIdsAsStrings, @Nullable @Nullable PrimaryBodyRepresentation bodyFormat, @Nullable @Nullable CommentSortOrder sort, @Nullable @Nullable String cursor, @Nullable @Nullable Integer limit) Get inline commentsReturns all inline comments. The number of results is limited by the
limitparameter and additional results (if available) will be available through thenextURL present in theLinkresponse 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:
serializeIdsAsStrings- Due to JavaScript's max integer representation of 2^53-1, the type of any IDs returned in the response body for this endpoint will be changed from a numeric type to a string type at the end of the deprecation period. In the meantime, this query param can be passed to this endpoint to opt-in to this change now. See this [changelog](https://developer.atlassian.com/cloud/confluence/changelog/#CHANGE-905) for more detail. (optional, defaults to false)bodyFormat- The content format type to be returned in thebodyfield of the response. If available, the representation will be available under a response field of the same name under thebodyfield. (optional)sort- Used to sort the result by a particular field. (optional)cursor- Used for pagination, this opaque cursor will be returned in thenextURL in theLinkresponse header. Use the relative URL in theLinkheader to retrieve thenextset of results. (optional)limit- Maximum number of footer comments per result to return. If more results exist, use theLinkheader to retrieve a relative URL that will return the next set of results. (optional, defaults to 25)
-
getInlineLikeCount
Get like count for inline commentReturns the count of likes of specific inline comment. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content of the page/blogpost and its corresponding space. Authentication - Required Scopes: [read:comment:confluence]
- Parameter:
id- The ID of the inline comment for which like count should be returned. (required)
-
getInlineLikeUsers
MultiEntityResultString getInlineLikeUsers(@NotNull @NotNull Long id, @Nullable @Nullable String cursor, @Nullable @Nullable Integer limit) Get account IDs of likes for inline commentReturns the account IDs of likes of specific inline comment. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content of the page/blogpost and its corresponding space. Authentication - Required Scopes: [read:comment:confluence]
- Parameter:
id- The ID of the inline comment for which like count should be returned. (required)cursor- Used for pagination, this opaque cursor will be returned in thenextURL in theLinkresponse header. Use the relative URL in theLinkheader to retrieve thenextset of results. (optional)limit- Maximum number of account IDs per result to return. If more results exist, use theLinkheader to retrieve a relative URL that will return the next set of results. (optional, defaults to 25)
-
getLabelAttachments
MultiEntityResultAttachment1 getLabelAttachments(@NotNull @NotNull Long id, @Nullable @Nullable AttachmentSortOrder sort, @Nullable @Nullable String cursor, @Nullable @Nullable Integer limit, @Nullable @Nullable Boolean serializeIdsAsStrings) Get attachments for labelReturns the attachments of specified label. The number of results is limited by the
limitparameter and additional results (if available) will be available through thenextURL present in theLinkresponse header. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the attachment and its corresponding space. Authentication - Required Scopes: [read:attachment:confluence]- Parameter:
id- The ID of the label for which attachments should be returned. (required)sort- Used to sort the result by a particular field. (optional)cursor- Used for pagination, this opaque cursor will be returned in thenextURL in theLinkresponse header. Use the relative URL in theLinkheader to retrieve thenextset of results. (optional)limit- Maximum number of pages per result to return. If more results exist, use theLinkheader to retrieve a relative URL that will return the next set of results. (optional, defaults to 25)serializeIdsAsStrings- Due to JavaScript's max integer representation of 2^53-1, the type of any IDs returned in the response body for this endpoint will be changed from a numeric type to a string type at the end of the deprecation period. In the meantime, this query param can be passed to this endpoint to opt-in to this change now. See this [changelog](https://developer.atlassian.com/cloud/confluence/changelog/#CHANGE-905) for more detail. (optional, defaults to false)
-
getLabelBlogPosts
MultiEntityResultBlogPost getLabelBlogPosts(@NotNull @NotNull Long id, @Nullable @Nullable List<Long> spaceId, @Nullable @Nullable PrimaryBodyRepresentation bodyFormat, @Nullable @Nullable BlogPostSortOrder sort, @Nullable @Nullable String cursor, @Nullable @Nullable Integer limit, @Nullable @Nullable Boolean serializeIdsAsStrings) Get blog posts for labelReturns the blogposts of specified label. The number of results is limited by the
limitparameter and additional results (if available) will be available through thenextURL present in theLinkresponse header. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content of the page and its corresponding space. Authentication - Required Scopes: [read:page:confluence]- Parameter:
id- The ID of the label for which blog posts should be returned. (required)spaceId- Filter the results based on space ids. Multiple space ids can be specified as a comma-separated list. (optional)bodyFormat- The content format types to be returned in thebodyfield of the response. If available, the representation will be available under a response field of the same name under thebodyfield. (optional)sort- Used to sort the result by a particular field. (optional)cursor- Used for pagination, this opaque cursor will be returned in thenextURL in theLinkresponse header. Use the relative URL in theLinkheader to retrieve thenextset of results. (optional)limit- Maximum number of blog posts per result to return. If more results exist, use theLinkheader to retrieve a relative URL that will return the next set of results. (optional, defaults to 25)serializeIdsAsStrings- Due to JavaScript's max integer representation of 2^53-1, the type of any IDs returned in the response body for this endpoint will be changed from a numeric type to a string type at the end of the deprecation period. In the meantime, this query param can be passed to this endpoint to opt-in to this change now. See this [changelog](https://developer.atlassian.com/cloud/confluence/changelog/#CHANGE-905) for more detail. (optional, defaults to false)
-
getLabelPages
MultiEntityResultPage getLabelPages(@NotNull @NotNull Long id, @Nullable @Nullable List<Long> spaceId, @Nullable @Nullable PrimaryBodyRepresentation bodyFormat, @Nullable @Nullable PageSortOrder sort, @Nullable @Nullable String cursor, @Nullable @Nullable Integer limit, @Nullable @Nullable Boolean serializeIdsAsStrings) Get pages for labelReturns the pages of specified label. The number of results is limited by the
limitparameter and additional results (if available) will be available through thenextURL present in theLinkresponse header. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content of the page and its corresponding space. Authentication - Required Scopes: [read:page:confluence]- Parameter:
id- The ID of the label for which pages should be returned. (required)spaceId- Filter the results based on space ids. Multiple space ids can be specified as a comma-separated list. (optional)bodyFormat- The content format types to be returned in thebodyfield of the response. If available, the representation will be available under a response field of the same name under thebodyfield. (optional)sort- Used to sort the result by a particular field. (optional)cursor- Used for pagination, this opaque cursor will be returned in thenextURL in theLinkresponse header. Use the relative URL in theLinkheader to retrieve thenextset of results. (optional)limit- Maximum number of pages per result to return. If more results exist, use theLinkheader to retrieve a relative URL that will return the next set of results. (optional, defaults to 25)serializeIdsAsStrings- Due to JavaScript's max integer representation of 2^53-1, the type of any IDs returned in the response body for this endpoint will be changed from a numeric type to a string type at the end of the deprecation period. In the meantime, this query param can be passed to this endpoint to opt-in to this change now. See this [changelog](https://developer.atlassian.com/cloud/confluence/changelog/#CHANGE-905) for more detail. (optional, defaults to false)
-
getPageAncestors
MultiEntityResultAncestor getPageAncestors(@NotNull @NotNull Long id, @Nullable @Nullable Integer limit) Get all ancestors of pageReturns 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
limitparameter and additional results (if available) will be available by calling this endpoint with the ID of first ancestor in the response payload. This endpoint returns minimal information about each ancestor. To fetch more details, use a related endpoint, such as [Get page by id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-page/#api-pages-id-get). **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site ('Can use' global permission).- Parameter:
id- The ID of the page. (required)limit- Maximum number of pages per result to return. If more results exist, call this endpoint with the highest ancestor's ID to fetch the next set of results. (optional, defaults to 25)
-
getPageAttachments
MultiEntityResultAttachment getPageAttachments(@NotNull @NotNull Long id, @Nullable @Nullable AttachmentSortOrder sort, @Nullable @Nullable String cursor, @Nullable @Nullable List<String> status, @Nullable @Nullable String mediaType, @Nullable @Nullable String filename, @Nullable @Nullable Integer limit, @Nullable @Nullable Boolean serializeIdsAsStrings) Get attachments for pageReturns the attachments of specific page. The number of results is limited by the
limitparameter and additional results (if available) will be available through thenextURL present in theLinkresponse header. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content of the page and its corresponding space. Authentication - Required Scopes: [read:attachment:confluence]- Parameter:
id- The ID of the page for which attachments should be returned. (required)sort- Used to sort the result by a particular field. (optional)cursor- Used for pagination, this opaque cursor will be returned in thenextURL in theLinkresponse header. Use the relative URL in theLinkheader to retrieve thenextset of results. (optional)status- Filter the results to attachments based on their status. By default,currentandarchivedare used. (optional)mediaType- Filters on the mediaType of attachments. Only one may be specified. (optional)filename- Filters on the file-name of attachments. Only one may be specified. (optional)limit- Maximum number of attachments per result to return. If more results exist, use theLinkheader to retrieve a relative URL that will return the next set of results. (optional, defaults to 50)serializeIdsAsStrings- Due to JavaScript's max integer representation of 2^53-1, the type of any IDs returned in the response body for this endpoint will be changed from a numeric type to a string type at the end of the deprecation period. In the meantime, this query param can be passed to this endpoint to opt-in to this change now. See this [changelog](https://developer.atlassian.com/cloud/confluence/changelog/#CHANGE-905) for more detail. (optional, defaults to false)
-
getPageById
PageSingle getPageById(@NotNull @NotNull Long id, @Nullable @Nullable PrimaryBodyRepresentationSingle bodyFormat, @Nullable @Nullable Boolean getDraft, @Nullable @Nullable Integer version, @Nullable @Nullable Boolean serializeIdsAsStrings) Get page by idReturns a specific page. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the page and its corresponding space. Authentication - Required Scopes: [read:page:confluence]
- Parameter:
id- The ID of the page to be returned. If you don't know the page ID, use Get pages and filter the results. (required)bodyFormat- The content format types to be returned in thebodyfield of the response. If available, the representation will be available under a response field of the same name under thebodyfield. (optional)getDraft- Retrieve the draft version of this page. (optional, defaults to false)version- Allows you to retrieve a previously published version. Specify the previous version's number to retrieve its details. (optional)serializeIdsAsStrings- Due to JavaScript's max integer representation of 2^53-1, the type of any IDs returned in the response body for this endpoint will be changed from a numeric type to a string type at the end of the deprecation period. In the meantime, this query param can be passed to this endpoint to opt-in to this change now. See this [changelog](https://developer.atlassian.com/cloud/confluence/changelog/#CHANGE-905) for more detail. (optional, defaults to false)
-
getPageContentProperties
MultiEntityResultContentProperty getPageContentProperties(@NotNull @NotNull Long pageId, @Nullable @Nullable String key, @Nullable @Nullable ContentPropertySortOrder sort, @Nullable @Nullable String cursor, @Nullable @Nullable Integer limit, @Nullable @Nullable Boolean serializeIdsAsStrings) Get content properties for pageRetrieves Content Properties tied to a specified page. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the page. Authentication - Required Scopes: [read:page:confluence]
- Parameter:
pageId- The ID of the page for which content properties should be returned. (required)key- Filters the response to return a specific content property with matching key (case sensitive). (optional)sort- Used to sort the result by a particular field. (optional)cursor- Used for pagination, this opaque cursor will be returned in thenextURL in theLinkresponse header. Use the relative URL in theLinkheader to retrieve thenextset of results. (optional)limit- Maximum number of attachments per result to return. If more results exist, use theLinkheader to retrieve a relative URL that will return the next set of results. (optional, defaults to 25)serializeIdsAsStrings- Due to JavaScript's max integer representation of 2^53-1, the type of any IDs returned in the response body for this endpoint will be changed from a numeric type to a string type at the end of the deprecation period. In the meantime, this query param can be passed to this endpoint to opt-in to this change now. See this [changelog](https://developer.atlassian.com/cloud/confluence/changelog/#CHANGE-905) for more detail. (optional, defaults to false)
-
getPageContentPropertiesById
ContentProperty getPageContentPropertiesById(@NotNull @NotNull Long pageId, @NotNull @NotNull Long propertyId, @Nullable @Nullable Boolean serializeIdsAsStrings) Get content property for page by idRetrieves a specific Content Property by ID that is attached to a specified page. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the page. Authentication - Required Scopes: [read:page:confluence]
- Parameter:
pageId- The ID of the page for which content properties should be returned. (required)propertyId- The ID of the content property being requested. (required)serializeIdsAsStrings- Due to JavaScript's max integer representation of 2^53-1, the type of any IDs returned in the response body for this endpoint will be changed from a numeric type to a string type at the end of the deprecation period. In the meantime, this query param can be passed to this endpoint to opt-in to this change now. See this [changelog](https://developer.atlassian.com/cloud/confluence/changelog/#CHANGE-905) for more detail. (optional, defaults to false)
-
getPageInlineComments
MultiEntityResultPageInlineCommentModel getPageInlineComments(@NotNull @NotNull Long id, @Nullable @Nullable PrimaryBodyRepresentation bodyFormat, @Nullable @Nullable CommentSortOrder sort, @Nullable @Nullable String cursor, @Nullable @Nullable Integer limit, @Nullable @Nullable Boolean serializeIdsAsStrings) Get inline comments for pageReturns the root inline comments of specific page. The number of results is limited by the
limitparameter and additional results (if available) will be available through thenextURL present in theLinkresponse header. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content of the page and its corresponding space. Authentication - Required Scopes: [read:comment:confluence]- Parameter:
id- The ID of the page for which inline comments should be returned. (required)bodyFormat- The content format type to be returned in thebodyfield of the response. If available, the representation will be available under a response field of the same name under thebodyfield. (optional)sort- Used to sort the result by a particular field. (optional)cursor- Used for pagination, this opaque cursor will be returned in thenextURL in theLinkresponse header. Use the relative URL in theLinkheader to retrieve thenextset of results. (optional)limit- Maximum number of inline comments per result to return. If more results exist, use theLinkheader to retrieve a relative URL that will return the next set of results. (optional, defaults to 25)serializeIdsAsStrings- Due to JavaScript's max integer representation of 2^53-1, the type of any IDs returned in the response body for this endpoint will be changed from a numeric type to a string type at the end of the deprecation period. In the meantime, this query param can be passed to this endpoint to opt-in to this change now. See this [changelog](https://developer.atlassian.com/cloud/confluence/changelog/#CHANGE-905) for more detail. (optional, defaults to false)
-
getPageLabels
MultiEntityResultLabel getPageLabels(@NotNull @NotNull Long id, @Nullable @Nullable String prefix, @Nullable @Nullable List<LabelSortOrder> sort, @Nullable @Nullable String cursor, @Nullable @Nullable Integer limit, @Nullable @Nullable Boolean serializeIdsAsStrings) Get labels for pageReturns the labels of specific page. The number of results is limited by the
limitparameter and additional results (if available) will be available through thenextURL present in theLinkresponse header. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content of the page and its corresponding space. Authentication - Required Scopes: [read:page:confluence]- Parameter:
id- The ID of the page for which labels should be returned. (required)prefix- Filter the results to labels based on their prefix. (optional)sort- Used to sort the result by a particular field. (optional)cursor- Used for pagination, this opaque cursor will be returned in thenextURL in theLinkresponse header. Use the relative URL in theLinkheader to retrieve thenextset of results. (optional)limit- Maximum number of labels per result to return. If more results exist, use theLinkheader to retrieve a relative URL that will return the next set of results. (optional, defaults to 25)serializeIdsAsStrings- Due to JavaScript's max integer representation of 2^53-1, the type of any IDs returned in the response body for this endpoint will be changed from a numeric type to a string type at the end of the deprecation period. In the meantime, this query param can be passed to this endpoint to opt-in to this change now. See this [changelog](https://developer.atlassian.com/cloud/confluence/changelog/#CHANGE-905) for more detail. (optional, defaults to false)
-
getPageLikeCount
Get like count for pageReturns the count of likes of specific page. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content of the page and its corresponding space. Authentication - Required Scopes: [read:page:confluence]
- Parameter:
id- The ID of the page for which like count should be returned. (required)
-
getPageLikeUsers
MultiEntityResultString getPageLikeUsers(@NotNull @NotNull Long id, @Nullable @Nullable String cursor, @Nullable @Nullable Integer limit) Get account IDs of likes for pageReturns the account IDs of likes of specific page. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content of the page and its corresponding space. Authentication - Required Scopes: [read:page:confluence]
- Parameter:
id- The ID of the page for which like count should be returned. (required)cursor- Used for pagination, this opaque cursor will be returned in thenextURL in theLinkresponse header. Use the relative URL in theLinkheader to retrieve thenextset of results. (optional)limit- Maximum number of account IDs per result to return. If more results exist, use theLinkheader to retrieve a relative URL that will return the next set of results. (optional, defaults to 25)
-
getPageOperations
Get permitted operations for pageReturns the permitted operations on specific page. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the parent content of the page and its corresponding space. Authentication - Required Scopes: [read:page:confluence]
- Parameter:
id- The ID of the page for which operations should be returned. (required)
-
getPageVersionDetails
DetailedVersion getPageVersionDetails(@NotNull @NotNull Long pageId, @NotNull @NotNull Long versionNumber) Get version details for page versionRetrieves version details for the specified page and version number. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the page. Authentication - Required Scopes: [read:page:confluence]
- Parameter:
pageId- The ID of the page for which version details should be returned. (required)versionNumber- The version number of the page to be returned. (required)
-
getPageVersions
MultiEntityResultVersion2 getPageVersions(@NotNull @NotNull Long id, @Nullable @Nullable PrimaryBodyRepresentation bodyFormat, @Nullable @Nullable String cursor, @Nullable @Nullable Integer limit, @Nullable @Nullable VersionSortOrder sort) Get page versionsReturns the versions of specific page. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the page and its corresponding space. Authentication - Required Scopes: [read:page:confluence]
- Parameter:
id- The ID of the page to be queried for its versions. If you don't know the page ID, use Get pages and filter the results. (required)bodyFormat- The content format types to be returned in thebodyfield of the response. If available, the representation will be available under a response field of the same name under thebodyfield. (optional)cursor- Used for pagination, this opaque cursor will be returned in thenextURL in theLinkresponse header. Use the relative URL in theLinkheader to retrieve thenextset of results. (optional)limit- Maximum number of versions per result to return. If more results exist, use theLinkheader to retrieve a relative URL that will return the next set of results. (optional, defaults to 25)sort- Used to sort the result by a particular field. (optional)
-
getPages
MultiEntityResultPage getPages(@Nullable @Nullable List<Long> id, @Nullable @Nullable List<Long> spaceId, @Nullable @Nullable PageSortOrder sort, @Nullable @Nullable List<String> status, @Nullable @Nullable String title, @Nullable @Nullable PrimaryBodyRepresentation bodyFormat, @Nullable @Nullable String cursor, @Nullable @Nullable Integer limit, @Nullable @Nullable Boolean serializeIdsAsStrings) Get pagesReturns all pages. The number of results is limited by the
limitparameter and additional results (if available) will be available through thenextURL present in theLinkresponse header. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site ('Can use' global permission). Only pages that the user has permission to view will be returned. Authentication - Required Scopes: [read:page:confluence]- Parameter:
id- Filter the results based on page ids. Multiple page ids can be specified as a comma-separated list. (optional)spaceId- Filter the results based on space ids. Multiple space ids can be specified as a comma-separated list. (optional)sort- Used to sort the result by a particular field. (optional)status- Filter the results to pages based on their status. By default,currentandarchivedare used. (optional)title- Filter the results to pages based on their title. (optional)bodyFormat- The content format types to be returned in thebodyfield of the response. If available, the representation will be available under a response field of the same name under thebodyfield. (optional)cursor- Used for pagination, this opaque cursor will be returned in thenextURL in theLinkresponse header. Use the relative URL in theLinkheader to retrieve thenextset of results. (optional)limit- Maximum number of pages per result to return. If more results exist, use theLinkheader to retrieve a relative URL that will return the next set of results. (optional, defaults to 25)serializeIdsAsStrings- Due to JavaScript's max integer representation of 2^53-1, the type of any IDs returned in the response body for this endpoint will be changed from a numeric type to a string type at the end of the deprecation period. In the meantime, this query param can be passed to this endpoint to opt-in to this change now. See this [changelog](https://developer.atlassian.com/cloud/confluence/changelog/#CHANGE-905) for more detail. (optional, defaults to false)
-
getPagesInSpace
MultiEntityResultPage getPagesInSpace(@NotNull @NotNull Long id, @Nullable @Nullable String depth, @Nullable @Nullable PageSortOrder sort, @Nullable @Nullable List<String> status, @Nullable @Nullable String title, @Nullable @Nullable PrimaryBodyRepresentation bodyFormat, @Nullable @Nullable String cursor, @Nullable @Nullable Integer limit, @Nullable @Nullable Boolean serializeIdsAsStrings) Get pages in spaceReturns all pages in a space. The number of results is limited by the
limitparameter and additional results (if available) will be available through thenextURL present in theLinkresponse header. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site ('Can use' global permission) and 'View' permission for the space. Only pages that the user has permission to view will be returned. Authentication - Required Scopes: [read:page:confluence]- Parameter:
id- The ID of the space for which pages should be returned. (required)depth- Filter the results to pages at the root level of the space or to all pages in the space. (optional, defaults to all)sort- Used to sort the result by a particular field. (optional)status- Filter the results to pages based on their status. By default,currentandarchivedare used. (optional)title- Filter the results to pages based on their title. (optional)bodyFormat- The content format types to be returned in thebodyfield of the response. If available, the representation will be available under a response field of the same name under thebodyfield. (optional)cursor- Used for pagination, this opaque cursor will be returned in thenextURL in theLinkresponse header. Use the relative URL in theLinkheader to retrieve thenextset of results. (optional)limit- Maximum number of pages per result to return. If more results exist, use theLinkheader to retrieve a relative URL that will return the next set of results. (optional, defaults to 25)serializeIdsAsStrings- Due to JavaScript's max integer representation of 2^53-1, the type of any IDs returned in the response body for this endpoint will be changed from a numeric type to a string type at the end of the deprecation period. In the meantime, this query param can be passed to this endpoint to opt-in to this change now. See this [changelog](https://developer.atlassian.com/cloud/confluence/changelog/#CHANGE-905) for more detail. (optional, defaults to false)
-
getSpaceById
Space getSpaceById(@NotNull @NotNull Long id, @Nullable @Nullable SpaceDescriptionBodyRepresentation descriptionFormat, @Nullable @Nullable Boolean includeIcon, @Nullable @Nullable Boolean serializeIdsAsStrings) Get space by idReturns a specific space. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the space. Authentication - Required Scopes: [read:space:confluence]
- Parameter:
id- The ID of the space to be returned. (required)descriptionFormat- The content format type to be returned in thedescriptionfield of the response. If available, the representation will be available under a response field of the same name under thedescriptionfield. (optional)includeIcon- If the icon for the space should be fetched or not. (optional, defaults to false)serializeIdsAsStrings- Due to JavaScript's max integer representation of 2^53-1, the type of any IDs returned in the response body for this endpoint will be changed from a numeric type to a string type at the end of the deprecation period. In the meantime, this query param can be passed to this endpoint to opt-in to this change now. See this [changelog](https://developer.atlassian.com/cloud/confluence/changelog/#CHANGE-905) for more detail. (optional, defaults to false)
-
getSpaceOperations
Get permitted operations for spaceReturns the permitted operations on specific space. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the corresponding space. Authentication - Required Scopes: [read:space:confluence]
- Parameter:
id- The ID of the space for which operations should be returned. (required)
-
getSpacePermissions
MultiEntityResultSpacePermission getSpacePermissions(@NotNull @NotNull Long id, @Nullable @Nullable String cursor, @Nullable @Nullable Integer limit) Get space permissionsReturns space permissions for a specific space. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the space.
- Parameter:
id- The ID of the space to be returned. (required)cursor- Used for pagination, this opaque cursor will be returned in thenextURL in theLinkresponse header. Use the relative URL in theLinkheader to retrieve thenextset of results. (optional)limit- Maximum number of spaces per result to return. If more results exist, use theLinkresponse header to retrieve a relative URL that will return the next set of results. (optional, defaults to 25)
-
getSpaceProperties
MultiEntityResultSpaceProperty getSpaceProperties(@NotNull @NotNull Long spaceId, @Nullable @Nullable String key, @Nullable @Nullable String cursor, @Nullable @Nullable Integer limit, @Nullable @Nullable Boolean serializeIdsAsStrings) Get space properties in spaceReturns 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
linkresponse header to paginate through additional results. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site ('Can use' global permission) and 'View' permission for the space. Authentication - Required Scopes: [read:space:confluence]- Parameter:
spaceId- The ID of the space for which space properties should be returned. (required)key- The key of the space property to retrieve. This should be used when a user knows the key of their property, but needs to retrieve the id for use in other methods. (optional)cursor- Used for pagination, this opaque cursor will be returned in thenextURL in theLinkresponse header. Use the relative URL in theLinkheader to retrieve thenextset of results. (optional)limit- Maximum number of pages per result to return. If more results exist, use theLinkheader to retrieve a relative URL that will return the next set of results. (optional, defaults to 25)serializeIdsAsStrings- Due to JavaScript's max integer representation of 2^53-1, the type of any IDs returned in the response body for this endpoint will be changed from a numeric type to a string type at the end of the deprecation period. In the meantime, this query param can be passed to this endpoint to opt-in to this change now. See this [changelog](https://developer.atlassian.com/cloud/confluence/changelog/#CHANGE-905) for more detail. (optional, defaults to false)
-
getSpacePropertyById
SpaceProperty getSpacePropertyById(@NotNull @NotNull Long spaceId, @NotNull @NotNull Long propertyId, @Nullable @Nullable Boolean serializeIdsAsStrings) Get space property by idRetrieve a space property by its id. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site ('Can use' global permission) and 'View' permission for the space. Authentication - Required Scopes: [read:space:confluence]
- Parameter:
spaceId- The ID of the space the property belongs to. (required)propertyId- The ID of the property to be retrieved. (required)serializeIdsAsStrings- Due to JavaScript's max integer representation of 2^53-1, the type of any IDs returned in the response body for this endpoint will be changed from a numeric type to a string type at the end of the deprecation period. In the meantime, this query param can be passed to this endpoint to opt-in to this change now. See this [changelog](https://developer.atlassian.com/cloud/confluence/changelog/#CHANGE-905) for more detail. (optional, defaults to false)
-
getSpaces
MultiEntityResultSpace getSpaces(@Nullable @Nullable List<Long> ids, @Nullable @Nullable List<String> keys, @Nullable @Nullable String type, @Nullable @Nullable String status, @Nullable @Nullable List<String> labels, @Nullable @Nullable SpaceSortOrder sort, @Nullable @Nullable SpaceDescriptionBodyRepresentation descriptionFormat, @Nullable @Nullable Boolean includeIcon, @Nullable @Nullable String cursor, @Nullable @Nullable Integer limit, @Nullable @Nullable Boolean serializeIdsAsStrings) Get spacesReturns all spaces. The results will be sorted by id ascending. The number of results is limited by the
limitparameter and additional results (if available) will be available through thenextURL present in theLinkresponse header. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site ('Can use' global permission). Only spaces that the user has permission to view will be returned. Authentication - Required Scopes: [read:space:confluence]- Parameter:
ids- Filter the results to spaces based on their IDs. Multiple IDs can be specified as a comma-separated list. (optional)keys- Filter the results to spaces based on their keys. Multiple keys can be specified as a comma-separated list. (optional)type- Filter the results to spaces based on their type. (optional)status- Filter the results to spaces based on their status. (optional)labels- Filter the results to spaces based on their labels. Multiple labels can be specified as a comma-separated list. (optional)sort- Used to sort the result by a particular field. (optional)descriptionFormat- The content format type to be returned in thedescriptionfield of the response. If available, the representation will be available under a response field of the same name under thedescriptionfield. (optional)includeIcon- If the icon for the space should be fetched or not. (optional, defaults to false)cursor- Used for pagination, this opaque cursor will be returned in thenextURL in theLinkresponse header. Use the relative URL in theLinkheader to retrieve thenextset of results. (optional)limit- Maximum number of spaces per result to return. If more results exist, use theLinkresponse header to retrieve a relative URL that will return the next set of results. (optional, defaults to 25)serializeIdsAsStrings- Due to JavaScript's max integer representation of 2^53-1, the type of any IDs returned in the response body for this endpoint will be changed from a numeric type to a string type at the end of the deprecation period. In the meantime, this query param can be passed to this endpoint to opt-in to this change now. See this [changelog](https://developer.atlassian.com/cloud/confluence/changelog/#CHANGE-905) for more detail. (optional, defaults to false)
-
getTaskById
Task getTaskById(@NotNull @NotNull Long id, @Nullable @Nullable PrimaryBodyRepresentation bodyFormat, @Nullable @Nullable Boolean serializeIdsAsStrings) Get task by idReturns a specific task. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the containing page or blog post and its corresponding space. Authentication - Required Scopes: [read:task:confluence]
- Parameter:
id- The ID of the task to be returned. If you don't know the task ID, use Get tasks and filter the results. (required)bodyFormat- The content format types to be returned in thebodyfield of the response. If available, the representation will be available under a response field of the same name under thebodyfield. (optional)serializeIdsAsStrings- Due to JavaScript's max integer representation of 2^53-1, the type of any IDs returned in the response body for this endpoint will be changed from a numeric type to a string type at the end of the deprecation period. In the meantime, this query param can be passed to this endpoint to opt-in to this change now. See this [changelog](https://developer.atlassian.com/cloud/confluence/changelog/#CHANGE-905) for more detail. (optional, defaults to false)
-
getTasks
MultiEntityResultTask getTasks(@Nullable @Nullable PrimaryBodyRepresentation bodyFormat, @Nullable @Nullable Boolean includeBlankTasks, @Nullable @Nullable String status, @Nullable @Nullable List<Long> taskId, @Nullable @Nullable List<Long> spaceId, @Nullable @Nullable List<Long> pageId, @Nullable @Nullable List<Long> blogpostId, @Nullable @Nullable List<String> createdBy, @Nullable @Nullable List<String> assignedTo, @Nullable @Nullable List<String> completedBy, @Nullable @Nullable Long createdAtFrom, @Nullable @Nullable Long createdAtTo, @Nullable @Nullable Long dueAtFrom, @Nullable @Nullable Long dueAtTo, @Nullable @Nullable Long completedAtFrom, @Nullable @Nullable Long completedAtTo, @Nullable @Nullable String cursor, @Nullable @Nullable Integer limit, @Nullable @Nullable Boolean serializeIdsAsStrings) Get tasksReturns all tasks. The number of results is limited by the
limitparameter and additional results (if available) will be available through thenextURL present in theLinkresponse header. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site ('Can use' global permission). Only tasks that the user has permission to view will be returned. Authentication - Required Scopes: [read:task:confluence]- Parameter:
bodyFormat- The content format types to be returned in thebodyfield of the response. If available, the representation will be available under a response field of the same name under thebodyfield. (optional)includeBlankTasks- Specifies whether to include blank tasks in the response. Defaults totrue. (optional)status- Filters on the status of the task. (optional)taskId- Filters on task ID. Multiple IDs can be specified. (optional)spaceId- Filters on the space ID of the task. Multiple IDs can be specified. (optional)pageId- Filters on the page ID of the task. Multiple IDs can be specified. Note - page and blog post filters can be used in conjunction. (optional)blogpostId- Filters on the blog post ID of the task. Multiple IDs can be specified. Note - page and blog post filters can be used in conjunction. (optional)createdBy- Filters on the Account ID of the user who created this task. Multiple IDs can be specified. (optional)assignedTo- Filters on the Account ID of the user to whom this task is assigned. Multiple IDs can be specified. (optional)completedBy- Filters on the Account ID of the user who completed this task. Multiple IDs can be specified. (optional)createdAtFrom- Filters on start of date-time range of task based on creation date (inclusive). Input is epoch time in milliseconds. (optional)createdAtTo- Filters on end of date-time range of task based on creation date (inclusive). Input is epoch time in milliseconds. (optional)dueAtFrom- Filters on start of date-time range of task based on due date (inclusive). Input is epoch time in milliseconds. (optional)dueAtTo- Filters on end of date-time range of task based on due date (inclusive). Input is epoch time in milliseconds. (optional)completedAtFrom- Filters on start of date-time range of task based on completion date (inclusive). Input is epoch time in milliseconds. (optional)completedAtTo- Filters on end of date-time range of task based on completion date (inclusive). Input is epoch time in milliseconds. (optional)cursor- Used for pagination, this opaque cursor will be returned in thenextURL in theLinkresponse header. Use the relative URL in theLinkheader to retrieve thenextset of results. (optional)limit- Maximum number of tasks per result to return. If more results exist, use theLinkheader to retrieve a relative URL that will return the next set of results. (optional, defaults to 25)serializeIdsAsStrings- Due to JavaScript's max integer representation of 2^53-1, the type of any IDs returned in the response body for this endpoint will be changed from a numeric type to a string type at the end of the deprecation period. In the meantime, this query param can be passed to this endpoint to opt-in to this change now. See this [changelog](https://developer.atlassian.com/cloud/confluence/changelog/#CHANGE-905) for more detail. (optional, defaults to false)
-
inviteByEmail
Invite a list of emails to the siteInvite a list of emails to the site. Ignores all invalid emails and no action is taken for the emails that already have access to the site. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site ('Can use' global permission).
- Parameter:
checkAccessByEmailRequest- (required)
-
updateAttachmentPropertyById
ContentProperty updateAttachmentPropertyById(@NotNull @NotNull String attachmentId, @NotNull @NotNull Long propertyId, @NotNull @NotNull ContentPropertyUpdateRequest contentPropertyUpdateRequest, @Nullable @Nullable Boolean serializeIdsAsStrings) Update content property for attachment by idUpdate a content property for attachment by its id. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to edit the attachment. Authentication - Required Scopes: [read:attachment:confluence]
- Parameter:
attachmentId- The ID of the attachment the property belongs to. (required)propertyId- The ID of the property to be updated. (required)contentPropertyUpdateRequest- The content property to be updated. (required)serializeIdsAsStrings- Due to JavaScript's max integer representation of 2^53-1, the type of any IDs returned in the response body for this endpoint will be changed from a numeric type to a string type at the end of the deprecation period. In the meantime, this query param can be passed to this endpoint to opt-in to this change now. See this [changelog](https://developer.atlassian.com/cloud/confluence/changelog/#CHANGE-905) for more detail. (optional, defaults to false)
-
updateBlogPost
BlogPostSingle updateBlogPost(@NotNull @NotNull Long id, @NotNull @NotNull UpdateBlogPostRequest updateBlogPostRequest, @Nullable @Nullable Boolean serializeIdsAsStrings) Update blog postUpdate a blog post by id. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the blog post and its corresponding space. Permission to update blog posts in the space. Authentication - Required Scopes: [write:page:confluence]
- Parameter:
id- The ID of the blog post to be updated. If you don't know the blog post ID, use Get Blog Posts and filter the results. (required)updateBlogPostRequest- (required)serializeIdsAsStrings- Due to JavaScript's max integer representation of 2^53-1, the type of any IDs returned in the response body for this endpoint will be changed from a numeric type to a string type at the end of the deprecation period. In the meantime, this query param can be passed to this endpoint to opt-in to this change now. See this [changelog](https://developer.atlassian.com/cloud/confluence/changelog/#CHANGE-905) for more detail. (optional, defaults to false)
-
updateBlogpostPropertyById
ContentProperty updateBlogpostPropertyById(@NotNull @NotNull Long blogpostId, @NotNull @NotNull Long propertyId, @NotNull @NotNull ContentPropertyUpdateRequest contentPropertyUpdateRequest, @Nullable @Nullable Boolean serializeIdsAsStrings) Update content property for blog post by idUpdate a content property for blog post by its id. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to edit the blog post. Authentication - Required Scopes: [read:page:confluence, write:page:confluence]
- Parameter:
blogpostId- The ID of the blog post the property belongs to. (required)propertyId- The ID of the property to be updated. (required)contentPropertyUpdateRequest- The content property to be updated. (required)serializeIdsAsStrings- Due to JavaScript's max integer representation of 2^53-1, the type of any IDs returned in the response body for this endpoint will be changed from a numeric type to a string type at the end of the deprecation period. In the meantime, this query param can be passed to this endpoint to opt-in to this change now. See this [changelog](https://developer.atlassian.com/cloud/confluence/changelog/#CHANGE-905) for more detail. (optional, defaults to false)
-
updateCommentPropertyById
ContentProperty updateCommentPropertyById(@NotNull @NotNull Long commentId, @NotNull @NotNull Long propertyId, @NotNull @NotNull ContentPropertyUpdateRequest contentPropertyUpdateRequest, @Nullable @Nullable Boolean serializeIdsAsStrings) Update content property for comment by idUpdate a content property for a comment by its id. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to edit the comment. Authentication - Required Scopes: [read:comment:confluence, write:comment:confluence]
- Parameter:
commentId- The ID of the comment the property belongs to. (required)propertyId- The ID of the property to be updated. (required)contentPropertyUpdateRequest- The content property to be updated. (required)serializeIdsAsStrings- Due to JavaScript's max integer representation of 2^53-1, the type of any IDs returned in the response body for this endpoint will be changed from a numeric type to a string type at the end of the deprecation period. In the meantime, this query param can be passed to this endpoint to opt-in to this change now. See this [changelog](https://developer.atlassian.com/cloud/confluence/changelog/#CHANGE-905) for more detail. (optional, defaults to false)
-
updateCustomContent
CustomContentSingle updateCustomContent(@NotNull @NotNull Long id, @NotNull @NotNull UpdateCustomContentRequest updateCustomContentRequest, @Nullable @Nullable Boolean serializeIdsAsStrings) Update custom contentUpdate a custom content by id.
spaceIdis always required and maximum one ofpageId,blogPostId, orcustomContentIdis allowed in the request body. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content of the page or blogpost and its corresponding space. Permission to update custom content in the space. Authentication - Required Scopes: [write:custom-content:confluence]- Parameter:
id- The ID of the custom content to be updated. If you don't know the custom content ID, use Get Custom Content by Type and filter the results. (required)updateCustomContentRequest- (required)serializeIdsAsStrings- Due to JavaScript's max integer representation of 2^53-1, the type of any IDs returned in the response body for this endpoint will be changed from a numeric type to a string type at the end of the deprecation period. In the meantime, this query param can be passed to this endpoint to opt-in to this change now. See this [changelog](https://developer.atlassian.com/cloud/confluence/changelog/#CHANGE-905) for more detail. (optional, defaults to false)
-
updateCustomContentPropertyById
ContentProperty updateCustomContentPropertyById(@NotNull @NotNull Long customContentId, @NotNull @NotNull Long propertyId, @NotNull @NotNull ContentPropertyUpdateRequest contentPropertyUpdateRequest, @Nullable @Nullable Boolean serializeIdsAsStrings) Update content property for custom content by idUpdate a content property for a piece of custom content by its id. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to edit the custom content. Authentication - Required Scopes: [read:custom-content:confluence, write:custom-content:confluence]
- Parameter:
customContentId- The ID of the custom content the property belongs to. (required)propertyId- The ID of the property to be updated. (required)contentPropertyUpdateRequest- The content property to be updated. (required)serializeIdsAsStrings- Due to JavaScript's max integer representation of 2^53-1, the type of any IDs returned in the response body for this endpoint will be changed from a numeric type to a string type at the end of the deprecation period. In the meantime, this query param can be passed to this endpoint to opt-in to this change now. See this [changelog](https://developer.atlassian.com/cloud/confluence/changelog/#CHANGE-905) for more detail. (optional, defaults to false)
-
updateInlineComment
InlineCommentModel updateInlineComment(@NotNull @NotNull Long commentId, @NotNull @NotNull UpdateInlineCommentModel updateInlineCommentModel, @Nullable @Nullable Boolean serializeIdsAsStrings) Update inline commentUpdate an inline comment. This can be used to update the body text of a comment and/or to resolve the comment **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content of the page or blogpost and its corresponding space. Permission to create comments in the space. Authentication - Required Scopes: [write:comment:confluence]
- Parameter:
commentId- The ID of the comment to be retrieved. (required)updateInlineCommentModel- The inline comment to be updated (required)serializeIdsAsStrings- Due to JavaScript's max integer representation of 2^53-1, the type of any IDs returned in the response body for this endpoint will be changed from a numeric type to a string type at the end of the deprecation period. In the meantime, this query param can be passed to this endpoint to opt-in to this change now. See this [changelog](https://developer.atlassian.com/cloud/confluence/changelog/#CHANGE-905) for more detail. (optional, defaults to false)
-
updatePage
PageSingle updatePage(@NotNull @NotNull Long id, @NotNull @NotNull UpdatePageRequest updatePageRequest, @Nullable @Nullable Boolean serializeIdsAsStrings) Update pageUpdate a page by id. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the page and its corresponding space. Permission to update pages in the space. Authentication - Required Scopes: [write:page:confluence]
- Parameter:
id- The ID of the page to be updated. If you don't know the page ID, use Get Pages and filter the results. (required)updatePageRequest- (required)serializeIdsAsStrings- Due to JavaScript's max integer representation of 2^53-1, the type of any IDs returned in the response body for this endpoint will be changed from a numeric type to a string type at the end of the deprecation period. In the meantime, this query param can be passed to this endpoint to opt-in to this change now. See this [changelog](https://developer.atlassian.com/cloud/confluence/changelog/#CHANGE-905) for more detail. (optional, defaults to false)
-
updatePagePropertyById
ContentProperty updatePagePropertyById(@NotNull @NotNull Long pageId, @NotNull @NotNull Long propertyId, @NotNull @NotNull ContentPropertyUpdateRequest contentPropertyUpdateRequest, @Nullable @Nullable Boolean serializeIdsAsStrings) Update content property for page by idUpdate a content property for a page by its id. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to edit the page. Authentication - Required Scopes: [read:page:confluence, write:page:confluence]
- Parameter:
pageId- The ID of the page the property belongs to. (required)propertyId- The ID of the property to be updated. (required)contentPropertyUpdateRequest- The content property to be updated. (required)serializeIdsAsStrings- Due to JavaScript's max integer representation of 2^53-1, the type of any IDs returned in the response body for this endpoint will be changed from a numeric type to a string type at the end of the deprecation period. In the meantime, this query param can be passed to this endpoint to opt-in to this change now. See this [changelog](https://developer.atlassian.com/cloud/confluence/changelog/#CHANGE-905) for more detail. (optional, defaults to false)
-
updateSpacePropertyById
SpaceProperty updateSpacePropertyById(@NotNull @NotNull Long spaceId, @NotNull @NotNull Long propertyId, @NotNull @NotNull SpacePropertyUpdateRequest spacePropertyUpdateRequest, @Nullable @Nullable Boolean serializeIdsAsStrings) Update space property by idUpdate a space property by its id. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site ('Can use' global permission) and 'Admin' permission for the space. Authentication - Required Scopes: [read:space:confluence, write:space:confluence]
- Parameter:
spaceId- The ID of the space the property belongs to. (required)propertyId- The ID of the property to be updated. (required)spacePropertyUpdateRequest- The space property to be updated. (required)serializeIdsAsStrings- Due to JavaScript's max integer representation of 2^53-1, the type of any IDs returned in the response body for this endpoint will be changed from a numeric type to a string type at the end of the deprecation period. In the meantime, this query param can be passed to this endpoint to opt-in to this change now. See this [changelog](https://developer.atlassian.com/cloud/confluence/changelog/#CHANGE-905) for more detail. (optional, defaults to false)
-
updateTask
Task updateTask(@NotNull @NotNull Long id, @NotNull @NotNull UpdateTaskRequest updateTaskRequest, @Nullable @Nullable Boolean serializeIdsAsStrings) Update taskUpdate a task by id. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to edit the containing page or blog post and view its corresponding space.
- Parameter:
id- The ID of the task to be updated. If you don't know the task ID, use Get tasks and filter the results. (required)updateTaskRequest- (required)serializeIdsAsStrings- Due to JavaScript's max integer representation of 2^53-1, the type of any IDs returned in the response body for this endpoint will be changed from a numeric type to a string type at the end of the deprecation period. In the meantime, this query param can be passed to this endpoint to opt-in to this change now. See this [changelog](https://developer.atlassian.com/cloud/confluence/changelog/#CHANGE-905) for more detail. (optional, defaults to false)
-