@managed-api/confluence-cloud-v2-sr-connect v2.1.0

ScriptRunner Connect Managed API for Confluence Cloud

Managed API for Confluence Cloud is an API Client for Confluence Cloud by Adaptavist. You can read more about Managed APIs here.

This is ScriptRunner Connect runtime specific version of the Managed API (with sr-connect suffix). If you want to use Managed API in any other runtime, have a look at the runtime agnostic version.

Supported API calls

• fetch
• Ancestor
  • getAllAncestorsOfPage
  • getAllAncestorsOfWhiteboard
• Attachment
  • deleteAttachment
  • getAttachmentById
  • getAttachments
  • BlogPost
    • getAttachments
  • CustomContent
    • getAttachments
  • Label
    • getAttachments
  • Page
    • getAttachments
• BlogPost
  • createBlogPost
  • deleteBlogPost
  • getBlogPostById
  • getBlogPosts
  • getBlogPostsForLabel
  • getBlogPostsInSpace
  • updateBlogPost
• Children
  • getChildCustomContent
  • getChildPages
• Comment
  • Attachment
    • getComments
  • CustomContent
    • getComments
  • Footer
    • createComment
    • deleteComment
    • getChildrenComments
    • getCommentById
    • getComments
    • updateComment
    • BlogPost
      • getComments
    • Page
      • getComments
  • Inline
    • createComment
    • deleteComment
    • getChildrenComments
    • getCommentById
    • getComments
    • updateComment
    • BlogPost
      • getComments
    • Page
      • getComments
• Content
  • convertIdsToTypes
  • Property
    • Attachment
      • createContentProperty
      • deleteContentPropertyById
      • getContentProperties
      • getContentPropertyById
      • updateContentPropertyById
    • BlogPost
      • createContentProperty
      • deleteContentPropertyById
      • getContentProperties
      • getContentPropertyById
      • updateContentPropertyById
    • Comment
      • createContentProperty
      • deleteContentPropertyById
      • getContentProperties
      • getContentPropertyById
      • updateContentPropertyById
    • CustomContent
      • createContentProperty
      • deleteContentPropertyById
      • getContentProperties
      • getContentPropertyById
      • updateContentPropertyById
    • Page
      • createContentProperty
      • deleteContentPropertyById
      • getContentProperties
      • getContentPropertyById
      • updateContentPropertyById
    • Whiteboard
      • createContentProperty
      • deleteContentPropertyById
      • getContentProperties
      • getContentPropertyById
      • updateContentPropertyById
• CustomContent
  • createCustomContent
  • deleteCustomContent
  • getCustomContentById
  • getCustomContentByType
  • updateCustomContent
  • BlogPost
    • getCustomContentByType
  • Page
    • getCustomContentByType
  • Space
    • getCustomContentByType
• Label
  • getLabels
  • Attachment
    • getLabels
  • BlogPost
    • getLabels
  • CustomContent
    • getLabels
  • Page
    • getLabels
  • Space
    • getLabels
    • getLabelsForContent
• Like
  • BlogPost
    • getAccountIdsOfLikes
    • getLikeCount
  • Comment
    • Footer
      • getAccountIdsOfLikes
      • getLikeCount
    • Inline
      • getAccountIdsOfLikes
      • getLikeCount
  • Page
    • getAccountIdsOfLikes
    • getLikeCount
• Page
  • createPage
  • deletePage
  • getPageById
  • getPages
  • getPagesForLabel
  • getPagesInSpace
  • updatePage
• Space
  • getSpaceById
  • getSpaces
  • Property
    • createProperty
    • deletePropertyById
    • getProperties
    • getPropertyById
    • updatePropertyById
• Task
  • getTaskById
  • getTasks
  • updateTask
