SchemaDesignerServices.GetSchemaOutOfSyncComponentEmbeds Method

SchemaDesignerServicesGetSchemaOutOfSyncComponentEmbeds Method

Ingeniux CMS Web Services API

Retrieves the out of sync component embed content, that were based on given Schema. Out of sync embed component are component embed content referring previous versions of the Schema

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

Syntax

C++

Copy

public XHRServiceResponseGeneric<SchemaOutOfSyncComponentEmbeds> GetSchemaOutOfSyncComponentEmbeds(
	SchemaOutOfSyncPagesGetInput data
)

Public Function GetSchemaOutOfSyncComponentEmbeds ( 
	data As SchemaOutOfSyncPagesGetInput
) As XHRServiceResponseGeneric(Of SchemaOutOfSyncComponentEmbeds)

public:
virtual XHRServiceResponseGeneric<SchemaOutOfSyncComponentEmbeds^>^ GetSchemaOutOfSyncComponentEmbeds(
	SchemaOutOfSyncPagesGetInput^ data
) sealed

abstract GetSchemaOutOfSyncComponentEmbeds : 
        data : SchemaOutOfSyncPagesGetInput -> XHRServiceResponseGeneric<SchemaOutOfSyncComponentEmbeds> 
override GetSchemaOutOfSyncComponentEmbeds : 
        data : SchemaOutOfSyncPagesGetInput -> XHRServiceResponseGeneric<SchemaOutOfSyncComponentEmbeds>

Parameters

data

Type: SchemaOutOfSyncPagesGetInput

Object containg the unique Id of the Schema

Examples

Sample JSON input

JavaScript

Copy

{
    "data": {
        "UniqueID": "schemas/194"
    }
}

Return Value

Type: XHRServiceResponseGenericSchemaOutOfSyncComponentEmbeds

Collection of Component Embed Content (Page Versions) that are using previous version of given Schema

Examples

Sample JSON return

JavaScript

Copy

{
    "ContentFreezeEndTime": "",
    "ContentFreezeStartTime": "",
    "code": 0,
    "error": null,
    "message": {
        "ComponentEmbeds": [{
            "ID": "x580-26506a8800fae4bb6a9e42d1f923b16b",
            "Name": "vvvv|x580",
            "CheckedOut": false,
            "FieldId": "26506a8800fae4bb6a9e42d1f923b16b",
            "FieldName": "Visual Form Builder - Form",
            "Icon": 2,
            "PageId": "x580",
            "SchemaVersion": 3,
            "Score": -1
        }, {
            "ID": "x694-26506a8800fae4bb6a9e42d1f923b16b",
            "Name": "2|x694",
            "CheckedOut": true,
            "FieldId": "26506a8800fae4bb6a9e42d1f923b16b",
            "FieldName": "Visual Form Builder - Form",
            "Icon": 2,
            "PageId": "x694",
            "SchemaVersion": 3,
            "Score": -1
        }, {
            "ID": "x695-26506a8800fae4bb6a9e42d1f923b16b",
            "Name": "3|x695",
            "CheckedOut": true,
            "FieldId": "26506a8800fae4bb6a9e42d1f923b16b",
            "FieldName": "Visual Form Builder - Form",
            "Icon": 2,
            "PageId": "x695",
            "SchemaVersion": 3,
            "Score": -1
        }]
    }
}

Remarks

If Schema doesn't exist, returns error status

Only Schemas not in draft mode are allowed to retrieve out of sync pages. If Schema is in draft mode, returns error status

Reference

SchemaDesignerServices Class

IngeniuxCMService Namespace