tridion-sites-extensions-api-docs

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

ListsService.getUsedBy() method

Gets a list of items that use a specified item. This operation returns an instance of ‘IdentifiableObject’ type, as implemented by one of the following:<ul class="model-list"><li>ActivityHistory</li><li>ActivityInstance</li><li>ApprovalStatus</li><li>Bundle</li><li>BusinessProcessType</li><li>Category</li><li>Component</li><li>ComponentTemplate</li><li>ExternalCategory</li><li>ExternalComponent</li><li>ExternalKeyword</li><li>Folder</li><li>Keyword</li><li>MultimediaType</li><li>Page</li><li>PageTemplate</li><li>Publication</li><li>Schema</li><li>SearchFolder</li><li>StructureGroup</li><li>TargetGroup</li><li>TargetType</li><li>TemplateBuildingBlock</li><li>TridionProcessDefinition</li></ul>

Signature:

static getUsedBy({ escapedItemId, onlyLatestVersions, useDynamicVersion, includeLocalCopies, details, }: {
        escapedItemId: string;
        onlyLatestVersions?: boolean;
        useDynamicVersion?: boolean;
        includeLocalCopies?: boolean;
        details?: 'IdAndTitleOnly' | 'WithApplicableActions' | 'Contentless';
    }): CancelablePromise<Array<IdentifiableObject>>;

Parameters

Parameter	Type	Description
{ escapedItemId, onlyLatestVersions, useDynamicVersion, includeLocalCopies, details, }	{ escapedItemId: string; onlyLatestVersions?: boolean; useDynamicVersion?: boolean; includeLocalCopies?: boolean; details?: ‘IdAndTitleOnly’ | ‘WithApplicableActions’ | ‘Contentless’; }

Returns:

CancelablePromise<Array<IdentifiableObject>>

IdentifiableObject The request was successful.

Exceptions

ApiError