ATatlassian
Content - children and descendants

Get content descendants

Returns a map of the descendants of a piece of content. This is similar to Get content children, except that this method returns child pages at all levels, rather than just the direct child pages.

A piece of content has different types of descendants, depending on its type:

  • page: descendant is page, whiteboard, database, embed, folder, comment, attachment
  • whiteboard: descendant is page, whiteboard, database, embed, folder, comment, attachment
  • database: descendant is page, whiteboard, database, embed, folder, comment, attachment
  • embed: descendant is page, whiteboard, database, embed, folder, comment, attachment
  • folder: descendant is page, whiteboard, database, embed, folder, comment, attachment
  • blogpost: descendant is comment, attachment
  • attachment: descendant is comment
  • comment: descendant is attachment

The map will always include all descendant types that are valid for the content. However, if the content has no instances of a descendant type, the map will contain an empty array for that descendant type.

Permissions required: 'View' permission for the space, and permission to view the content if it is a page.

get/wiki/rest/api/content/{id}/descendant

Request

  • Base URL
    https://your-domain.atlassian.net
  • URL
    https://your-domain.atlassian.net/wiki/rest/api/content/{id}/descendant
  • Auth
    • HTTP basic
    • or OAuth 2
      Authorization code: https://auth.atlassian.com/authorize
      Token URL: https://auth.atlassian.com/oauth/token scopes: read:confluence-content.summary

Path parameters

idstring required

The ID of the content to be queried for its descendants.

Query parameters

expandstring[]

A multi-value parameter indicating which properties of the children to expand, where:

  • attachment returns all attachments for the content.
  • comments returns all comments for the content.
  • page returns all child pages of the content.
  • whiteboard returns all child whiteboards of the content.
  • database returns all child databases of the content.
  • embed returns all child embeds of the content.
  • folder returns all child folders of the content.

Response

Returned if the requested descendants are returned.

_linksGenericLinks

Changes

No recorded changes to this operation across all 2 revisions of this API.