@managed-api/confluence-cloud-stitch-it NPM

Stitch It 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 Stitch It runtime specific version of the Managed API (with stitch-it 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
  - convertBody
  - 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 Stitch It 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-stitch-it';

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

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.