@managed-api/confluence-cloud-sr-connect NPM

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
Content
- createContent
- deleteContent
- getContent
- getContentById
- getContentHistory
- publishLegacyDraft
- publishSharedDraft
- searchContentByCQL
- updateContent
- Attachment
  - createAttachment
  - createOrUpdateAttachment
  - getAttachments
  - updateAttachmentData
  - updateAttachmentProperties
- Body
  - asyncConvertBody
  - convertBody
  - getAsyncConvertResult
  - Macro
    - getMacroById
- Children
  - getChildren
  - getChildrenByType
- Comment
  - getComments
- Copy
  - copyPageHierarchy
  - copySinglePage
- Descendant
  - getDescendants
  - getDescendantsByType
- Label
  - addLabel
  - getLabels
  - removeLabel
  - removeLabelWithQueryParameter
- Move
  - movePageToNewLocationRelativeToTargetPage
- Property
  - createProperty
  - createPropertyForKey
  - deleteProperty
  - getProperties
  - getProperty
  - updateProperty
- Restriction
  - addRestrictions
  - deleteRestrictions
  - getRestrictions
  - getRestrictionsByOperation
  - getRestrictionsForOperation
  - updateRestrictions
  - Group
  - User
- Version
  - deleteVersion
  - getVersion
  - getVersions
  - restoreVersion
DynamicModule
InlineTask
- getInlineTasksBasedOnSearchParameters
Label
- getInfo
LongRunningTask
- getLongRunningTask
- getLongRunningTasks
Relation
Search
- searchContent
- searchUsers
Setting
Space
- createSpace
- deleteSpace
- getSpace
- getSpaces
- updateSpace
- Content
  - getContent
  - getContentByType
- Private
  - createSpace
- Property
- Setting
  - getSettings
  - updateSettings
Template
Theme
User
UserGroup
Watcher
- getSpaceWatchers
- getWatchesForPage
- getWatchesForSpace
- Content
- Label
- Space

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-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

3.1.0

Removed non-empty body from HEAD requests.

3.0.0

Changed the following methods:
- Content.Attachment.updateAttachmentProperties - Request body parameters got updated.
- Content.Move.movePageToNewLocationRelativeToTargetPage - Path got fixed.
- Content.Restriction.Group.getGroupStatus - groupName got replaced by groupId.
- Content.Restriction.Group.addGroup - groupName got replaced by groupId.
- Content.Restriction.Group.removeGroup - groupName got replaced by groupId.
- UserGroup.deleteUserGroup - name parameter got replaced by id.
- UserGroup.getUserGroupByName - Method was removed, alternative is UserGroup.getUserGroupById.
- UserGroup.Member.getMembersByName - Method was removed, alternative is UserGroup.Member.getMembersById.
- UserGroup.Member.getMembersById - expand parameter was added.
- UserGroup.Member.addMemberByName - Method was removed, alternative is UserGroup.Member.addMemberById.
- UserGroup.Member.removeMember - Method was removed, alternative is UserGroup.Member.removeMemberById.
- LongRunningTask.getLongRunningTasks - Key parameter was added.
- Search.searchUsers - sitePermissionTypeFilter parameter was added.
- Template.getBlueprintTemplates - body.storage option was added to expand.
- Template.getContentTemplates - body.storage option was added to expand.
- User.getUsersWithIds - isExternalCollaborator option was added to expand, limit was removed.
- User.getUserAccountIds - Method was removed.

The following methods are deprecated:
- Convert content body that can be used as Content.Body.convertBody or All.convertContentBody.
- Get content descendants that can be used as Content.Descendant.getDescendants or All.getContentDescendants.
- Get content descendants by type that can be used as Content.Descendant.getDescendantsByType or All.getContentDescendantsByType.
The following methods are added:
- Asynchronously convert content body that can be used as Content.Body.asyncConvertBody or All.asyncConvertContentBody.
- Get asynchronously converted content body from the id or the current status of the task that can be used as Content.Body.getAsyncConvertResult or All.getAsyncConvertContentBodyResult.

2.1.0

The following methods are deprecated:
- Get content properties that can be used as Content.Property.getProperties or All.getContentProperties.
- Create content property that can be used as Content.Property.createProperty or All.createContentProperty.
- Get content property that can be used as Content.Property.getProperty or All.getContentProperty.
- Update content property that can be used as Content.Property.updateProperty or All.updateContentProperty.
- Create content property for key that can be used as Content.Property.createPropertyForKey or All.createContentPropertyForKey.
- Delete content property that can be used as Content.Property.deleteProperty or All.deleteContentProperty.
- Get content restriction status for group that can be used as Content.Restriction.Group.getGroupStatus or All.getContentRestrictionGroupStatus.
- Add group to content restriction that can be used as Content.Restriction.Group.addGroup or All.addContentRestrictionGroup.
- Remove group from content restriction that can be used as Content.Restriction.Group.removeGroup or All.removeContentRestrictionGroup.
- Delete user group that can be used as UserGroup.deleteUserGroup or All.deleteUserGroup.
- Get group that can be used as UserGroup.getUserGroupByName or All.getUserGroupByName.
- Get group members that can be used as UserGroup.Member.getMembersByName or All.getUserGroupMembersByName.
- Add member to group that can be used as UserGroup.Member.addMemberByName or All.addUserGroupMembersByName.
- Remove member from group that can be used as UserGroup.Member.removeMember or All.removeUserGroupMember.
- Create space property that can be used as Space.Property.createProperty or All.createSpaceProperty.
- Get space property that can be used as Space.Property.getProperty or All.getSpaceProperty.
- Update space property that can be used as Space.Property.updateProperty or All.updateSpaceProperty.
- Create space property for key that can be used as Space.Property.createPropertyForKey or All.createSpacePropertyForKey.
- Delete space property that can be used as Space.Property.deleteProperty or All.deleteSpaceProperty.

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.

0.11.0

The following methods are deprecated:
- Get content that can be used as Content.getContent or All.getContent.
- Create Content that can be used as Content.createContent or All.createContent.
- Get content by ID that can be used as Content.getContentById or All.getContentById.
- Update content that can be used as Content.updateContent or All.updateContent.
- Delete content that can be used as Content.deleteContent or All.deleteContent.
- Get content history that can be used as Content.getContentHistory or All.getContentHistory.
- Get attachments that can be used as Content.Attachment.getAttachments or All.getContentAttachments.
- Get content children that can be used as Content.Children.getAttachments or All.getContentChildren.
- Get content children by type that can be used as Content.Children.getChildrenByType or All.getContentChildrenByType.
- Get content comments that can be used as Content.Comment.getComments or All.getContentComments.
- Get labels for content that can be used as Content.Label.getLabels or All.getContentLabels.
- Get content versions that can be used as Content.Version.getVersions or All.getContentVersions.
- Get content version that can be used as Content.Version.getVersion or All.getContentVersion.
- Get inline tasks based on search parameters that can be used as InlineTask.getInlineTasksBasedOnSearchParameters or All.getInlineTasksBasedOnSearchParameters.
- Get spaces that can be used as Space.getSpaces or All.getSpaces.
- Get space that can be used as Space.getSpace or All.getSpace.
- Get content for space that can be used as Space.Content.getContent or All.getSpaceContent.
- Get content by type for space that can be used as Space.Content.getContentByType or All.getSpaceContentByType.
- Get space properties that can be used as Space.Property.getProperties or All.getSpaceProperties.