tridion-sites-extensions-api-docs

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

ListsService.getLockedItems() method

Gets a list of locked items (either versioned items or organizational items). 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><li>TridionProcessDefinition</li></ul>

Signature:

static getLockedItems({ forAllUsers, lockUserId, lockFilter, lockResult, maxResults, }: {
        forAllUsers?: boolean;
        lockUserId?: string;
        lockFilter?: Array<any>;
        lockResult?: Array<any>;
        maxResults?: number;
    }): CancelablePromise<Array<RepositoryLocalObject>>;

Parameters

Parameter	Type	Description
{ forAllUsers, lockUserId, lockFilter, lockResult, maxResults, }	{ forAllUsers?: boolean; lockUserId?: string; lockFilter?: Array<any>; lockResult?: Array<any>; maxResults?: number; }

Returns:

CancelablePromise<Array<RepositoryLocalObject>>

RepositoryLocalObject The request was successful.

Exceptions

ApiError