tridion-sites-extensions-api-docs

Home > @tridion-sites/open-api-client > SearchService > searchInContainer

SearchService.searchInContainer() method

Searches within an individual item for a specified text string. 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>Batch</li><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>Group</li><li>Keyword</li><li>MultimediaType</li><li>Page</li><li>PageTemplate</li><li>ProcessHistory</li><li>ProcessInstance</li><li>Publication</li><li>PublishTransaction</li><li>Schema</li><li>SearchFolder</li><li>StructureGroup</li><li>TargetGroup</li><li>TargetType</li><li>TemplateBuildingBlock</li><li>TridionActivityDefinition</li><li>TridionProcessDefinition</li><li>User</li><li>WorkItem</li></ul>

Signature:

static searchInContainer({ escapedItemId, fullTextQuery, itemTypes, resultLimit, }: {
        escapedItemId: string;
        fullTextQuery: string;
        itemTypes?: Array<any>;
        resultLimit?: number;
    }): CancelablePromise<Array<IdentifiableObject>>;

Parameters

Parameter	Type	Description
{ escapedItemId, fullTextQuery, itemTypes, resultLimit, }	{ escapedItemId: string; fullTextQuery: string; itemTypes?: Array<any>; resultLimit?: number; }

Returns:

CancelablePromise<Array<IdentifiableObject>>

IdentifiableObject The request was successful.

Exceptions

ApiError