Class OperationService

See

https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-operation

Hierarchy

CommonHttpService
- OperationService

Index

Constructors

Methods

getAttachmentOperations getBlogPostOperations getCustomContentOperations getDatabaseOperations getFolderOperations getFooterCommentOperations getInlineCommentOperations getPageOperations getSmartLinkOperations getSpaceOperations getWhiteboardOperations initialize

Constructors

constructor

new OperationService(getClientInstance): OperationService
Internal
Create a new instance of the service.
Parameters
- getClientInstance: (() => CommonHttpClient)
  - - (): CommonHttpClient
    - Returns CommonHttpClient
Returns OperationService
Inherited from CommonHttpService.constructor

Methods

getAttachmentOperations

getAttachmentOperations(params): Promise<PermittedOperationsResponse>
Returns the permitted operations on specific attachment.

Permissions required: Permission to view the parent content of the attachment and its corresponding space.
Parameters
- params: {
  id: string;
  }
  - id: string
    The ID of the attachment for which operations should be returned.
Returns Promise<PermittedOperationsResponse>
Returned if the requested operations are returned.

Path
GET /attachments/{id}/operations @scopes-current read:attachment:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-operation#api-attachments-id-operations-get

getBlogPostOperations

getBlogPostOperations(params): Promise<PermittedOperationsResponse>
Returns the permitted operations on specific blog post.

Permissions required: Permission to view the parent content of the blog post and its corresponding space.
Parameters
- params: {
  id: number;
  }
  - id: number
    The ID of the blog post for which operations should be returned.
Returns Promise<PermittedOperationsResponse>
Returned if the requested operations are returned.

Path
GET /blogposts/{id}/operations @scopes-current read:page:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-operation#api-blogposts-id-operations-get

getCustomContentOperations

getCustomContentOperations(params): Promise<PermittedOperationsResponse>
Returns the permitted operations on specific custom content.

Permissions required: Permission to view the parent content of the custom content and its corresponding space.
Parameters
- params: {
  id: number;
  }
  - id: number
    The ID of the custom content for which operations should be returned.
Returns Promise<PermittedOperationsResponse>
Returned if the requested operations are returned.

Path
GET /custom-content/{id}/operations @scopes-current read:custom-content:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-operation#api-custom-content-id-operations-get

getDatabaseOperations

getDatabaseOperations(params): Promise<PermittedOperationsResponse>
Returns the permitted operations on specific database.

Permissions required: Permission to view the database and its corresponding space.
Parameters
- params: {
  id: number;
  }
  - id: number
    The ID of the database for which operations should be returned.
Returns Promise<PermittedOperationsResponse>
Returned if the requested operations are returned.

Path
GET /databases/{id}/operations @scopes-current read:database:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-operation#api-databases-id-operations-get

getFolderOperations

getFolderOperations(params): Promise<PermittedOperationsResponse>
Returns the permitted operations on specific folder.

Permissions required: Permission to view the folder and its corresponding space.
Parameters
- params: {
  id: number;
  }
  - id: number
    The ID of the folder for which operations should be returned.
Returns Promise<PermittedOperationsResponse>
Returned if the requested operations are returned.

Path
GET /folders/{id}/operations @scopes-current read:folder:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-operation#api-folders-id-operations-get

getFooterCommentOperations

getFooterCommentOperations(params): Promise<PermittedOperationsResponse>
Returns the permitted operations on specific footer comment.

Permissions required: Permission to view the parent content of the footer comment and its corresponding space.
Parameters
- params: {
  id: number;
  }
  - id: number
    The ID of the footer comment for which operations should be returned.
Returns Promise<PermittedOperationsResponse>
Returned if the requested operations are returned.

Path
GET /footer-comments/{id}/operations @scopes-current read:comment:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-operation#api-footer-comments-id-operations-get

getInlineCommentOperations

getInlineCommentOperations(params): Promise<PermittedOperationsResponse>
Returns the permitted operations on specific inline comment.

