Click or drag to resize

SchemaDesignerServicesSyncComponentUnitsToSchema Method


Synchronizes specified Component content units' component embeds to the latest version of their Schema. This operations will update the Content units the component embeds reside at, based on the component schemas, by adding and removing fields to match the new Schema version.

Namespace: IngeniuxCMService
Assembly: IngeniuxCMService (in IngeniuxCMService.dll) Version: 10.6.492
Syntax
public XHRServiceResponseGeneric<SchemaComponentUnitSyncResult> SyncComponentUnitsToSchema(
	SchemaSyncComponentUnitRequest data
)

Parameters

data  SchemaSyncComponentUnitRequest

Object containing Ids of the Component Units to be synchronized

Example
Sample JSON input
JavaScript
{
    "data": {
        "SchemaId": "schemas/VisualFormBuilderForm",
        "Pages": [{
            "UnitID": "ComponentContentUnits/225"
        }, {
            "UnitID": "ComponentContentUnits/VisualFormBuilderForm"
        }]
    }
}

Return Value

XHRServiceResponseGenericSchemaComponentUnitSyncResult

Result of Synchronization

Example
Sample JSON return
JavaScript
{
    "ContentFreezeEndTime": "",
    "ContentFreezeStartTime": "",
    "code": 0,
    "error": null,
    "message": {
        "Errors": [],
        "SchemaId": "schemas\/VisualFormBuilderForm",
        "SchemaRootName": "FormBuilder_Form",
        "Successes": [{
            "UnitID": "ComponentContentUnits\/VisualFormBuilderForm"
        }, {
            "UnitID": "ComponentContentUnits\/225"
        }]
    }
}
Remarks

If Schema with given Id doesn't exist, returns error status

See Also