tridion-sites-extensions-api-docs

Home > @tridion-sites/open-api-client > OrganizationalItemsService > getItemsPageFromContainer

OrganizationalItemsService.getItemsPageFromContainer() method

Gets a paged list of items inside a specified container item (Publication or Organizational Item). This operation returns an instance of ‘PageOfItems’ type.

Signature:

static getItemsPageFromContainer({ escapedContainerId, pageIndex, pageSize, useDynamicVersion, rloItemTypes, recursive, details, }: {
        escapedContainerId: string;
        pageIndex: number;
        pageSize?: number;
        useDynamicVersion?: boolean;
        rloItemTypes?: Array<any>;
        recursive?: boolean;
        details?: 'IdAndTitleOnly' | 'WithApplicableActions' | 'Contentless';
    }): CancelablePromise<PageOfItems>;

Parameters

Parameter	Type	Description
{ escapedContainerId, pageIndex, pageSize, useDynamicVersion, rloItemTypes, recursive, details, }	{ escapedContainerId: string; pageIndex: number; pageSize?: number; useDynamicVersion?: boolean; rloItemTypes?: Array<any>; recursive?: boolean; details?: ‘IdAndTitleOnly’ | ‘WithApplicableActions’ | ‘Contentless’; }

Returns:

CancelablePromise<PageOfItems>

PageOfItems The request was successful.

Exceptions

ApiError