Function: getDescendantsOfType()
ts
function getDescendantsOfType(client, parameters): Promise<ContentArray>;Defined in: src/v1/api/contentChildrenAndDescendants.ts:99
Returns all descendants of a given type, for a piece of content. This is similar to Get content children by type, 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 ispage,whiteboard,database,embed,folder,comment,attachmentwhiteboard: descendant ispage,whiteboard,database,embed,folder,comment,attachmentdatabase: descendant ispage,whiteboard,database,embed,folder,comment,attachmentembed: descendant ispage,whiteboard,database,embed,folder,comment,attachmentfolder: descendant ispage,whiteboard,database,embed,folder,comment,attachmentblogpost: descendant iscomment,attachmentattachment: descendant iscommentcomment: descendant isattachment
Custom content types that are provided by apps can also be returned.
If the expand query parameter is used with the body.export_view and/or body.styled_view properties, then the query limit parameter will be restricted to a maximum value of 25.
Permissions required: 'View' permission for the space, and permission to view the content if it is a page.
Parameters
| Parameter | Type | Description |
|---|---|---|
client | Client | - |
parameters | { depth?: string; expand?: string[]; id: string; limit?: number; start?: number; type: "attachment" | "page" | "comment"; } | - |
parameters.depth? | string | Filter the results to descendants upto a desired level of the content. Note, the maximum value supported is 100. root level of the content means immediate (level 1) descendants of the type requested. all represents returning all descendants of the type requested. |
parameters.expand? | string[] | A multi-value parameter indicating which properties of the content to expand. - childTypes.all returns whether the content has attachments, comments, or child pages/whiteboards. Use this if you only need to check whether the content has children of a particular type. - childTypes.attachment returns whether the content has attachments. - childTypes.comment returns whether the content has comments. - childTypes.page returns whether the content has child pages. - childTypes.whiteboard returns whether the content has child whiteboards. - childTypes.database returns whether the content has child databases. - childTypes.embed returns whether the content has child embeds (smartlinks). - childTypes.folder returns whether the content has child folders. - container returns the space that the content is in. This is the same as the information returned by Get space. - metadata.currentuser returns information about the current user in relation to the content, including when they last viewed it, modified it, contributed to it, or added it as a favorite. - metadata.properties returns content properties that have been set via the Confluence REST API. - metadata.labels returns the labels that have been added to the content. - metadata.frontend this property is only used by Atlassian. - operations returns the operations for the content, which are used when setting permissions. - children.page returns pages that are descendants at the level immediately below the content. - children.whiteboard returns whiteboards that are descendants at the level immediately below the content. - children.database returns databases that are descendants at the level immediately below the content. - children.embed returns embeds (smartlinks) that are descendants at the level immediately below the content. - children.folder returns folders that are descendants at the level immediately below the content. - children.attachment returns all attachments for the content. - children.comment returns all comments on the content. - restrictions.read.restrictions.user returns the users that have permission to read the content. - restrictions.read.restrictions.group returns the groups that have permission to read the content. Note that this may return deleted groups, because deleting a group doesn't remove associated restrictions. - restrictions.update.restrictions.user returns the users that have permission to update the content. - restrictions.update.restrictions.group returns the groups that have permission to update the content. Note that this may return deleted groups because deleting a group doesn't remove associated restrictions. - history returns the history of the content, including the date it was created. - history.lastUpdated returns information about the most recent update of the content, including who updated it and when it was updated. - history.previousVersion returns information about the update prior to the current content update. - history.contributors returns all of the users who have contributed to the content. - history.nextVersion returns information about the update after to the current content update. - ancestors returns the parent content, if the content is a page or whiteboard. - body returns the body of the content in different formats, including the editor format, view format, and export format. - body.storage returns the body of content in storage format. - body.view returns the body of content in view format. - version returns information about the most recent update of the content, including who updated it and when it was updated. - descendants.page returns pages that are descendants at any level below the content. - descendants.whiteboard returns whiteboards that are descendants at any level below the content. - descendants.database returns databases that are descendants at any level below the content. - descendants.embed returns embeds (smartlinks) that are descendants at any level below the content. - descendants.folder returns folders that are descendants at any level below the content. - descendants.attachment returns all attachments for the content, same as children.attachment. - descendants.comment returns all comments on the content, same as children.comment. - space returns the space that the content is in. This is the same as the information returned by Get space. In addition, the following comment-specific expansions can be used: - extensions.inlineProperties returns inline comment-specific properties. - extensions.resolution returns the resolution status of each comment. |
parameters.id | string | The ID of the content to be queried for its descendants. |
parameters.limit? | number | The maximum number of content to return per page. Note, this may be restricted by fixed system limits. |
parameters.start? | number | The starting index of the returned content. |
parameters.type | "attachment" | "page" | "comment" | The type of descendants to return. |
Returns
Promise<ContentArray>