Class DescendantsService

See

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

Hierarchy

  • CommonHttpService
    • DescendantsService

Constructors

constructor

Methods

getDatabaseDescendants getFolderDescendants getPageDescendants getSmartLinkDescendants getWhiteboardDescendants initialize

Constructors

constructor

  • new DescendantsService(getClientInstance): DescendantsService
  • Internal

    Create a new instance of the service.

    Parameters

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

        • Returns CommonHttpClient

    Returns DescendantsService

Methods

getDatabaseDescendants

  • getDatabaseDescendants(params): Promise<{
        _links?: MultiEntityLinks;
        results?: DescendantsResponse[];
    } & {
        [key: string]: unknown;
    }>

  • Returns descendants in the content tree for a given database by ID in top-to-bottom order (that is, the highest descendant is the first item in the response payload). The number of results is limited by the limit parameter and additional results (if available) will be available by calling this endpoint with the cursor in the response payload. There is also a depth parameter specifying depth of descendants to be fetched.

    The following types of content will be returned:

    • Database
    • Embed
    • Folder
    • Page
    • Whiteboard

    This endpoint returns minimal information about each descendant. To fetch more details, use a related endpoint based on the content type, such as:

    Permissions required: Permission to access the Confluence site ('Can use' global permission). Permission to view the database and its corresponding space

    Parameters

    • params: {
          cursor?: string;
          depth?: number;
          id: number;
          limit?: number;
      }
      • Optionalcursor?: string

        Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results.

      • Optionaldepth?: number

        Maximum depth of descendants to return. If more results are required, use the endpoint corresponding to the content type of the deepest descendant to fetch more descendants.

      • id: number

        The ID of the database.

      • Optionallimit?: number

        Maximum number of items per result to return. If more results exist, call the endpoint with the cursor to fetch the next set of results.

    Returns Promise<{
        _links?: MultiEntityLinks;
        results?: DescendantsResponse[];
    } & {
        [key: string]: unknown;
    }>

    Returned if the requested descendants are returned.

    Path

    GET /databases/{id}/descendants @scopes-current read:hierarchical-content:confluence

    See

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

getFolderDescendants

  • getFolderDescendants(params): Promise<{
        _links?: MultiEntityLinks;
        results?: DescendantsResponse[];
    } & {
        [key: string]: unknown;
    }>

  • Returns descendants in the content tree for a given folder by ID in top-to-bottom order (that is, the highest descendant is the first item in the response payload). The number of results is limited by the limit parameter and additional results (if available) will be available by calling this endpoint with the cursor in the response payload. There is also a depth parameter specifying depth of descendants to be fetched.

    The following types of content will be returned:

    • Database
    • Embed
    • Folder
    • Page
    • Whiteboard

    This endpoint returns minimal information about each descendant. To fetch more details, use a related endpoint based on the content type, such as:

    Permissions required: Permission to access the Confluence site ('Can use' global permission). Permission to view the and its corresponding space

    Parameters

    • params: {
          cursor?: string;
          depth?: number;
          id: number;
          limit?: number;
      }
      • Optionalcursor?: string

        Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results.

      • Optionaldepth?: number

        Maximum depth of descendants to return. If more results are required, use the endpoint corresponding to the content type of the deepest descendant to fetch more descendants.

      • id: number

        The ID of the folder.

      • Optionallimit?: number

        Maximum number of items per result to return. If more results exist, call the endpoint with the cursor to fetch the next set of results.

    Returns Promise<{
        _links?: MultiEntityLinks;
        results?: DescendantsResponse[];
    } & {
        [key: string]: unknown;
    }>

    Returned if the requested descendants are returned.

    Path

    GET /folders/{id}/descendants @scopes-current read:hierarchical-content:confluence

    See

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