Permissions required: Permission to view the parent content of the inline comment and its corresponding space.
Parameters
- params: {
  id: number;
  }
  - id: number
    The ID of the inline comment for which operations should be returned.
Returns Promise<PermittedOperationsResponse>
Returned if the requested operations are returned.

Path
GET /inline-comments/{id}/operations @scopes-current read:comment:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-operation#api-inline-comments-id-operations-get

getPageOperations

getPageOperations(params): Promise<PermittedOperationsResponse>
Returns the permitted operations on specific page.

Permissions required: Permission to view the parent content of the page and its corresponding space.
Parameters
- params: {
  id: number;
  }
  - id: number
    The ID of the page for which operations should be returned.
Returns Promise<PermittedOperationsResponse>
Returned if the requested operations are returned.

Path
GET /pages/{id}/operations @scopes-current read:page:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-operation#api-pages-id-operations-get

getSmartLinkOperations

getSmartLinkOperations(params): Promise<PermittedOperationsResponse>
Returns the permitted operations on specific Smart Link in the content tree.

Permissions required: Permission to view the Smart Link in the content tree and its corresponding space.
Parameters
- params: {
  id: number;
  }
  - id: number
    The ID of the Smart Link in the content tree for which operations should be returned.
Returns Promise<PermittedOperationsResponse>
Returned if the requested operations are returned.

Path
GET /embeds/{id}/operations @scopes-current read:embed:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-operation#api-embeds-id-operations-get

getSpaceOperations

getSpaceOperations(params): Promise<PermittedOperationsResponse>
Returns the permitted operations on specific space.

Permissions required: Permission to view the corresponding space.
Parameters
- params: {
  id: number;
  }
  - id: number
    The ID of the space for which operations should be returned.
Returns Promise<PermittedOperationsResponse>
Returned if the requested operations are returned.

Path
GET /spaces/{id}/operations @scopes-current read:space:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-operation#api-spaces-id-operations-get

getWhiteboardOperations

getWhiteboardOperations(params): Promise<PermittedOperationsResponse>
Returns the permitted operations on specific whiteboard.

Permissions required: Permission to view the whiteboard and its corresponding space.
Parameters
- params: {
  id: number;
  }
  - id: number
    The ID of the whiteboard for which operations should be returned.
Returns Promise<PermittedOperationsResponse>
Returned if the requested operations are returned.

Path
GET /whiteboards/{id}/operations @scopes-current read:whiteboard:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-operation#api-whiteboards-id-operations-get

`Protected` `Static`initialize

initialize(): void
Method to initialize the class. Normally used to set up validation rules.

Returns void
Overrides CommonHttpService.initialize

Class OperationService

See

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns CommonHttpClient

Returns OperationService

Methods

getAttachmentOperations

Parameters

id: string

Returns Promise<PermittedOperationsResponse>

Path

See

getBlogPostOperations

Parameters

id: number

Returns Promise<PermittedOperationsResponse>

Path

See

getCustomContentOperations

Parameters

id: number

Returns Promise<PermittedOperationsResponse>

Path

See

getDatabaseOperations

Parameters

id: number

Returns Promise<PermittedOperationsResponse>

Path

See

getFolderOperations

Parameters

id: number

Returns Promise<PermittedOperationsResponse>

Path

See

getFooterCommentOperations

Parameters

id: number

Returns Promise<PermittedOperationsResponse>

Path

See

getInlineCommentOperations

Parameters

id: number

Returns Promise<PermittedOperationsResponse>

Path

See

getPageOperations

Parameters

id: number

Returns Promise<PermittedOperationsResponse>

Path

See

getSmartLinkOperations

Parameters

id: number

Returns Promise<PermittedOperationsResponse>

Path

See

getSpaceOperations

Parameters

id: number

Returns Promise<PermittedOperationsResponse>

Path

See

getWhiteboardOperations

Parameters

id: number

Returns Promise<PermittedOperationsResponse>

Path

See

Protected Staticinitialize

Returns void

`Protected` `Static`initialize