tridion-sites-extensions-api-docs

Home > @tridion-sites/open-api-client > VersioningService > checkOut

VersioningService.checkOut() method

Checks out a versioned item to create a new, editable version of the item. The new version is locked for editing by the user who performed the checkout. No other user can edit the item while it is checked out. This operation returns an instance of ‘VersionedItem’ type, as implemented by one of the following:<ul class="model-list"><li>Component</li><li>ComponentTemplate</li><li>ExternalComponent</li><li>Page</li><li>PageTemplate</li><li>Schema</li><li>TemplateBuildingBlock</li></ul>

Signature:

static checkOut({ escapedVersionedItemId, requestModel, }: {
        escapedVersionedItemId: string;
        requestModel: CheckOutRequest;
    }): CancelablePromise<VersionedItem>;

Parameters

Parameter	Type	Description
{ escapedVersionedItemId, requestModel, }	{ escapedVersionedItemId: string; requestModel: CheckOutRequest; }

Returns:

CancelablePromise<VersionedItem>

VersionedItem The request was successful.

Exceptions

ApiError