• V1
  • Content
    • publishLegacyDraft
    • publishSharedDraft
    • searchContentByCQL
    • Attachment
      • createAttachment
      • createOrUpdateAttachment
      • updateAttachmentData
      • updateAttachmentProperties
    • Body
      • convertBody
      • Macro
        • getMacroById
    • Copy
      • copyPageHierarchy
      • copySinglePage
    • Descendant
      • getDescendants
      • getDescendantsByType
    • Label
      • addLabel
      • removeLabel
      • removeLabelWithQueryParameter
    • Move
      • movePageToNewLocationRelativeToTargetPage
    • Restriction
      • addRestrictions
      • deleteRestrictions
      • getRestrictions
      • getRestrictionsByOperation
      • getRestrictionsForOperation
      • updateRestrictions
      • Group
        • addGroup
        • getGroupStatus
        • removeGroup
    • Version
      • deleteVersion
      • restoreVersion
  • Label
    • getInfo
  • LongRunningTask
    • getLongRunningTask
    • getLongRunningTasks
  • Relation
    • createRelationship
    • deleteRelationship
    • findRelationshipFromSourceToTarget
    • findSourceEntitiesRelatedToTargetEntity
    • findTargetEntitiesRelatedToSourceEntity
  • Search
    • searchContent
    • searchUsers
  • Setting
    • getLookAndFeelSettings
    • getSystemInfo
    • resetLookAndFeelSettings
    • updateLookAndFeelSettings
  • Space
    • createSpace
    • deleteSpace
    • updateSpace
    • Private
      • createSpace
    • Setting
      • getSettings
      • updateSettings
  • Template
    • createContentTemplate
    • getBlueprintTemplates
    • getContentTemplate
    • getContentTemplates
    • removeTemplate
    • updateContentTemplate
  • Theme
    • getGlobalTheme
    • getSpaceTheme
    • getTheme
    • getThemes
    • resetSpaceTheme
    • setSpaceTheme
  • User
    • getAnonymousUser
    • getCurrentUser
    • getGroupsWhereUserMember
    • getUser
    • getUserEmail
    • getUserEmails
    • getUsersWithIds
  • UserGroup
    • createUserGroup
    • deleteUserGroupById
    • getUserGroupById
    • getUserGroups
    • Member
      • addMemberById
      • getMembersById
      • removeMemberById
  • Watcher
    • getSpaceWatchers
    • getWatchesForPage
    • getWatchesForSpace
    • Content
      • addWatcher
      • getWatcherStatus
      • removeWatcher
    • Label
      • addWatcher
      • getWatcherStatus
      • removeWatcher
    • Space
      • addWatcher
      • getWatcherStatus
      • removeWatcher
• Version
  • Attachment
    • getVersionDetails
    • getVersions
  • BlogPost
    • getVersionDetails
    • getVersions
  • Comment
    • Footer
      • getVersionDetails
      • getVersions
    • Inline
      • getVersionDetails
      • getVersions
  • CustomContent
    • getVersionDetails
    • getVersions
  • Page
    • getVersionDetails
    • getVersions
• Whiteboard
  • createWhiteboard
  • deleteWhiteboard
  • getWhiteboardById

Constructing Managed API

In ScriptRunner Connect a Managed API is constructed for you, but if you need to construct it manually, here's how you can do it:

import { ConfluenceCloudApi } from '@managed-api/confluence-cloud-v2-sr-connect';

export default async function() {
    const api = new ConfluenceCloudApi('API_CONNECTION_ID');
}

Contact

Feel free to drop ideas, suggestions or improvements into our Slack community channel.

Changelog

2.1.0

• Updated OpenApi Specification.

  • Added new fields include-labels, include-properties, include-operations, include-versions and include-version to Attachment.getAttachmentById.
  • Added new field purge toAttachment.deleteAttachment.
  • Added new field purge toCustomContent.deleteCustomContent.
  • Added new field version to Comment.Attachment.getComments.
  • Added new fields include-labels, include-properties, include-operations, include-versions, include-version and include-favorited-by-current-user-status to CustomContent.getCustomContentById.
  • Added new fields draft and purge to BlogPost.deleteBlogPost.
  • Added new fields draft and purge to Page.deletePage.
  • Added new field root-level to Page.createPage.
  • Added new fields include-labels, include-properties, include-operations, include-versions, include-version, include-likes, and include-favorited-by-current-user-status to Page.getPageById.
  • Added new fields favorited-by and not-favorited-by to Space.getSpaces.
  • Added new fields include-labels, include-properties, include-operationsand include-permissions to Space.getSpaceById.
  • Added new fields include-properties, include-operations, include-versions, include-version and include-likes to Comment.Footer.getCommentById.
  • Added new fields include-properties, include-operations, include-versions, include-version and include-likes to Comment.Inline.getCommentById.
  • Added new field body-format to Task.updateTask.
  • Removed deleted from status in BlogPost.updateBlogPost.
  • Added new field ownerId to Page.updatePage.
  • Attachment definition got changed to AttachmentSingle.
  • New properties in PageSingle definition.
  • New properties in PageBulk definition.

• Added support for the following Comment.CustomContent method:

  • Get custom content comments that can be used as Comment.CustomContent.getComments or All.getCustomContentComments.

• Added support for the following Whiteboard methods:

  • Create whiteboard that can be used as Whiteboard.createWhiteboard or All.getWhiteboard.
  • Get whiteboard by id that can be used as Whiteboard.getWhiteboardById or All.getWhiteboardById.
  • Delete whiteboard that can be used as Whiteboard.deleteWhiteboard or All.deleteWhiteboard.

