SchemaDesignerServicesSyncComponentEmbedsToSchema Method Ingeniux CMS Web Services API
Synchronizes specified Component Embeds to the latest version of their Schema. This operations will update the Pages the component embeds reside at, based on the component schemas, by adding and removing fields to match the new Schema version. It will leave all the presentation related fields in the component embeds alone.

Namespace: IngeniuxCMService
Assembly: IngeniuxCMService (in IngeniuxCMService.dll) Version: 9.0.565.0 (9.0.565)
Syntax
Copy
public XHRServiceResponseGeneric<SchemaComponentEmbedSyncResult> SyncComponentEmbedsToSchema(
	SchemaSyncComponentEmbedRequest data
)

Parameters

data
Type: SchemaSyncComponentEmbedRequest

Object containing Ids of the Pages, and the ids of the fields on the Page, to be synchronized

Examples
Sample JSON input
JavaScript
Copy
{
    "data": {
        "SchemaId": "schemas/VisualFormBuilderForm",
        "Pages": [{
            "PageID": "x580",
            "FieldID": "26506a8800fae4bb6a9e42d1f923b16b"
        }, {
            "PageID": "x694",
            "FieldID": "26506a8800fae4bb6a9e42d1f923b16b"
        }, {
            "PageID": "x695",
            "FieldID": "26506a8800fae4bb6a9e42d1f923b16b"
        }],
        "AllowImmediateCheckin": false
    }
}

Return Value

Type: XHRServiceResponseGenericSchemaComponentEmbedSyncResult

Result of Synchronization

Examples
Sample JSON return
JavaScript
Copy
{
    "ContentFreezeEndTime": "",
    "ContentFreezeStartTime": "",
    "code": 0,
    "error": null,
    "message": {
        "Errors": [],
        "SchemaId": "schemas\/VisualFormBuilderForm",
        "SchemaRootName": "FormBuilder_Form",
        "Successes": [{
            "FieldID": "26506a8800fae4bb6a9e42d1f923b16b",
            "ID": "x695-26506a8800fae4bb6a9e42d1f923b16b",
            "PageID": "x695"
        }, {
            "FieldID": "26506a8800fae4bb6a9e42d1f923b16b",
            "ID": "x694-26506a8800fae4bb6a9e42d1f923b16b",
            "PageID": "x694"
        }, {
            "FieldID": "26506a8800fae4bb6a9e42d1f923b16b",
            "ID": "x580-26506a8800fae4bb6a9e42d1f923b16b",
            "PageID": "x580"
        }]
    }
}
Remarks

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

During synchronization, site is locked to prevent any content changes. Site will be unlocked after synchronization is one.

See Also

Reference

SchemaDesignerServices Class
IngeniuxCMService Namespace