SchemaDesignerServicesSyncComponentUnitsToSchema Method Ingeniux CMS Web Services API
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: 9.0.565.0 (9.0.565)
Syntax
Copy
public XHRServiceResponseGeneric<SchemaComponentUnitSyncResult> SyncComponentUnitsToSchema(
	SchemaSyncComponentUnitRequest data
)

Parameters

data
Type: SchemaSyncComponentUnitRequest

Object containing Ids of the Component Units to be synchronized

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

Return Value

Type: XHRServiceResponseGenericSchemaComponentUnitSyncResult

Result of Synchronization

Examples
Sample JSON return
JavaScript
Copy
{
    "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

Reference

SchemaDesignerServices Class
IngeniuxCMService Namespace