@managed-api/confluence-cloud-v2-sr-connect
v2.4.0
Published
Adaptavist Managed API for Confluence Cloud v2 for ScriptRunner Connect environment
Downloads
28
Keywords
Readme
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
- Attachment
- deleteAttachment
- getAttachmentById
- getAttachments
- BlogPost
- CustomContent
- Label
- Page
- BlogPost
- Children
- Comment
- Attachment
- CustomContent
- Footer
- Inline
- Content
- convertIdsToTypes
- Property
- Attachment
- BlogPost
- Comment
- CustomContent
- Folder
- Page
- Whiteboard
- CustomContent
- Database
- Descendant
- Folder
- Label
- Like
- Page
- SmartLink
- Space
- Task
- V1
- Content
- publishLegacyDraft
- publishSharedDraft
- searchContentByCQL
- Attachment
- Body
- Copy
- Descendant
- Label
- Move
- Restriction
- Version
- Label
- LongRunningTask
- Relation
- Search
- Setting
- Space
- Template
- Theme
- User
- UserGroup
- Watcher
- Content
- Version
- Attachment
- BlogPost
- Comment
- CustomContent
- Page
- Whiteboard
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 Community hub.
Changelog
2.3.0
- Removed non-empty body from HEAD requests.
2.2.0
The following methods are deprecated:
- Convert content body that can be used as
V1.Content.Body.convertBodyorAll.convertContentBody. - Get content descendants that can be used as
V1.Content.Descendant.getDescendantsorAll.getContentDescendants. - Get content descendants by type that can be used as
V1.Content.Descendant.getDescendantsByTypeorAll.getContentDescendantsByType. - Get child pages that can be used as
Children.getChildPagesorAll.getChildPages.
- Convert content body that can be used as
Added support for the following V1.Content.Body methods:
- Asynchronously convert content body that can be used as
V1.Content.Body.asyncConvertBodyorAll.asyncConvertContentBody. - Get asynchronously converted content body from the id or the current status of the task that can be used as
V1.Content.Body.getAsyncConvertResultorAll.getAsyncConvertContentBodyResult.
- Asynchronously convert content body that can be used as
Added support for the following Children methods:
- Get direct children of a whiteboard that can be used as
Children.getWhiteboardDirectChildrenorAll.getWhiteboardDirectChildren. - Get direct children of a database that can be used as
Children.getDatabaseDirectChildrenorAll.getDatabaseDirectChildren. - Get direct children of a Smart Link that can be used as
Children.getSmartLinkDirectChildrenorAll.getSmartLinkDirectChildren. - Get direct children of a folder that can be used as
Children.getFolderDirectChildrenorAll.getFolderDirectChildren. - Get direct children of a page that can be used as
Children.getPageDirectChildrenorAll.getPageDirectChildren.
- Get direct children of a whiteboard that can be used as
Added support for the following Descendant methods:
- Get descendants of a whiteboard that can be used as
Descendant.getWhiteboardDescendantsorAll.getWhiteboardDescendants. - Get descendants of a database that can be used as
Descendant.getDatabaseDescendantsorAll.getDatabaseDescendants. - Get descendants of a smart link that can be used as
Descendant.getSmartLinkDescendantsorAll.getSmartLinkDescendants. - Get descendants of folder that can be used as
Descendant.getFolderDescendantsorAll.getFolderDescendants. - Get descendants of page that can be used as
Descendant.getPageDescendantsorAll.getPageDescendants.
- Get descendants of a whiteboard that can be used as
Added support for the following Folder methods:
- Create folder that can be used as
Folder.createFolderorAll.createFolder. - Get folder by id that can be used as
Folder.getFolderByIdorAll.getFolderById. - Delete folder that can be used as
Folder.deleteFolderorAll.deleteFolder.
- Create folder that can be used as
Added support for the following Content.Property.Folder methods:
- Get content properties for folder that can be used as
Content.Property.Folder.getContentPropertiesorAll.getContentPropertiesForFolder. - Create content property for folder that can be used as
Content.Property.Folder.createContentPropertyorAll.createContentPropertyForFolder. - Get content property for folder by id that can be used as
Content.Property.Folder.getContentPropertyByIdorAll.getContentPropertyForFolderById. - Update content property for folder by id that can be used as
Content.Property.Folder.updateContentPropertyByIdorAll.updateContentPropertyForFolderById. - Delete content property for folder by id that can be used as
Content.Property.Folder.deleteContentPropertyByIdorAll.deleteContentPropertyForFolderById.
- Get content properties for folder that can be used as
Added support for the following Database methods:
- Create database that can be used as
Database.createDatabaseorAll.createDatabase. - Get database by id that can be used as
Database.getDatabaseByIdorAll.getDatabaseById. - Delete database that can be used as
Database.deleteDatabaseorAll.deleteDatabase.
- Create database that can be used as
Added support for the following SmartLink methods:
- Create Smart Link in the content tree that can be used as
SmartLink.createSmartLinkorAll.createSmartLink. - Get Smart Link in the content tree by id that can be used as
SmartLink.getSmartLinkByIdorAll.getSmartLinkById. - Delete Smart Link in the content tree that can be used as
SmartLink.deleteSmartLinkorAll.deleteSmartLink.
- Create Smart Link in the content tree that can be used as
Added support for the following Ancestor methods:
- Get all ancestors of database that can be used as
Ancestor.getAllAncestorsOfDatabaseorAll.getAllAncestorsOfDatabase. - Get all ancestors of Smart Link in content tree that can be used as
Ancestor.getAllAncestorsOfSmartLinkorAll.getAllAncestorsOfSmartLink. - Get all ancestors of folder that can be used as
Ancestor.getAllAncestorsOfFolderorAll.getAllAncestorsOfFolder.
- Get all ancestors of database that can be used as
Changes the following methods:
V1.LongRunningTask.getLongRunningTasks-Keyparameter was added.V1.Template.getBlueprintTemplates-body.storageoption was added toexpand.V1.Template.getContentTemplates-body.storageoption was added toexpand.V1.User.getUsersWithIds-isExternalCollaboratoroption was added toexpand,limitwas removed.V1.User.getUsersWithIds-isExternalCollaboratoroption was added toexpand,limitwas removed.Attachment.getAttachmentById-include-collaboratorsparameter was added.BlogPost.getBlogPostById-status,include-webresourcesandinclude-collaboratorsparameters were added.CustomContent.getCustomContentById-include-collaboratorsparameter was added.Page.getPageById-status,include-webresources,include-collaboratorsandinclude-direct-childrenparameters were added.Whiteboard.getWhiteboardById-include-collaborators,include-direct-children,include-operationsandinclude-propertiesparameters were added.Space.getSpaces-collaborationandknowledge_basewas added totype.Comment.Footer.Page.getComments-statusparameter was added.Comment.Inline.Page.getComments-statusandresolution-statusparameter were added.Comment.Footer.BlogPost.getComments-statusparameter was added.Comment.Inline.BlogPost.getComments-statusandresolution-statusparameter were added.BlogPost.createBlogPost-createdAtparameter was added.BlogPost.updateBlogPost-createdAtparameter was added.CustomContent.createCustomContent-draftoption was added tostatus.Whiteboard.createWhiteboard-templateKeyandlocaleparameters were added.
2.1.0
Updated OpenApi Specification.
- Added new fields
include-labels,include-properties,include-operations,include-versionsandinclude-versiontoAttachment.getAttachmentById. - Added new field
purgetoAttachment.deleteAttachment. - Added new field
purgetoCustomContent.deleteCustomContent. - Added new field
versiontoComment.Attachment.getComments. - Added new fields
include-labels,include-properties,include-operations,include-versions,include-versionandinclude-favorited-by-current-user-statustoCustomContent.getCustomContentById. - Added new fields
draftandpurgetoBlogPost.deleteBlogPost. - Added new fields
draftandpurgetoPage.deletePage. - Added new field
root-leveltoPage.createPage. - Added new fields
include-labels,include-properties,include-operations,include-versions,include-version,include-likes, andinclude-favorited-by-current-user-statustoPage.getPageById. - Added new fields
favorited-byandnot-favorited-bytoSpace.getSpaces. - Added new fields
include-labels,include-properties,include-operationsandinclude-permissionstoSpace.getSpaceById. - Added new fields
include-properties,include-operations,include-versions,include-versionandinclude-likestoComment.Footer.getCommentById. - Added new fields
include-properties,include-operations,include-versions,include-versionandinclude-likestoComment.Inline.getCommentById. - Added new field
body-formattoTask.updateTask. - Removed
deletedfromstatusinBlogPost.updateBlogPost. - Added new field
ownerIdtoPage.updatePage. Attachmentdefinition got changed toAttachmentSingle.- New properties in
PageSingledefinition. - New properties in
PageBulkdefinition.
- Added new fields
Added support for the following Comment.CustomContent method:
- Get custom content comments that can be used as
Comment.CustomContent.getCommentsorAll.getCustomContentComments.
- Get custom content comments that can be used as
Added support for the following Whiteboard methods:
- Create whiteboard that can be used as
Whiteboard.createWhiteboardorAll.getWhiteboard. - Get whiteboard by id that can be used as
Whiteboard.getWhiteboardByIdorAll.getWhiteboardById. - Delete whiteboard that can be used as
Whiteboard.deleteWhiteboardorAll.deleteWhiteboard.
- Create whiteboard that can be used as
Added support for the following Content.Property.Whiteboard methods:
- Get content properties for whiteboard that can be used as
Content.Property.Whiteboard.getContentPropertiesorAll.getContentPropertiesForWhiteboard. - Create content property for whiteboard that can be used as
Content.Property.Whiteboard.createContentPropertyorAll.createContentPropertyForWhiteboard. - Get content property for whiteboard by id that can be used as
Content.Property.Whiteboard.getContentPropertyByIdorAll.getContentPropertyForWhiteboardById. - Update content property for whiteboard by id that can be used as
Content.Property.Whiteboard.updateContentPropertyByIdorAll.updateContentPropertyForWhiteboardById. - Delete content property for whiteboard by id that can be used as
Content.Property.Whiteboard.deleteContentPropertyByIdorAll.deleteContentPropertyForWhiteboardById.
- Get content properties for whiteboard that can be used as
Added support for the following Ancestor method:
- Get all ancestors of the whiteboard that can be used as
Ancestor.getAllAncestorsOfWhiteboardorAll.getAllAncestorsOfWhiteboard.
- Get all ancestors of the whiteboard that can be used as
Fixed following methods:
- Get footer comments that can be used as
Comment.Footer.getCommentsorAll.getFooterComments. - updateComment that can be used as
Comment.Footer.updateCommentorAll.updateFooterComment. - deleteComment that can be used as
Comment.Footer.deleteCommentorAll.deleteFooterComment. - getCommentById that can be used as
Comment.Inline.getCommentByIdorAll.getInlineCommentById. - updateComment that can be used as
Comment.Inline.updateCommentorAll.updateInlineComment. - deleteComment that can be used as
Comment.Inline.deleteCommentorAll.deleteInlineComment.
- Get footer comments that can be used as
The following methods are deprecated:
- Get content restriction status for group that can be used as
V1.Content.Restriction.Group.getGroupStatusorAll.getContentRestrictionGroupStatus. - Add group to content restriction that can be used as
V1.Content.Restriction.Group.addGrouporAll.addContentRestrictionGroup. - Remove group from content restriction that can be used as
V1.Content.Restriction.Group.removeGrouporAll.removeContentRestrictionGroup.
- Get content restriction status for group that can be used as
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.getAttachmentsorAll.getAttachments. - Get attachment by id that can be used as
Attachment.getAttachmentByIdorAll.getAttachmentByIds. - Delete attachment that can be used as
Attachment.deleteAttachmentorAll.deleteAttachment.
- Get attachments that can be used as
Added support for the following Attachment.BlogPost method:
- Get attachments for blog post that can be used as
Attachment.BlogPost.getAttachmentsorAll.getAttachmentsForBlogPost.
- Get attachments for blog post that can be used as
Added support for the following Attachment.CustomContent method:
- Get attachments for custom content that can be used as
Attachment.CustomContent.getAttachmentsorAll.getAttachmentsForCustomContent.
- Get attachments for custom content that can be used as
Added support for the following Attachment.Label method:
- Get attachments for label that can be used as
Attachment.Label.getAttachmentsorAll.getAttachmentsForLabel.
- Get attachments for label that can be used as
Added support for the following Attachment.Page method:
- Get attachments for page that can be used as
Attachment.Page.getAttachmentsorAll.getAttachmentsForPage.
- Get attachments for page that can be used as
Added support for the following Ancestor method:
- Get all ancestors of page that can be used as
Ancestor.getAllAncestorsOfPageorAll.getAllAncestorsOfPage.
- Get all ancestors of page that can be used as
Added support for the following BlogPost methods:
- Get blog posts that can be used as
BlogPost.getBlogPostsorAll.getBlogPosts. - Create blog post that can be used as
BlogPost.createBlogPostorAll.createBlogPost. - Get blog post by id that can be used as
BlogPost.getBlogPostByIdorAll.getBlogPostById. - Update blog post that can be used as
BlogPost.updateBlogPostorAll.updateBlogPost. - Delete blog post that can be used as
BlogPost.deleteBlogPostorAll.deleteBlogPost. - Get blog posts for label that can be used as
BlogPost.getBlogPostsForLabelorAll.getBlogPostsForLabel. - Get blog posts in space that can be used as
BlogPost.getBlogPostsInSpaceorAll.getBlogPostsInSpace.
- Get blog posts that can be used as
Added support for the following Children methods:
- Get child pages that can be used as
Children.getChildPagesorAll.getChildPages. - Get child custom content that can be used as
Children.getChildCustomContentorAll.getChildCustomContent.
- Get child pages that can be used as
Added support for the following Comment.Attachment method:
- Get attachment comments that can be used as
Comment.Attachment.getCommentsorAll.getAttachmentComments.
- Get attachment comments that can be used as
Added support for the following Comment.Footer.Page method:
- Get footer comments for page that can be used as
Comment.Footer.Page.getCommentsorAll.getFooterCommentsForPage.
- Get footer comments for page that can be used as
Added support for the following Comment.Inline.Page method:
- Get inline comments for page that can be used as
Comment.Inline.Page.getCommentsorAll.getInlineCommentsForPage.
- Get inline comments for page that can be used as
Added support for the following Comment.Footer.BlogPost method:
- Get footer comments for blog post that can be used as
Comment.Footer.BlogPost.getCommentsorAll.getFooterCommentsForBlogPost.
- Get footer comments for blog post that can be used as
Added support for the following Comment.Inline.BlogPost method:
- Get inline comments for blog post that can be used as
Comment.Inline.BlogPost.getCommentsorAll.getInlineCommentsForFooter.
- Get inline comments for blog post that can be used as
Added support for the following Comment.Footer methods:
- Get footer comments that can be used as
Comment.Footer.getCommentsorAll.getFooterComments. - Create footer comment that can be used as
Comment.Footer.createCommentorAll.createFooterComment. - getCommentById that can be used as
Comment.Footer.getCommentByIdorAll.getFooterCommentById. - updateComment that can be used as
Comment.Footer.updateCommentorAll.updateFooterComment. - deleteComment that can be used as
Comment.Footer.deleteCommentorAll.deleteFooterComment. - Get children footer comments that can be used as
Comment.Footer.getChildrenCommentsorAll.getChildrenFooterComments.
- Get footer comments that can be used as
Added support for the following Comment.Inline methods:
- Get inline comments that can be used as
Comment.Inline.getCommentsorAll.getInlineComments. - Create inline comment that can be used as
Comment.Inline.createCommentorAll.createInlineComment. - getCommentById that can be used as
Comment.Inline.getCommentByIdorAll.getInlineCommentById. - updateComment that can be used as
Comment.Inline.updateCommentorAll.updateInlineComment. - deleteComment that can be used as
Comment.Inline.deleteCommentorAll.deleteInlineComment. - Get children inline comments that can be used as
Comment.Inline.getChildrenCommentsorAll.getChildrenInlineComments.
- Get inline comments that can be used as
Added support for the following Content method:
- Convert content ids to content types that can be used as
Content.convertIdsToTypesorAll.convertContentIdsToContentType.
- Convert content ids to content types that can be used as
Added support for the following Content.Property.Attachment methods:
- Get content properties for attachment that can be used as
Content.Property.Attachment.getContentPropertiesorAll.getContentPropertiesForAttachment. - Create content property for attachment that can be used as
Content.Property.Attachment.createContentPropertyo
- Get content properties for attachment that can be used as
