Click or drag to resize

SchemaDesignerServicesGetFavoriteSchemaFields Method

Retrieves the collection of Schema Field Favorites. Favorites are collection Fields with information of each Field already populated. The purpose of favorites is to place a group of fields that are used often across Schemas conveniently.

Namespace:  IngeniuxCMService
Assembly:  IngeniuxCMService (in IngeniuxCMService.dll) Version: 10.3.169
Syntax
Copy
public XHRServiceResponseGeneric<SchemaFavoriteEntry[]> GetFavoriteSchemaFields()

Return Value

Type: XHRServiceResponseGenericSchemaFavoriteEntry

Collection of Schema Field Favorites

Examples
Sample JSON return
JavaScript
Copy
{
    "code": 0,
    "error": null,
    "message": [{
        "Creator": "INGENIUX\\awang",
        "Fields": [{
            "ChildElementLabel": "",
            "ChildElementName": "",
            "ChildElementTypeID": "",
            "ChildProperties": [],
            "DefaultValue": "",
            "Exports": null,
            "HasExports": true,
            "HelpText": "",
            "Hidden": false,
            "IconName": "link16",
            "IsXpower": true,
            "Label": "Site Control",
            "Name": "SiteControl",
            "Properties": [{
                "ChoicesValue": "",
                "Label": "Expanded by Default",
                "Name": "Expanded",
                "Type": "boolean",
                "Value": ""
            }, {
                "ChoicesValue": ";external;document",
                "Label": "Link",
                "Name": "Link",
                "Type": "enumeration",
                "Value": ""
            }, {
                "ChoicesValue": "",
                "Label": "Link Text",
                "Name": "LinkText",
                "Type": "",
                "Value": ""
            }, {
                "ChoicesValue": "",
                "Label": "",
                "Name": "URL",
                "Type": "",
                "Value": ""
            }, {
                "ChoicesValue": ";_blank;_self;_parent",
                "Label": "Target",
                "Name": "Target",
                "Type": "enumeration",
                "Value": ""
            }],
            "Readonly": false,
            "Required": false,
            "TypeID": 6,
            "TypeLabel": "Link",
            "TypeName": "Link"
        }],
        "ID": "SchemaFieldFavorites\/1",
        "IsPublic": false,
        "Name": "Site Control"
    }, {
        "Creator": "INGENIUX\\awang",
        "Fields": [{
            "ChildElementLabel": "",
            "ChildElementName": "",
            "ChildElementTypeID": "",
            "ChildProperties": [],
            "DefaultValue": "",
            "Exports": null,
            "HasExports": true,
            "HelpText": "",
            "Hidden": false,
            "IconName": "link16",
            "IsXpower": true,
            "Label": "Site Control",
            "Name": "SiteControl",
            "Properties": [{
                "ChoicesValue": "",
                "Label": "Expanded by Default",
                "Name": "Expanded",
                "Type": "boolean",
                "Value": ""
            }, {
                "ChoicesValue": ";external;document",
                "Label": "Link",
                "Name": "Link",
                "Type": "enumeration",
                "Value": ""
            }, {
                "ChoicesValue": "",
                "Label": "Link Text",
                "Name": "LinkText",
                "Type": "",
                "Value": ""
            }, {
                "ChoicesValue": "",
                "Label": "",
                "Name": "URL",
                "Type": "",
                "Value": ""
            }, {
                "ChoicesValue": ";_blank;_self;_parent",
                "Label": "Target",
                "Name": "Target",
                "Type": "enumeration",
                "Value": ""
            }],
            "Readonly": false,
            "Required": false,
            "TypeID": 6,
            "TypeLabel": "Link",
            "TypeName": "Link"
        }],
        "ID": "SchemaFieldFavorites\/2",
        "IsPublic": false,
        "Name": "SC"
    }, {
        "Creator": "INGENIUX\\awang",
        "Fields": [{
            "ChildElementLabel": "",
            "ChildElementName": "",
            "ChildElementTypeID": "",
            "ChildProperties": [],
            "DefaultValue": "",
            "Exports": null,
            "HasExports": false,
            "HelpText": "",
            "Hidden": false,
            "IconName": "group16",
            "IsXpower": true,
            "Label": "Server Authentication",
            "Name": "ServerAuthentication",
            "Properties": [{
                "ChoicesValue": "",
                "Label": "Expanded by Default",
                "Name": "Expanded",
                "Type": "boolean",
                "Value": "false"
            }, {
                "ChoicesValue": "",
                "Label": "Grouped in Expanded Xml",
                "Name": "Enclosed",
                "Type": "boolean",
                "Value": "false"
            }, {
                "ChoicesValue": "",
                "Label": "Allow changing Xml Grouping",
                "Name": "AllowEnclosureChange",
                "Type": "boolean",
                "Value": "false"
            }],
            "Readonly": false,
            "Required": false,
            "TypeID": 15,
            "TypeLabel": "Group Start",
            "TypeName": "GroupStart"
        }, {
            "ChildElementLabel": "",
            "ChildElementName": "",
            "ChildElementTypeID": "",
            "ChildProperties": [],
            "DefaultValue": "false",
            "Exports": null,
            "HasExports": false,
            "HelpText": "",
            "Hidden": false,
            "IconName": "check16",
            "IsXpower": false,
            "Label": "Server Requires Authentication",
            "Name": "ServerAuth",
            "Properties": [],
            "Readonly": false,
            "Required": false,
            "TypeID": 9,
            "TypeLabel": "Checkbox",
            "TypeName": "Checkbox"
        }, {
            "ChildElementLabel": "",
            "ChildElementName": "",
            "ChildElementTypeID": "",
            "ChildProperties": [],
            "DefaultValue": "",
            "Exports": null,
            "HasExports": false,
            "HelpText": "",
            "Hidden": false,
            "IconName": "document16",
            "IsXpower": false,
            "Label": "Server Login User Name",
            "Name": "Username",
            "Properties": [],
            "Readonly": false,
            "Required": false,
            "TypeID": 2,
            "TypeLabel": "Plain Text",
            "TypeName": "Text Element"
        }, {
            "ChildElementLabel": "",
            "ChildElementName": "",
            "ChildElementTypeID": "",
            "ChildProperties": [],
            "DefaultValue": "",
            "Exports": null,
            "HasExports": false,
            "HelpText": "",
            "Hidden": false,
            "IconName": "document16",
            "IsXpower": false,
            "Label": "Server Login Password",
            "Name": "Password",
            "Properties": [],
            "Readonly": false,
            "Required": false,
            "TypeID": 2,
            "TypeLabel": "Plain Text",
            "TypeName": "Text Element"
        }, {
            "ChildElementLabel": "",
            "ChildElementName": "",
            "ChildElementTypeID": "",
            "ChildProperties": [],
            "DefaultValue": "",
            "Exports": null,
            "HasExports": false,
            "HelpText": "",
            "Hidden": false,
            "IconName": "document16",
            "IsXpower": false,
            "Label": "Login User Domain",
            "Name": "Domain",
            "Properties": [],
            "Readonly": false,
            "Required": false,
            "TypeID": 2,
            "TypeLabel": "Plain Text",
            "TypeName": "Text Element"
        }, {
            "ChildElementLabel": "",
            "ChildElementName": "",
            "ChildElementTypeID": "",
            "ChildProperties": [],
            "DefaultValue": "",
            "Exports": null,
            "HasExports": false,
            "HelpText": null,
            "Hidden": false,
            "IconName": "group16",
            "IsXpower": true,
            "Label": "GroupEnd",
            "Name": null,
            "Properties": [],
            "Readonly": false,
            "Required": false,
            "TypeID": 16,
            "TypeLabel": "Group End",
            "TypeName": "GroupEnd"
        }],
        "ID": "SchemaFieldFavorites\/33",
        "IsPublic": false,
        "Name": "Server Auth"
    }]
}
See Also