• Added support for the following Content.Property.Whiteboard methods:

  • Get content properties for whiteboard that can be used as Content.Property.Whiteboard.getContentProperties or All.getContentPropertiesForWhiteboard.
  • Create content property for whiteboard that can be used as Content.Property.Whiteboard.createContentProperty or All.createContentPropertyForWhiteboard.
  • Get content property for whiteboard by id that can be used as Content.Property.Whiteboard.getContentPropertyById or All.getContentPropertyForWhiteboardById.
  • Update content property for whiteboard by id that can be used as Content.Property.Whiteboard.updateContentPropertyById or All.updateContentPropertyForWhiteboardById.
  • Delete content property for whiteboard by id that can be used as Content.Property.Whiteboard.deleteContentPropertyById or All.deleteContentPropertyForWhiteboardById.

• Added support for the following Ancestor method:

  • Get all ancestors of the whiteboard that can be used as Ancestor.getAllAncestorsOfWhiteboard or All.getAllAncestorsOfWhiteboard.

• Fixed following methods:

  • Get footer comments that can be used as Comment.Footer.getComments or All.getFooterComments.
  • updateComment that can be used as Comment.Footer.updateComment or All.updateFooterComment.
  • deleteComment that can be used as Comment.Footer.deleteComment or All.deleteFooterComment.
  • getCommentById that can be used as Comment.Inline.getCommentById or All.getInlineCommentById.
  • updateComment that can be used as Comment.Inline.updateComment or All.updateInlineComment.
  • deleteComment that can be used as Comment.Inline.deleteComment or All.deleteInlineComment.

• The following methods are deprecated:

  • Get content restriction status for group that can be used as V1.Content.Restriction.Group.getGroupStatus or All.getContentRestrictionGroupStatus.
  • Add group to content restriction that can be used as V1.Content.Restriction.Group.addGroup or All.addContentRestrictionGroup.
  • Remove group from content restriction that can be used as V1.Content.Restriction.Group.removeGroup or All.removeContentRestrictionGroup.

2.0.0

• Breaking change: URL and query string parameters are now URL encoded, meaning if you encoded them explicitly before you have to remove your own encoding, otherwise they will get double encoded.

1.0.0

• Added support for the following Attachment methods:

  • Get attachments that can be used as Attachment.getAttachments or All.getAttachments.
  • Get attachment by id that can be used as Attachment.getAttachmentById or All.getAttachmentByIds.
  • Delete attachment that can be used as Attachment.deleteAttachment or All.deleteAttachment.

• Added support for the following Attachment.BlogPost method:

  • Get attachments for blog post that can be used as Attachment.BlogPost.getAttachments or All.getAttachmentsForBlogPost.

• Added support for the following Attachment.CustomContent method:

  • Get attachments for custom content that can be used as Attachment.CustomContent.getAttachments or All.getAttachmentsForCustomContent.

• Added support for the following Attachment.Label method:

  • Get attachments for label that can be used as Attachment.Label.getAttachments or All.getAttachmentsForLabel.

• Added support for the following Attachment.Page method:

  • Get attachments for page that can be used as Attachment.Page.getAttachments or All.getAttachmentsForPage.

• Added support for the following Ancestor method:

  • Get all ancestors of page that can be used as Ancestor.getAllAncestorsOfPage or All.getAllAncestorsOfPage.

• Added support for the following BlogPost methods:

  • Get blog posts that can be used as BlogPost.getBlogPosts or All.getBlogPosts.
  • Create blog post that can be used as BlogPost.createBlogPost or All.createBlogPost.
  • Get blog post by id that can be used as BlogPost.getBlogPostById or All.getBlogPostById.
  • Update blog post that can be used as BlogPost.updateBlogPost or All.updateBlogPost.
  • Delete blog post that can be used as BlogPost.deleteBlogPost or All.deleteBlogPost.
  • Get blog posts for label that can be used as BlogPost.getBlogPostsForLabel or All.getBlogPostsForLabel.
  • Get blog posts in space that can be used as BlogPost.getBlogPostsInSpace or All.getBlogPostsInSpace.

• Added support for the following Children methods:

  • Get child pages that can be used as Children.getChildPages or All.getChildPages.
  • Get child custom content that can be used as Children.getChildCustomContent or All.getChildCustomContent.

• Added support for the following Comment.Attachment method:

  • Get attachment comments that can be used as Comment.Attachment.getComments or All.getAttachmentComments.

• Added support for the following Comment.Footer.Page method:

  • Get footer comments for page that can be used as Comment.Footer.Page.getComments or All.getFooterCommentsForPage.

