SchemaDesignerServices.SyncPagesToSchema Method

SchemaDesignerServicesSyncPagesToSchema Method

Ingeniux CMS Web Services API

Synchronizes specified Pages to the latest version of their Schema. This operations will update Pages based on the Schema, but adding and removing fields to match the new Schema version. It will not touch any element or attribute values of the Pages.

Namespace: IngeniuxCMService
Assembly: IngeniuxCMService (in IngeniuxCMService.dll) Version: 9.0.565.0 (9.0.565)

Syntax

C++

Copy

public XHRServiceResponseGeneric<SchemaPagesSyncResult> SyncPagesToSchema(
	SchemaSyncRequest data
)

Public Function SyncPagesToSchema ( 
	data As SchemaSyncRequest
) As XHRServiceResponseGeneric(Of SchemaPagesSyncResult)

public:
virtual XHRServiceResponseGeneric<SchemaPagesSyncResult^>^ SyncPagesToSchema(
	SchemaSyncRequest^ data
) sealed

abstract SyncPagesToSchema : 
        data : SchemaSyncRequest -> XHRServiceResponseGeneric<SchemaPagesSyncResult> 
override SyncPagesToSchema : 
        data : SchemaSyncRequest -> XHRServiceResponseGeneric<SchemaPagesSyncResult>

Parameters

data

Type: SchemaSyncRequest

Object containing Ids of the Pages to be synchronized

Examples

Sample JSON input

JavaScript

Copy

{
    "data": {
        "SchemaId": "Schemas/x97",
        "PageIDs": ["x9", "x10"]
    }
}

Return Value

Type: XHRServiceResponseGenericSchemaPagesSyncResult

Result of Synchronization

Examples

Sample JSON return

JavaScript

Copy

{
    "code": 0,
    "error": null,
    "message": {
        "ErrorPages": [],
        "SchemaRootName": "Details",
        "SchemaId": "Schemas/x97",
        "SuccessPageIDs": ["x10", "x9"]
    }
}

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.

Reference

SchemaDesignerServices Class

IngeniuxCMService Namespace