tridion-sites-extensions-api-docs

Home > @tridion-sites/open-api-client > ClassificationService > getClassifiedItems

ClassificationService.getClassifiedItems() method

Gets a list of all items that are classified with a specified Keyword (internal) or Concept (external). This operation returns an instance of ‘RepositoryLocalObject’ type, as implemented by one of the following:<ul class="model-list"><li>Bundle</li><li>BusinessProcessType</li><li>Category</li><li>Component</li><li>ComponentTemplate</li><li>ExternalCategory</li><li>ExternalComponent</li><li>ExternalContainer</li><li>ExternalKeyword</li><li>Folder</li><li>Keyword</li><li>Page</li><li>PageTemplate</li><li>ResolvedBundle</li><li>Schema</li><li>SearchFolder</li><li>StructureGroup</li><li>TargetGroup</li><li>TemplateBuildingBlock</li></ul>

Signature:

static getClassifiedItems({ escapedKeywordId, useDynamicVersion, rloItemTypes, resolveDescendantKeywords, resultLimit, }: {
        escapedKeywordId: string;
        useDynamicVersion?: boolean;
        rloItemTypes?: Array<any>;
        resolveDescendantKeywords?: boolean;
        resultLimit?: number;
    }): CancelablePromise<Array<RepositoryLocalObject>>;

Parameters

Parameter	Type	Description
{ escapedKeywordId, useDynamicVersion, rloItemTypes, resolveDescendantKeywords, resultLimit, }	{ escapedKeywordId: string; useDynamicVersion?: boolean; rloItemTypes?: Array<any>; resolveDescendantKeywords?: boolean; resultLimit?: number; }

Returns:

CancelablePromise<Array<RepositoryLocalObject>>

RepositoryLocalObject The request was successful.

Exceptions

ApiError