• Added support for the following Comment.Inline.Page method:

  • Get inline comments for page that can be used as Comment.Inline.Page.getComments or All.getInlineCommentsForPage.

• Added support for the following Comment.Footer.BlogPost method:

  • Get footer comments for blog post that can be used as Comment.Footer.BlogPost.getComments or All.getFooterCommentsForBlogPost.

• Added support for the following Comment.Inline.BlogPost method:

  • Get inline comments for blog post that can be used as Comment.Inline.BlogPost.getComments or All.getInlineCommentsForFooter.

• Added support for the following Comment.Footer methods:

  • Get footer comments that can be used as Comment.Footer.getComments or All.getFooterComments.
  • Create footer comment that can be used as Comment.Footer.createComment or All.createFooterComment.
  • getCommentById that can be used as Comment.Footer.getCommentById or All.getFooterCommentById.
  • updateComment that can be used as Comment.Footer.updateComment or All.updateFooterComment.
  • deleteComment that can be used as Comment.Footer.deleteComment or All.deleteFooterComment.
  • Get children footer comments that can be used as Comment.Footer.getChildrenComments or All.getChildrenFooterComments.

• Added support for the following Comment.Inline methods:

  • Get inline comments that can be used as Comment.Inline.getComments or All.getInlineComments.
  • Create inline comment that can be used as Comment.Inline.createComment or All.createInlineComment.
  • getCommentById that can be used as Comment.Inline.getCommentById or All.getInlineCommentById.
  • updateComment that can be used as Comment.Inline.updateComment or All.updateInlineComment.
  • deleteComment that can be used as Comment.Inline.deleteComment or All.deleteInlineComment.
  • Get children inline comments that can be used as Comment.Inline.getChildrenComments or All.getChildrenInlineComments.

• Added support for the following Content method:

  • Convert content ids to content types that can be used as Content.convertIdsToTypes or All.convertContentIdsToContentType.

• Added support for the following Content.Property.Attachment methods:

  • Get content properties for attachment that can be used as Content.Property.Attachment.getContentProperties or All.getContentPropertiesForAttachment.
  • Create content property for attachment that can be used as Content.Property.Attachment.createContentProperty or All.createContentPropertyForAttachment.
  • Get content property for attachment by id that can be used as Content.Property.Attachment.getContentPropertyById or All.getContentPropertyForAttachmentById.
  • Update content property for attachment by id that can be used as Content.Property.Attachment.updateContentPropertyById or All.updateContentPropertyForAttachmentById.
  • Delete content property for attachment by id that can be used as Content.Property.Attachment.deleteContentPropertyById or All.deleteContentPropertyForAttachmentById.

• Added support for the following Content.Property.BlogPost methods:

  • Get content properties for blog post that can be used as Content.Property.BlogPost.getContentProperties or All.getContentPropertiesForBlogPost.
  • Create content property for blog post that can be used as Content.Property.BlogPost.createContentProperty or All.createContentPropertyForBlogPost.
  • Get content property for blog post by id that can be used as Content.Property.BlogPost.getContentPropertyById or All.getContentPropertyForBlogPostById.
  • Update content property for blog post by id that can be used as Content.Property.BlogPost.updateContentPropertyById or All.updateContentPropertyForBlogPostById.
  • Delete content property for blogpost by id that can be used as Content.Property.BlogPost.deleteContentPropertyById or All.deleteContentPropertyForBlogPostById.

• Added support for the following Content.Property.CustomContent methods:

  • Get content properties for custom content that can be used as Content.Property.CustomContent.getContentProperties or All.getContentPropertiesForCustomContent.
  • Create content property for custom content that can be used as Content.Property.CustomContent.createContentProperty or All.createContentPropertyForCustomContent.
  • Get content property for custom content by id that can be used as Content.Property.CustomContent.getContentPropertyById or All.getContentPropertyForCustomContentById.
  • Update content property for custom content by id that can be used as Content.Property.CustomContent.updateContentPropertyById or All.updateContentPropertyById.
  • Delete content property for custom content by id that can be used as Content.Property.CustomContent.deleteContentPropertyById or All.deleteContentPropertyForCustomContentById.

• Added support for the following Content.Property.Page methods:

  • Get content properties for page that can be used as Content.Property.Page.getContentProperties or All.getContentPropertiesForPage.
  • Create content property for page that can be used as Content.Property.Page.createContentProperty or All.createContentPropertyForPage.
  • Get content property for page by id that can be used as Content.Property.Page.getContentPropertyById or All.getContentPropertyForPageById.
  • Update content property for page by id that can be used as Content.Property.Page.updateContentPropertyById or All.updateContentPropertyForPageById.
  • Delete content property for page by id that can be used as Content.Property.Page.deleteContentPropertyById or All.deleteContentPropertyForPageById.

