SchemaDesignerServices.GetSchemaChangeEffortsForComponentEmbeds Method

SchemaDesignerServicesGetSchemaChangeEffortsForComponentEmbeds Method

Ingeniux CMS Web Services API

Get the change efforts for given Component embeds to be updated based the latest version of their Schema. Change efforts are used to measure the differences between Component Embed content and its latest version Schema content.

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

Syntax

C++

Copy

public XHRServiceResponseGeneric<SchemaChangeEffortAnalysisResponse> GetSchemaChangeEffortsForComponentEmbeds(
	SchemaChangeEffortAnalysisRequest data
)

Public Function GetSchemaChangeEffortsForComponentEmbeds ( 
	data As SchemaChangeEffortAnalysisRequest
) As XHRServiceResponseGeneric(Of SchemaChangeEffortAnalysisResponse)

public:
virtual XHRServiceResponseGeneric<SchemaChangeEffortAnalysisResponse^>^ GetSchemaChangeEffortsForComponentEmbeds(
	SchemaChangeEffortAnalysisRequest^ data
) sealed

abstract GetSchemaChangeEffortsForComponentEmbeds : 
        data : SchemaChangeEffortAnalysisRequest -> XHRServiceResponseGeneric<SchemaChangeEffortAnalysisResponse> 
override GetSchemaChangeEffortsForComponentEmbeds : 
        data : SchemaChangeEffortAnalysisRequest -> XHRServiceResponseGeneric<SchemaChangeEffortAnalysisResponse>

Parameters

data

Type: SchemaChangeEffortAnalysisRequest

Information of the Schema and the collection of Pages to analyze change efforts on

Examples

Sample JSON input

JavaScript

Copy

{
    "data": {
        "SchemaId": "schemas/VisualFormBuilderForm",
        "Pages": [ {
            "ID": "x611-a8b7c003c52d6696afd06a6ae92f817a",
            "CheckedOut": true
        }, {
            "ID": "x611-5389e1643a2e0c4620bf64cb870c9ba6",
            "CheckedOut": false
        }, {
            "ID": "x614-5389e1643a2e0c4620bf64cb870c9ba6",
            "CheckedOut": true
        }]
    }
}

Return Value

Type: XHRServiceResponseGenericSchemaChangeEffortAnalysisResponse

Information of change effort scores calculated for all Component Embed content provided

Examples

Sample JSON return

JavaScript

Copy

{
    "code": 0,
    "error": null,
    "message": {
        "ChangeEfforts": [{
            "PageID": "x611-a8b7c003c52d6696afd06a6ae92f817a",
            "Score": 2
        }, {
            "PageID": "x611-5389e1643a2e0c4620bf64cb870c9ba6",
            "Score": 3
        }, {
            "PageID": "x614-5389e1643a2e0c4620bf64cb870c9ba6",
            "Score": 1
        }],
        "SchemaId": "schemas/VisualFormBuilderForm"
    }
}

Reference

SchemaDesignerServices Class

IngeniuxCMService Namespace