Class WhiteboardService

See

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

Hierarchy

  • CommonHttpService
    • WhiteboardService

Constructors

constructor

Methods

createWhiteboard deleteWhiteboard getWhiteboardById initialize

Constructors

constructor

  • new WhiteboardService(getClientInstance): WhiteboardService
  • Internal

    Create a new instance of the service.

    Parameters

    • getClientInstance: (() => CommonHttpClient)
        • (): CommonHttpClient

        • Returns CommonHttpClient

    Returns WhiteboardService

Methods

createWhiteboard

  • createWhiteboard(params): Promise<WhiteboardSingle & {
        _links?: {
            base?: string;
        } & {
            [key: string]: unknown;
        };
    } & {
        [key: string]: unknown;
    }>

  • Creates a whiteboard in the space.

    Permissions required: Permission to view the corresponding space. Permission to create a whiteboard in the space.

    Parameters

    • params: {
          private?: boolean;
          requestBody: {
              locale?:
                  | "en-US"
                  | "cs-CZ"
                  | "da-DK"
                  | "de-DE"
                  | "es-ES"
                  | "fr-FR"
                  | "it-IT"
                  | "nb-NO"
                  | "nl-NL"
                  | "hu-HU"
                  | "pl-PL"
                  | "ru-RU"
                  | "sv-SE"
                  | "tr-TR"
                  | "en-GB"
                  | "pt-BR"
                  | "zh-CN"
                  | "zh-TW"
                  | "fi-FI"
                  | "ja-JP"
                  | "ko-KR";
              parentId?: string;
              spaceId: string;
              templateKey?:
                  | "timeline"
                  | "2x2-prioritization"
                  | "4ls-retro"
                  | "annual-calendar"
                  | "brainwriting"
                  | "concept-map"
                  | "crazy-8s"
                  | "daily-sync"
                  | "disruptive-brainstorm"
                  | "dot-voting"
                  | "elevator-pitch"
                  | "flow-chart"
                  | "gap-analysis"
                  | "ice-breakers"
                  | "incident-postmortem"
                  | "journey-mapping-kit"
                  | "kanban-board"
                  | "lean-coffee"
                  | "network-of-teams"
                  | "org-chart"
                  | "pi-planning"
                  | "prioritization"
                  | "prioritization-experiment"
                  | "product-roadmap"
                  | "product-vision-board"
                  | "rice"
                  | "sailboat-retro"
                  | "service-blueprint"
                  | "simple-retrospective"
                  | "sprint-planning"
                  | "sticky-note-pack"
                  | "swimlanes"
                  | "team-formation-guide"
                  | "timeline-workflow"
                  | "user-story-map"
                  | "workflow"
                  | "vision-board"
                  | "venn-diagram"
                  | "storyboard"
                  | "action-plan"
                  | "root-cause-analysis"
                  | "executive-summary"
                  | "stakeholder-mapping"
                  | "annual-calendar-2025-2026"
                  | "health-monitor"
                  | "okr-planning"
                  | "swot-analysis"
                  | "poker-planning"
                  | "fishbone-diagram"
                  | "risk-assessment"
                  | "bounded-context"
                  | "hopes-and-fears"
                  | "swimlane-vertical";
              title?: string;
          } & {
              [key: string]: unknown;
          };
      }
      • Optionalprivate?: boolean

        The whiteboard will be private. Only the user who creates this whiteboard will have permission to view and edit one.

      • requestBody: {
            locale?:
                | "en-US"
                | "cs-CZ"
                | "da-DK"
                | "de-DE"
                | "es-ES"
                | "fr-FR"
                | "it-IT"
                | "nb-NO"
                | "nl-NL"
                | "hu-HU"
                | "pl-PL"
                | "ru-RU"
                | "sv-SE"
                | "tr-TR"
                | "en-GB"
                | "pt-BR"
                | "zh-CN"
                | "zh-TW"
                | "fi-FI"
                | "ja-JP"
                | "ko-KR";
            parentId?: string;
            spaceId: string;
            templateKey?:
                | "timeline"
                | "2x2-prioritization"
                | "4ls-retro"
                | "annual-calendar"
                | "brainwriting"
                | "concept-map"
                | "crazy-8s"
                | "daily-sync"
                | "disruptive-brainstorm"
                | "dot-voting"
                | "elevator-pitch"
                | "flow-chart"
                | "gap-analysis"
                | "ice-breakers"
                | "incident-postmortem"
                | "journey-mapping-kit"
                | "kanban-board"
                | "lean-coffee"
                | "network-of-teams"
                | "org-chart"
                | "pi-planning"
                | "prioritization"
                | "prioritization-experiment"
                | "product-roadmap"
                | "product-vision-board"
                | "rice"
                | "sailboat-retro"
                | "service-blueprint"
                | "simple-retrospective"
                | "sprint-planning"
                | "sticky-note-pack"
                | "swimlanes"
                | "team-formation-guide"
                | "timeline-workflow"
                | "user-story-map"
                | "workflow"
                | "vision-board"
                | "venn-diagram"
                | "storyboard"
                | "action-plan"
                | "root-cause-analysis"
                | "executive-summary"
                | "stakeholder-mapping"
                | "annual-calendar-2025-2026"
                | "health-monitor"
                | "okr-planning"
                | "swot-analysis"
                | "poker-planning"
                | "fishbone-diagram"
                | "risk-assessment"
                | "bounded-context"
                | "hopes-and-fears"
                | "swimlane-vertical";
            title?: string;
        } & {
            [key: string]: unknown;
        }

    Returns Promise<WhiteboardSingle & {
        _links?: {
            base?: string;
        } & {
            [key: string]: unknown;
        };
    } & {
        [key: string]: unknown;
    }>

    Returned if the whiteboard was successfully created.

    Path

    POST /whiteboards @scopes-current write:whiteboard:confluence

    See

    https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-whiteboard#api-whiteboards-post

