tridion-sites-extensions-api-docs

Home > @tridion-sites/open-api-client > ListsService > getOrganizationalStructureTree

ListsService.getOrganizationalStructureTree() method

Warning: This API is now obsolete.

Gets an (expanded) tree representation of all the items in the path of a RepositoryLocalObject. This operation returns an instance of ‘TreeNode’ type.

Signature:

static getOrganizationalStructureTree({ escapedItemId, includeAllPublications, includeChildrenOnEveryLevel, groupCategoriesAndKeywords, groupBusinessProcessTypes, useDynamicVersion, }: {
        escapedItemId: string;
        includeAllPublications?: boolean;
        includeChildrenOnEveryLevel?: boolean;
        groupCategoriesAndKeywords?: boolean;
        groupBusinessProcessTypes?: boolean;
        useDynamicVersion?: boolean;
    }): CancelablePromise<TreeNode>;

Parameters

Parameter	Type	Description
{ escapedItemId, includeAllPublications, includeChildrenOnEveryLevel, groupCategoriesAndKeywords, groupBusinessProcessTypes, useDynamicVersion, }	{ escapedItemId: string; includeAllPublications?: boolean; includeChildrenOnEveryLevel?: boolean; groupCategoriesAndKeywords?: boolean; groupBusinessProcessTypes?: boolean; useDynamicVersion?: boolean; }

Returns:

CancelablePromise<TreeNode>

TreeNode The request was successful.

Exceptions

ApiError