Confluence.js - Cloud and Server API library
    Preparing search index...

    Interface GetDescendantsOfType

    interface GetDescendantsOfType {
        depth?: string;
        expand?: OneOrMany<string>;
        id: string;
        limit?: number;
        start?: number;
        type: string;
    }
    Index

    Properties

    depth? expand? id limit? start? type

    Properties

    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.

    expand?: OneOrMany<string>
    id: string

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

    limit?: number

    The maximum number of content to return per page. Note, this may be restricted by fixed system limits.

    start?: number

    The starting index of the returned content.

    type: string

    The type of descendants to return.

    Settings

    Member Visibility

    On This Page

    Properties