Class AncestorsService

See

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

Hierarchy

  • CommonHttpService
    • AncestorsService

Constructors

constructor

Methods

getDatabaseAncestors getFolderAncestors getPageAncestors getSmartLinkAncestors getWhiteboardAncestors initialize

Constructors

constructor

  • new AncestorsService(getClientInstance): AncestorsService
  • Internal

    Create a new instance of the service.

    Parameters

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

        • Returns CommonHttpClient

    Returns AncestorsService

Methods

getDatabaseAncestors

  • getDatabaseAncestors(params): Promise<{
        results?: Ancestor[];
    } & {
        [key: string]: unknown;
    }>

  • Returns all ancestors for a given database by ID in top-to-bottom order (that is, the highest ancestor 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 ID of first ancestor in the response payload.

    This endpoint returns minimal information about each ancestor. To fetch more details, use a related endpoint, such as Get database by id.

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

    Parameters

    • params: {
          id: number;
          limit?: number;
      }
      • 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 highest ancestor's ID to fetch the next set of results.

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

    Returned if the requested ancestors are returned.

    Path

    GET /databases/{id}/ancestors @scopes-current read:content.metadata:confluence

    See

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

getFolderAncestors

  • getFolderAncestors(params): Promise<{
        results?: Ancestor[];
    } & {
        [key: string]: unknown;
    }>

  • Returns all ancestors for a given folder by ID in top-to-bottom order (that is, the highest ancestor 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 ID of first ancestor in the response payload.

    This endpoint returns minimal information about each ancestor. To fetch more details, use a related endpoint, such as Get folder by id.

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

    Parameters

    • params: {
          id: number;
          limit?: number;
      }
      • 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 highest ancestor's ID to fetch the next set of results.

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

    Returned if the requested ancestors are returned.

    Path

    GET /folders/{id}/ancestors @scopes-current read:content.metadata:confluence

    See

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

getPageAncestors

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

  • Returns all ancestors for a given page by ID in top-to-bottom order (that is, the highest ancestor 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 ID of first ancestor in the response payload.

    This endpoint returns minimal information about each ancestor. To fetch more details, use a related endpoint, such as Get page by id.

    Permissions required: Permission to access the Confluence site ('Can use' global permission).

    Parameters

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

        The ID of the page.

      • Optionallimit?: number

        Maximum number of pages per result to return. If more results exist, call this endpoint with the highest ancestor's ID to fetch the next set of results.

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

    Returned if the requested ancestors are returned.

    Path

    GET /pages/{id}/ancestors @scopes-current read:content.metadata:confluence

    See

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

getSmartLinkAncestors

  • getSmartLinkAncestors(params): Promise<{
        results?: Ancestor[];
    } & {
        [key: string]: unknown;
    }>

  • Returns all ancestors for a given Smart Link in the content tree by ID in top-to-bottom order (that is, the highest ancestor 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 ID of first ancestor in the response payload.

    This endpoint returns minimal information about each ancestor. To fetch more details, use a related endpoint, such as Get Smart Link in the content tree by id.

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

    Parameters

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

        The ID of the Smart Link in the content tree.

      • Optionallimit?: number

        Maximum number of items per result to return. If more results exist, call the endpoint with the highest ancestor's ID to fetch the next set of results.

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

    Returned if the requested ancestors are returned.

    Path

    GET /embeds/{id}/ancestors @scopes-current read:content.metadata:confluence

    See

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

getWhiteboardAncestors

  • getWhiteboardAncestors(params): Promise<{
        results?: Ancestor[];
    } & {
        [key: string]: unknown;
    }>

  • Returns all ancestors for a given whiteboard by ID in top-to-bottom order (that is, the highest ancestor 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 ID of first ancestor in the response payload.

    This endpoint returns minimal information about each ancestor. To fetch more details, use a related endpoint, such as Get whiteboard by id.

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

    Parameters

    • params: {
          id: number;
          limit?: number;
      }
      • 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 highest ancestor's ID to fetch the next set of results.

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

    Returned if the requested ancestors are returned.

    Path

    GET /whiteboards/{id}/ancestors @scopes-current read:content.metadata:confluence

    See

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