Click or drag to resize

GlobalConfigurationsServicesGetHelpText Method
Retrieves the help text index for fields of given schema, or all schemas

Namespace: IngeniuxCMService
Assembly: IngeniuxCMService (in IngeniuxCMService.dll) Version: 10.6.492
Syntax
Copy
public XHRServiceResponseGeneric<SchemaHelpResult> GetHelpText(
	string schemaName
)

Parameters

schemaName  String

Root name of schema. If left empty, will retrieve help text for all field from all schemas

Return Value

XHRServiceResponseGenericSchemaHelpResult

Help text index

Example
Sample JSON return
JavaScript
Copy
{
    "code": 0,
    "error": null,
    "message": [{
        "Key": "Folder",
        "Value": {
            "attributes": [],
            "elements": [],
            "schemaName": "Folder"
        }
    }, {
        "Key": "Image",
        "Value": {
            "attributes": [],
            "elements": [{
                "Key": "File",
                "Value": ""
            }, {
                "Key": "Thumbnail",
                "Value": ""
            }, {
                "Key": "Height",
                "Value": ""
            }, {
                "Key": "Width",
                "Value": ""
            }, {
                "Key": "AlternateText",
                "Value": ""
            }, {
                "Key": "Alignment",
                "Value": ""
            }, {
                "Key": "Border",
                "Value": ""
            }, {
                "Key": "HSpace",
                "Value": ""
            }, {
                "Key": "VSpace",
                "Value": ""
            }, {
                "Key": "UseMap",
                "Value": ""
            }, {
                "Key": "HREF",
                "Value": ""
            }, {
                "Key": "Target",
                "Value": ""
            }, {
                "Key": "Keywords",
                "Value": ""
            }],
            "schemaName": "Image"
        }
    }, {
        "Key": "Media",
        "Value": {
            "attributes": [],
            "elements": [{
                "Key": "File",
                "Value": ""
            }, {
                "Key": "URL",
                "Value": ""
            }, {
                "Key": "Description",
                "Value": ""
            }],
            "schemaName": "Media"
        }
    }, {
        "Key": "Navigation",
        "Value": {
            "attributes": [],
            "elements": [{
                "Key": "xpower",
                "Value": ""
            }, {
                "Key": "Type",
                "Value": ""
            }, {
                "Key": "StartPage",
                "Value": ""
            }, {
                "Key": "MaxDepth",
                "Value": ""
            }, {
                "Key": "MaxNodes",
                "Value": ""
            }, {
                "Key": "GenerationOrder",
                "Value": ""
            }, {
                "Key": "Navigation",
                "Value": ""
            }, {
                "Key": "Exports",
                "Value": ""
            }],
            "schemaName": "Navigation"
        }
    }, {
        "Key": "Home",
        "Value": {
            "attributes": [],
            "elements": [{
                "Key": "Title",
                "Value": "网页标题"
            }, {
                "Key": "BodyCopy",
                "Value": "主要内容"
            }, {
                "Key": "FeatureImage",
                "Value": "头条图片"
            }, {
                "Key": "SiteControl",
                "Value": "网站通用内容"
            }],
            "schemaName": "Home"
        }
    }, {
        "Key": "BinaryDocument",
        "Value": {
            "attributes": [],
            "elements": [{
                "Key": "DocumentURL",
                "Value": ""
            }, {
                "Key": "Description",
                "Value": "Description of the binary file"
            }, {
                "Key": "ContentType",
                "Value": "Mime type of the binary file"
            }, {
                "Key": "Keywords",
                "Value": "Keywords of the binary file for search purpose"
            }, {
                "Key": "ContentHash",
                "Value": ""
            }],
            "schemaName": "BinaryDocument"
        }
    }]
}
Remarks

If there are translations for schemas, the help text will be the translated help text for given schemas, instead of their original help text.

See Also