Class ConfluenceApiV1

The Confluence REST API V1 Client.

Hierarchy (view full)

BaseConfluenceApiV1Client
- ConfluenceApiV1

Constructor

constructor

new ConfluenceApiV1(options): ConfluenceApiV1
Parameters
- options: ApiClientOptions<
      | ApiClientAceOptions
      | ApiClientApOptions
      | ApiClientForgeApiExternalOptions
      | ApiClientForgeApiOptions
      | ApiClientForgeApiWithProviderOptions
      | ApiClientForgeBridgeConfluenceOptions>
Returns ConfluenceApiV1
Overrides BaseConfluenceApiV1Client.constructor

Impersonalization

asApp

asApp: (() => ConfluenceApiV1) = ...

Switches the API client to the app context.

asUser

asUser: ((userAccountId?: string) => ConfluenceApiV1) = ...

Switches the API client to the user context.

Services

analytics

get analytics(): AnalyticsService
Returns AnalyticsService
See
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-analytics

Inherited from BaseConfluenceApiV1Client.analytics

audit

get audit(): AuditService
Returns AuditService
See
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-audit

Inherited from BaseConfluenceApiV1Client.audit

content

get content(): ContentService
Returns ContentService
See
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content

Inherited from BaseConfluenceApiV1Client.content

contentAttachments

get contentAttachments(): ContentAttachmentsService
Returns ContentAttachmentsService
See
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-attachments

Inherited from BaseConfluenceApiV1Client.contentAttachments

contentBody

get contentBody(): ContentBodyService
Returns ContentBodyService
See
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-body

Inherited from BaseConfluenceApiV1Client.contentBody

contentChildrenAndDescendants

get contentChildrenAndDescendants(): ContentChildrenAndDescendantsService
Returns ContentChildrenAndDescendantsService
See
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-children-and-descendants

Inherited from BaseConfluenceApiV1Client.contentChildrenAndDescendants

contentLabels

get contentLabels(): ContentLabelsService
Returns ContentLabelsService
See
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-labels

Inherited from BaseConfluenceApiV1Client.contentLabels

contentMacroBody

get contentMacroBody(): ContentMacroBodyService
Returns ContentMacroBodyService
See
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-macro-body

Inherited from BaseConfluenceApiV1Client.contentMacroBody

contentPermissions

get contentPermissions(): ContentPermissionsService
Returns ContentPermissionsService
See
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-permissions

Inherited from BaseConfluenceApiV1Client.contentPermissions

contentRestrictions

get contentRestrictions(): ContentRestrictionsService
Returns ContentRestrictionsService
See
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-restrictions

Inherited from BaseConfluenceApiV1Client.contentRestrictions

contentStates

get contentStates(): ContentStatesService
Returns ContentStatesService
See
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-states

Inherited from BaseConfluenceApiV1Client.contentStates

contentVersions

get contentVersions(): ContentVersionsService
Returns ContentVersionsService
See
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-versions

Inherited from BaseConfluenceApiV1Client.contentVersions

contentWatches

get contentWatches(): ContentWatchesService
Returns ContentWatchesService
See
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-watches

Inherited from BaseConfluenceApiV1Client.contentWatches

dynamicModules

get dynamicModules(): DynamicModulesService
Returns DynamicModulesService
See
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-dynamic-modules

Inherited from BaseConfluenceApiV1Client.dynamicModules

experimental

get experimental(): ExperimentalService
APIs in this section can change without any prior deprecation notice.

Returns ExperimentalService
See
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-experimental

Inherited from BaseConfluenceApiV1Client.experimental

group

get group(): GroupService
WARNING The standard Atlassian group names are default names only and can be edited or deleted. For example, an admin or Atlassian support could delete the default group jira-software-users or rename it to jsw-users at any point.

Returns GroupService
See
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-group

Inherited from BaseConfluenceApiV1Client.group

labelInfo

get labelInfo(): LabelInfoService
Returns LabelInfoService
See
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-label-info

Inherited from BaseConfluenceApiV1Client.labelInfo

longRunningTask

get longRunningTask(): LongRunningTaskService
Returns LongRunningTaskService
See
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-long-running-task

Inherited from BaseConfluenceApiV1Client.longRunningTask

relation

get relation(): RelationService
Returns RelationService
See
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-relation

Inherited from BaseConfluenceApiV1Client.relation

search

get search(): SearchService
Returns SearchService
See
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-search

Inherited from BaseConfluenceApiV1Client.search

settings

get settings(): SettingsService
Returns SettingsService
See
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-settings

Inherited from BaseConfluenceApiV1Client.settings

space

get space(): SpaceService
Returns SpaceService
See
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-space

Inherited from BaseConfluenceApiV1Client.space

spacePermissions

get spacePermissions(): SpacePermissionsService
Returns SpacePermissionsService
See
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-space-permissions

Inherited from BaseConfluenceApiV1Client.spacePermissions

spaceSettings

get spaceSettings(): SpaceSettingsService
Returns SpaceSettingsService
See
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-space-settings

Inherited from BaseConfluenceApiV1Client.spaceSettings

template

get template(): TemplateService
Returns TemplateService
See
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-template

Inherited from BaseConfluenceApiV1Client.template

themes

get themes(): ThemesService
Returns ThemesService
See
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-themes

Inherited from BaseConfluenceApiV1Client.themes

userProperties

get userProperties(): UserPropertiesService
Returns UserPropertiesService
See
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-user-properties

Inherited from BaseConfluenceApiV1Client.userProperties

users

get users(): UsersService
Returns UsersService
See
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-users

Inherited from BaseConfluenceApiV1Client.users