getPageDescendants

  • getPageDescendants(params): Promise<{
        _links?: MultiEntityLinks;
        results?: DescendantsResponse[];
    } & {
        [key: string]: unknown;
    }>

  • Returns descendants in the content tree for a given page by ID in top-to-bottom order (that is, the highest descendant is the first item in the response payload). The number of results is limited by the limit parameter and additional results (if available) will be available by calling this endpoint with the cursor in the response payload. There is also a depth parameter specifying depth of descendants to be fetched.

    The following types of content will be returned:

    • Database
    • Embed
    • Folder
    • Page
    • Whiteboard

    This endpoint returns minimal information about each descendant. To fetch more details, use a related endpoint based on the content type, such as:

    Permissions required: Permission to access the Confluence site ('Can use' global permission). Permission to view the page and its corresponding space

    Parameters

    • params: {
          cursor?: string;
          depth?: number;
          id: number;
          limit?: number;
      }
      • Optionalcursor?: string

        Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results.

      • Optionaldepth?: number

        Maximum depth of descendants to return. If more results are required, use the endpoint corresponding to the content type of the deepest descendant to fetch more descendants.

      • id: number

        The ID of the page.

      • Optionallimit?: number

        Maximum number of items per result to return. If more results exist, call the endpoint with the cursor to fetch the next set of results.

    Returns Promise<{
        _links?: MultiEntityLinks;
        results?: DescendantsResponse[];
    } & {
        [key: string]: unknown;
    }>

    Returned if the requested descendants are returned.

    Path

    GET /pages/{id}/descendants @scopes-current read:hierarchical-content:confluence

    See

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

getSmartLinkDescendants

  • getSmartLinkDescendants(params): Promise<{
        _links?: MultiEntityLinks;
        results?: DescendantsResponse[];
    } & {
        [key: string]: unknown;
    }>

  • Returns descendants in the content tree for a given smart link by ID in top-to-bottom order (that is, the highest descendant is the first item in the response payload). The number of results is limited by the limit parameter and additional results (if available) will be available by calling this endpoint with the cursor in the response payload. There is also a depth parameter specifying depth of descendants to be fetched.

    The following types of content will be returned:

    • Database
    • Embed
    • Folder
    • Page
    • Whiteboard

    This endpoint returns minimal information about each descendant. To fetch more details, use a related endpoint based on the content type, such as:

    Permissions required: Permission to access the Confluence site ('Can use' global permission). Permission to view the smart link and its corresponding space

    Parameters

    • params: {
          cursor?: string;
          depth?: number;
          id: number;
          limit?: number;
      }
      • Optionalcursor?: string

        Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results.

      • Optionaldepth?: number

        Maximum depth of descendants to return. If more results are required, use the endpoint corresponding to the content type of the deepest descendant to fetch more descendants.

      • id: number

        The ID of the smart link.

      • Optionallimit?: number

        Maximum number of items per result to return. If more results exist, call the endpoint with the cursor to fetch the next set of results.

    Returns Promise<{
        _links?: MultiEntityLinks;
        results?: DescendantsResponse[];
    } & {
        [key: string]: unknown;
    }>

    Returned if the requested descendants are returned.

    Path

    GET /embeds/{id}/descendants @scopes-current read:hierarchical-content:confluence

    See

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

getWhiteboardDescendants

  • getWhiteboardDescendants(params): Promise<{
        _links?: MultiEntityLinks;
        results?: DescendantsResponse[];
    } & {
        [key: string]: unknown;
    }>

  • Returns descendants in the content tree for a given whiteboard by ID in top-to-bottom order (that is, the highest descendant is the first item in the response payload). The number of results is limited by the limit parameter and additional results (if available) will be available by calling this endpoint with the cursor in the response payload. There is also a depth parameter specifying depth of descendants to be fetched.

    The following types of content will be returned:

    • Database
    • Embed
    • Folder
    • Page
    • Whiteboard

    This endpoint returns minimal information about each descendant. To fetch more details, use a related endpoint based on the content type, such as:

    Permissions required: Permission to access the Confluence site ('Can use' global permission). Permission to view the whiteboard and its corresponding space

    Parameters

    • params: {
          cursor?: string;
          depth?: number;
          id: number;
          limit?: number;
      }
      • Optionalcursor?: string

        Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results.

      • Optionaldepth?: number

        Maximum depth of descendants to return. If more results are required, use the endpoint corresponding to the content type of the deepest descendant to fetch more descendants.

      • id: number

        The ID of the whiteboard.

      • Optionallimit?: number

        Maximum number of items per result to return. If more results exist, call the endpoint with the cursor to fetch the next set of results.

    Returns Promise<{
        _links?: MultiEntityLinks;
        results?: DescendantsResponse[];
    } & {
        [key: string]: unknown;
    }>

    Returned if the requested descendants are returned.

    Path

    GET /whiteboards/{id}/descendants @scopes-current read:hierarchical-content:confluence

    See

    https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-descendants#api-whiteboards-id-descendants-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