deleteWhiteboard

  • deleteWhiteboard(params): Promise<void>

  • Delete a whiteboard by id.

    Deleting a whiteboard moves the whiteboard to the trash, where it can be restored later

    Permissions required: Permission to view the whiteboard and its corresponding space. Permission to delete whiteboards in the space.

    Parameters

    • params: {
          id: number;
      }
      • id: number

        The ID of the whiteboard to be deleted.

    Returns Promise<void>

    Path

    DELETE /whiteboards/{id} @scopes-current delete:whiteboard:confluence

    See

    https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-whiteboard#api-whiteboards-id-delete

getWhiteboardById

  • getWhiteboardById(params): Promise<WhiteboardSingle & {
        _links?: {
            base?: string;
        } & {
            [key: string]: unknown;
        };
    } & {
        [key: string]: unknown;
    }>

  • Returns a specific whiteboard.

    Permissions required: Permission to view the whiteboard and its corresponding space.

    Parameters

    • params: {
          id: number;
          includeCollaborators?: boolean;
          includeDirectChildren?: boolean;
          includeOperations?: boolean;
          includeProperties?: boolean;
      }
      • id: number

        The ID of the whiteboard to be returned

      • OptionalincludeCollaborators?: boolean

        Includes collaborators on the whiteboard.

      • OptionalincludeDirectChildren?: boolean

        Includes direct children of the whiteboard, as defined in the ChildrenResponse object.

      • OptionalincludeOperations?: boolean

        Includes operations associated with this whiteboard in the response, as defined in the Operation object. The number of results will be limited to 50 and sorted in the default sort order. A meta and _links property will be present to indicate if more results are available and a link to retrieve the rest of the results.

      • OptionalincludeProperties?: boolean

        Includes content properties associated with this whiteboard in the response. The number of results will be limited to 50 and sorted in the default sort order. A meta and _links property will be present to indicate if more results are available and a link to retrieve the rest of the results.

    Returns Promise<WhiteboardSingle & {
        _links?: {
            base?: string;
        } & {
            [key: string]: unknown;
        };
    } & {
        [key: string]: unknown;
    }>

    Returned if the requested whiteboard is returned.

    Path

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

    See

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

Protected Staticinitialize

  • initialize(): void

  • Method to initialize the class. Normally used to set up validation rules.

    Returns void

Settings

Member Visibility

On This Page

Constructors
Methods