Class ChildrenService

See

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

Hierarchy

  • CommonHttpService
    • ChildrenService

Constructors

constructor

Methods

getChildCustomContent getChildPages getDatabaseDirectChildren getFolderDirectChildren getPageDirectChildren getSmartLinkDirectChildren getWhiteboardDirectChildren initialize

Constructors

constructor

  • new ChildrenService(getClientInstance): ChildrenService
  • Internal

    Create a new instance of the service.

    Parameters

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

        • Returns CommonHttpClient

    Returns ChildrenService

Methods

getChildCustomContent

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

  • Returns all child custom content for given custom content id. The number of results is limited by the limit parameter and additional results (if available) will be available through the next URL present in the Link response header.

    Permissions required: Permission to access the Confluence site ('Can use' global permission). Only custom content that the user has permission to view will be returned.

    Parameters

    • params: {
          cursor?: string;
          id: number;
          limit?: number;
          sort?: string;
      }
      • 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.

      • id: number

        The ID of the parent custom content. If you don't know the custom content ID, use Get custom-content and filter the results.

      • Optionallimit?: number

        Maximum number of pages per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results.

      • Optionalsort?: string

        Used to sort the result by a particular field.

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

    Returned if the requested child custom content are returned.

    Path

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

    See

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

getChildPages

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

  • Returns all child pages for given page id. The number of results is limited by the limit parameter and additional results (if available) will be available through the next URL present in the Link response header.

    Permissions required: Permission to access the Confluence site ('Can use' global permission). Only pages that the user has permission to view will be returned.

    Parameters

    • params: {
          cursor?: string;
          id: number;
          limit?: number;
          sort?: string;
      }
      • 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.

      • id: number

        The ID of the parent page. If you don't know the page ID, use Get pages and filter the results.

      • Optionallimit?: number

        Maximum number of pages per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results.

      • Optionalsort?: string

        Used to sort the result by a particular field.

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

    Returned if the requested child pages are returned.

    Deprecated

    Path

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

    See

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

getDatabaseDirectChildren

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

  • Returns all children for given database id in the content tree. The number of results is limited by the limit parameter and additional results (if available) will be available through the next URL present in the Link response header.

    The following types of content will be returned:

    • Database
    • Embed
    • Folder
    • Page
    • Whiteboard

    This endpoint returns minimal information about each child. 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). Only content that the user has permission to view will be returned.

    Parameters

    • params: {
          cursor?: string;
          id: number;
          limit?: number;
          sort?: string;
      }
      • 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.

      • id: number

        The ID of the parent database.

      • Optionallimit?: number

        Maximum number of items per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results.

      • Optionalsort?: string

        Used to sort the result by a particular field.

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

    Returned if the requested children are returned.

    Path

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

    See

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

getFolderDirectChildren

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

  • Returns all children for given folder id in the content tree. The number of results is limited by the limit parameter and additional results (if available) will be available through the next URL present in the Link response header.

    The following types of content will be returned:

    • Database
    • Embed
    • Folder
    • Page
    • Whiteboard

    This endpoint returns minimal information about each child. 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). Only content that the user has permission to view will be returned.

    Parameters

    • params: {
          cursor?: string;
          id: number;
          limit?: number;
          sort?: string;
      }
      • 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.

      • id: number

        The ID of the parent folder.

      • Optionallimit?: number

        Maximum number of items per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results.

      • Optionalsort?: string

        Used to sort the result by a particular field.

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

    Returned if the requested children are returned.

    Path

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

    See

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

getPageDirectChildren

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

  • Returns all children for given page id in the content tree. The number of results is limited by the limit parameter and additional results (if available) will be available through the next URL present in the Link response header.

    The following types of content will be returned:

    • Database
    • Embed
    • Folder
    • Page
    • Whiteboard

    This endpoint returns minimal information about each child. 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). Only content that the user has permission to view will be returned.

    Parameters

    • params: {
          cursor?: string;
          id: number;
          limit?: number;
          sort?: string;
      }
      • 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.

      • id: number

        The ID of the parent page.

      • Optionallimit?: number

        Maximum number of items per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results.

      • Optionalsort?: string

        Used to sort the result by a particular field.

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

    Returned if the requested children are returned.

    Path

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

    See

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

getSmartLinkDirectChildren

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

  • Returns all children for given smart link id in the content tree. The number of results is limited by the limit parameter and additional results (if available) will be available through the next URL present in the Link response header.

    The following types of content will be returned:

    • Database
    • Embed
    • Folder
    • Page
    • Whiteboard

    This endpoint returns minimal information about each child. 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). Only content that the user has permission to view will be returned.

    Parameters

    • params: {
          cursor?: string;
          id: number;
          limit?: number;
          sort?: string;
      }
      • 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.

      • id: number

        The ID of the parent smart link.

      • Optionallimit?: number

        Maximum number of items per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results.

      • Optionalsort?: string

        Used to sort the result by a particular field.

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

    Returned if the requested children are returned.

    Path

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

    See

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

getWhiteboardDirectChildren

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

  • Returns all children for given whiteboard id in the content tree. The number of results is limited by the limit parameter and additional results (if available) will be available through the next URL present in the Link response header.

    The following types of content will be returned:

    • Database
    • Embed
    • Folder
    • Page
    • Whiteboard

    This endpoint returns minimal information about each child. 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). Only content that the user has permission to view will be returned.

    Parameters

    • params: {
          cursor?: string;
          id: number;
          limit?: number;
          sort?: string;
      }
      • 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.

      • id: number

        The ID of the parent whiteboard.

      • Optionallimit?: number

        Maximum number of items per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results.

      • Optionalsort?: string

        Used to sort the result by a particular field.

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

    Returned if the requested children are returned.

    Path

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

    See

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