tridion-sites-extensions-api-docs

Home > @tridion-sites/open-api-client > SchemasService > synchronizeWithSchema

SchemasService.synchronizeWithSchema() method

Synchronizes the content and metadata of a given model with its Schema. The operation returns the synchronized model and the synchronization actions that were applied. This operation returns an instance of ‘SynchronizationResult’ type.

Using this operation will not persist the changes made through synchronization.

Signature:

static synchronizeWithSchema({ requestModel, flags, }: {
        requestModel: IdentifiableObject;
        flags?: Array<any>;
    }): CancelablePromise<SynchronizationResult>;

Parameters

Parameter	Type	Description
{ requestModel, flags, }	{ requestModel: IdentifiableObject; flags?: Array<any>; }

Returns:

CancelablePromise<SynchronizationResult>

SynchronizationResult The request was successful.

Exceptions

ApiError