• Added support for the following Content.Property.Comment methods:

  • Get content properties for comment that can be used as Content.Property.Comment.getContentProperties or All.getContentPropertiesForComment.
  • Create content property for comment that can be used as Content.Property.Comment.createContentProperty or All.createContentPropertyForComment.
  • Get content property for comment by id that can be used as Content.Property.Comment.getContentPropertyById or All.getContentPropertyForCommentById.
  • Update content property for comment by id that can be used as Content.Property.Comment.updateContentPropertyById or All.updateContentPropertyForCommentById.
  • Delete content property for comment by id that can be used as Content.Property.Comment.deleteContentPropertyById or All.deleteContentPropertyForCommentById.

• Added support for the following CustomContent.BlogPost method:

  • Get custom content by type in blog post that can be used as CustomContent.BlogPost.getCustomContentByType or All.getCustomContentByTypeInBlogPost.

• Added support for the following CustomContent methods:

  • Get custom content by type that can be used as CustomContent.getCustomContentByType or All.getCustomContentByType.
  • Create custom content that can be used as CustomContent.createCustomContent or All.createCustomContent.
  • Get custom content by id that can be used as CustomContent.getCustomContentById or All.getCustomContentById.
  • Update custom content that can be used as CustomContent.updateCustomContent or All.updateCustomContent.
  • Delete custom content that can be used as CustomContent.deleteCustomContent or All.deleteCustomContent.

• Added support for the following CustomContent.Page method:

  • Get custom content by type in page that can be used as CustomContent.Page.getCustomContentByType or All.getCustomContentByTypeInPage.

• Added support for the following CustomContent.Space method:

  • Get custom content by type in space that can be used as CustomContent.Space.getCustomContentByType or All.getCustomContentByTypeInSpace.

• Added support for the following Label.Attachment method:

  • Get labels for attachment that can be used as Label.Attachment.getLabels or All.getLabelsForAttachment.

• Added support for the following Label.BlogPost method:

  • Get labels for blog post that can be used as Label.BlogPost.getLabels or All.getLabelsForBlogPost.

• Added support for the following Label.CustomContent method:

  • Get labels for custom content that can be used as Label.CustomContent.getLabels or All.getLabelsForCustomContent.

• Added support for the following Label.Page method:

  • Get labels for page that can be used as Label.Page.getLabels or All.getLabelsForPage.

• Added support for the following Label method:

  • Get labels that can be used as Label.getLabels or All.getLabels.

• Added support for the following Label.Space methods:

  • Get labels for space that can be used as Label.Space.getLabels or All.getLabelsForSpace.
  • Get labels for space content that can be used as Label.Space.getLabelsForContent or All.getLabelsForSpaceContent.

• Added support for the following Like.BlogPost methods:

  • Get like count for blog post that can be used as Like.BlogPost.getLikeCount or All.getLikeCountForBlogPost.
  • Get account IDs of likes for blog post that can be used as Like.BlogPost.getAccountIdsOfLikes or All.getAccountIdsOfLikesForBlogPost.

• Added support for the following Like.Page methods:

  • Get like count for page that can be used as Like.Page.getLikeCount or All.getLikeCountForPage.
  • Get account IDs of likes for page that can be used as Like.Page.getAccountIdsOfLikes or All.getAccountIdsOfLikesForPage.

• Added support for the following Like.Comment.Footer methods:

  • Get like count for footer comment that can be used as Like.Comment.Footer.getLikeCount or All.getLikeCountForFooterComment.
  • Get account IDs of likes for footer comment that can be used as Like.Comment.Footer.getAccountIdsOfLikes or All.getAccountIdsOfLikesForFooterComment.

• Added support for the following Like.Comment.Inline methods:

  • Get like count for inline comment that can be used as Like.Comment.Inline.getLikeCount or All.getLikeCountForInlineComment.
  • Get account IDs of likes for inline comment that can be used as Like.Comment.Inline.getAccountIdsOfLikes or All.getAccountIdsOfLikesForInlineComment.

• Added support for the following Page methods:

  • Get pages for label that can be used as Page.getPagesForLabel or All.getPagesForLabel.
  • Get pages that can be used as Page.getPages or All.getPages.
  • Create page that can be used as Page.createPage or All.createPage.
  • Get page by id that can be used as Page.getPageById or All.getPageById.
  • Update page that can be used as Page.updatePage or All.updatePage.
  • Delete page(https://developer.atlassian.com/clo