IndexingSearchServicesGetSchemas Method

Ingeniux CMS Web Services API

Retrieves the site schemas collection. This method will return schemas and their list of fields. It's purpose is to provide the schemas/fields listing for advance search selection.

Namespace:  IngeniuxCMService
Assembly:  IngeniuxCMService (in IngeniuxCMService.dll) Version: 10.3.70
Syntax

public XHRServiceResponseGeneric<SchemaRepresentation[]> GetSchemas(
	bool includePages = true,
	bool includeAssets = true
)

Parameters

includePages (Optional)
Type: SystemBoolean
Specifies whether to include assets in search result
includeAssets (Optional)
Type: SystemBoolean
Specifies whether to include pages in search result

Return Value

Type: XHRServiceResponseGenericSchemaRepresentation

The collection of schemas and the fields of each schema

Examples

Sample JSON return
JavaScript
{
    "code": 0,
    "error": null,
    "message": [{
        "Fields": [],
        "FriendlyName": "Folder",
        "Id": "Schema_Folder",
        "RootElementName": "Folder"
    }, {
        "Fields": [{
            "IsAttribute": false,
            "Label": "",
            "Name": "File"
        }, {
            "IsAttribute": false,
            "Label": "",
            "Name": "Thumbnail"
        }, {
            "IsAttribute": false,
            "Label": "",
            "Name": "Height"
        }, {
            "IsAttribute": false,
            "Label": "",
            "Name": "Width"
        }, {
            "IsAttribute": false,
            "Label": "",
            "Name": "AlternateText"
        }, {
            "IsAttribute": false,
            "Label": "",
            "Name": "Alignment"
        }, {
            "IsAttribute": false,
            "Label": "",
            "Name": "Border"
        }, {
            "IsAttribute": false,
            "Label": "",
            "Name": "HSpace"
        }, {
            "IsAttribute": false,
            "Label": "",
            "Name": "VSpace"
        }, {
            "IsAttribute": false,
            "Label": "",
            "Name": "UseMap"
        }, {
            "IsAttribute": false,
            "Label": "",
            "Name": "HREF"
        }, {
            "IsAttribute": false,
            "Label": "",
            "Name": "Target"
        }, {
            "IsAttribute": false,
            "Label": "",
            "Name": "Keywords"
        }],
        "FriendlyName": "Image File",
        "Id": "Schema_Image",
        "RootElementName": "Image"
    }, {
        "Fields": [{
            "IsAttribute": false,
            "Label": "",
            "Name": "File"
        }, {
            "IsAttribute": false,
            "Label": "",
            "Name": "URL"
        }, {
            "IsAttribute": false,
            "Label": "",
            "Name": "Description"
        }],
        "FriendlyName": "Media File",
        "Id": "Schema_Media",
        "RootElementName": "Media"
    }, {
        "Fields": [{
            "IsAttribute": false,
            "Label": "",
            "Name": "xpower"
        }, {
            "IsAttribute": false,
            "Label": "",
            "Name": "Type"
        }, {
            "IsAttribute": false,
            "Label": "Start Page",
            "Name": "StartPage"
        }, {
            "IsAttribute": false,
            "Label": "Maximum Depth",
            "Name": "MaxDepth"
        }, {
            "IsAttribute": false,
            "Label": "Maximum Nodes",
            "Name": "MaxNodes"
        }, {
            "IsAttribute": false,
            "Label": "Generation Order",
            "Name": "GenerationOrder"
        }, {
            "IsAttribute": false,
            "Label": "",
            "Name": "Navigation"
        }, {
            "IsAttribute": false,
            "Label": "",
            "Name": "Exports"
        }],
        "FriendlyName": "Navigation",
        "Id": "Schema_Navigation",
        "RootElementName": "Navigation"
    }]
}
See Also

Reference