SiteTreeServicesRecurseToPage Method

Ingeniux CMS Web Services API

Retrieves the entire ancestors collection to the given Page, starting from the Content Store. Each ancestor entry contains its children entries.

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

public XHRServiceResponseGeneric<SiteTreeRecurseNodeInformation[]> RecurseToPage(
	string pageId,
	string pubTarget
)

Parameters

pageId
Type: SystemString
Id of the Page to recurse to
pubTarget
Type: SystemString
Id of the current Publishing Target, optional

Return Value

Type: XHRServiceResponseGenericSiteTreeRecurseNodeInformation

The array of ancestors entries, each contains the children Pages listing

Examples

Sample JSON return
JavaScript
{
    "code": 0,
    "error": null,
    "message": [{
        "children": [{
            "name": "Site",
            "isFolder": true,
            "objectId": "x2",
            "props": {
                "name": "Site",
                "allowedCategoryRoots": [],
                "ancestors": ["x1"],
                "assignedGroup": null,
                "assignedUser": {
                    "name": "Turtle Master",
                    "email": "awang@ingeniux.com",
                    "userId": "INGENIUX\\awang"
                },
                "canClaimPage": false,
                "canTranslate": false,
                "checkedOut": true,
                "error": null,
                "icon": 1,
                "isAssignedToOtherUser": false,
                "isEditable": true,
                "isInWorkflow": false,
                "justRecycled": false,
                "languageRootId": "",
                "lingualMaps": {
                    "clones": [],
                    "master": null
                },
                "locale": "",
                "localeInherited": true,
                "markedForPublish": true,
                "markedForPublishAny": true,
                "markedForPublishPropagated": true,
                "nextPageId": null,
                "nextPageIndex": 0,
                "noDnd": false,
                "numChildPages": 7,
                "pageId": "x2",
                "parentId": null,
                "pendingMasterVersion": 0,
                "referenceProps": {
                    "created": "20131206T23:58:02",
                    "createdBy": "INGENIUX\\awang",
                    "endDate": "00010101T00:00:00",
                    "lastModified": "20140125T01:13:31",
                    "lastModifiedBy": "User\/INGENIUX___awang",
                    "publishAs": "",
                    "startDate": "00010101T00:00:00"
                },
                "remoteServer": "",
                "schemaFriendlyName": null,
                "schemaName": "Folder",
                "schemaOnLatestVersion": false,
                "securityLevel": 2,
                "userCanCopyPage": true,
                "workflow": null
            },
            "readOnly": false,
            "title": "<span unselectable='on'><img src='\/CMStrunk\/images\/icons\/over\/folder16.png' \/><\/span>&nbsp;<span unselectable='on' class=' markedForPublish '>Site<\/span>",
            "widgetId": "x2"
        }, {
            "name": "Recycle Folder",
            "isFolder": true,
            "objectId": "RecycleBin",
            "props": {
                "name": "Recycle%20Folder",
                "allowedCategoryRoots": [],
                "ancestors": ["x1"],
                "assignedGroup": null,
                "assignedUser": null,
                "canClaimPage": false,
                "canTranslate": false,
                "checkedOut": false,
                "error": null,
                "icon": 1,
                "isAssignedToOtherUser": false,
                "isEditable": false,
                "isInWorkflow": false,
                "justRecycled": false,
                "languageRootId": "",
                "lingualMaps": {
                    "clones": [],
                    "master": null
                },
                "locale": "",
                "localeInherited": true,
                "markedForPublish": false,
                "markedForPublishAny": false,
                "markedForPublishPropagated": false,
                "nextPageId": null,
                "nextPageIndex": 0,
                "noDnd": false,
                "numChildPages": 7,
                "pageId": "RecycleBin",
                "parentId": null,
                "pendingMasterVersion": 0,
                "referenceProps": {
                    "created": "20131206T23:41:42",
                    "createdBy": "INGENIUX\\abusbin",
                    "endDate": "00010101T00:00:00",
                    "lastModified": "20140125T01:13:30",
                    "lastModifiedBy": "User\/INGENIUX___awang",
                    "publishAs": "",
                    "startDate": "00010101T00:00:00"
                },
                "remoteServer": "",
                "schemaFriendlyName": null,
                "schemaName": "Folder",
                "schemaOnLatestVersion": false,
                "securityLevel": 2,
                "userCanCopyPage": true,
                "workflow": null
            },
            "readOnly": false,
            "title": "<span unselectable='on'><img src='\/CMStrunk\/images\/icons\/inactive\/folder16.png' \/><\/span>&nbsp;<span unselectable='on' class=''>Recycle Folder<\/span>",
            "widgetId": "RecycleBin"
        }],
        "myParentId": null
    }, {
        "children": [{
            "name": "Listing",
            "isFolder": true,
            "objectId": "x112",
            "props": {
                "name": "Listing",
                "allowedCategoryRoots": [],
                "ancestors": ["x1", "x2"],
                "assignedGroup": null,
                "assignedUser": {
                    "name": "Turtle Master",
                    "email": "awang@ingeniux.com",
                    "userId": "INGENIUX\\awang"
                },
                "canClaimPage": false,
                "canTranslate": false,
                "checkedOut": true,
                "error": null,
                "icon": 99,
                "isAssignedToOtherUser": false,
                "isEditable": true,
                "isInWorkflow": false,
                "justRecycled": false,
                "languageRootId": "x112",
                "lingualMaps": {
                    "clones": [{
                        "name": "List",
                        "id": "x117",
                        "locale": "zh-cn"
                    }],
                    "master": null
                },
                "locale": "en-us",
                "localeInherited": false,
                "markedForPublish": false,
                "markedForPublishAny": false,
                "markedForPublishPropagated": false,
                "nextPageId": null,
                "nextPageIndex": 0,
                "noDnd": false,
                "numChildPages": 2,
                "pageId": "x112",
                "parentId": null,
                "pendingMasterVersion": 0,
                "referenceProps": {
                    "created": "20140121T22:53:23",
                    "createdBy": "INGENIUX\\awang",
                    "endDate": "00010101T00:00:00",
                    "lastModified": "20140127T17:24:31",
                    "lastModifiedBy": "User\/INGENIUX___awang",
                    "publishAs": "",
                    "startDate": "00010101T00:00:00"
                },
                "remoteServer": "",
                "schemaFriendlyName": null,
                "schemaName": "ListTest",
                "schemaOnLatestVersion": false,
                "securityLevel": 2,
                "userCanCopyPage": true,
                "workflow": null
            },
            "readOnly": false,
            "title": "<span unselectable='on'><img src='\/CMStrunk\/images\/icons\/over\/document16.png' \/><\/span>&nbsp;<span unselectable='on' class=''>Listing<\/span>",
            "widgetId": "x112"
        }, {
            "name": "Default Dynamic Schemas Test",
            "isFolder": true,
            "objectId": "x100",
            "props": {
                "name": "Default%20Dynamic%20Schemas%20Test",
                "allowedCategoryRoots": [],
                "ancestors": ["x1", "x2"],
                "assignedGroup": null,
                "assignedUser": {
                    "name": "Turtle Master",
                    "email": "awang@ingeniux.com",
                    "userId": "INGENIUX\\awang"
                },
                "canClaimPage": false,
                "canTranslate": false,
                "checkedOut": true,
                "error": null,
                "icon": 1,
                "isAssignedToOtherUser": false,
                "isEditable": true,
                "isInWorkflow": false,
                "justRecycled": false,
                "languageRootId": "",
                "lingualMaps": {
                    "clones": [],
                    "master": null
                },
                "locale": "",
                "localeInherited": true,
                "markedForPublish": false,
                "markedForPublishAny": false,
                "markedForPublishPropagated": false,
                "nextPageId": null,
                "nextPageIndex": 0,
                "noDnd": false,
                "numChildPages": 6,
                "pageId": "x100",
                "parentId": null,
                "pendingMasterVersion": 0,
                "referenceProps": {
                    "created": "20140110T01:04:25",
                    "createdBy": "INGENIUX\\awang",
                    "endDate": "00010101T00:00:00",
                    "lastModified": "20140120T18:44:57",
                    "lastModifiedBy": "User\/INGENIUX___awang",
                    "publishAs": "",
                    "startDate": "00010101T00:00:00"
                },
                "remoteServer": "",
                "schemaFriendlyName": null,
                "schemaName": "Folder",
                "schemaOnLatestVersion": false,
                "securityLevel": 2,
                "userCanCopyPage": true,
                "workflow": null
            },
            "readOnly": false,
            "title": "<span unselectable='on'><img src='\/CMStrunk\/images\/icons\/over\/folder16.png' \/><\/span>&nbsp;<span unselectable='on' class=''>Default Dynamic Schemas Test<\/span>",
            "widgetId": "x100"
        }, {
            "name": "dbquery",
            "isFolder": false,
            "objectId": "x99",
            "props": {
                "name": "dbquery",
                "allowedCategoryRoots": [],
                "ancestors": ["x1", "x2"],
                "assignedGroup": null,
                "assignedUser": null,
                "canClaimPage": false,
                "canTranslate": false,
                "checkedOut": false,
                "error": null,
                "icon": 4,
                "isAssignedToOtherUser": false,
                "isEditable": false,
                "isInWorkflow": false,
                "justRecycled": false,
                "languageRootId": "",
                "lingualMaps": {
                    "clones": [],
                    "master": null
                },
                "locale": "",
                "localeInherited": true,
                "markedForPublish": true,
                "markedForPublishAny": true,
                "markedForPublishPropagated": true,
                "nextPageId": null,
                "nextPageIndex": 0,
                "noDnd": false,
                "numChildPages": 0,
                "pageId": "x99",
                "parentId": null,
                "pendingMasterVersion": 0,
                "referenceProps": {
                    "created": "20140109T22:46:19",
                    "createdBy": "INGENIUX\\awang",
                    "endDate": "00010101T00:00:00",
                    "lastModified": "20140127T18:17:05",
                    "lastModifiedBy": "User\/INGENIUX___awang",
                    "publishAs": "",
                    "startDate": "00010101T00:00:00"
                },
                "remoteServer": "",
                "schemaFriendlyName": null,
                "schemaName": "DbQuery",
                "schemaOnLatestVersion": false,
                "securityLevel": 2,
                "userCanCopyPage": true,
                "workflow": null
            },
            "readOnly": false,
            "title": "<span unselectable='on'><img src='\/CMStrunk\/images\/icons\/inactive\/gateway16.png' \/><\/span>&nbsp;<span unselectable='on' class=' markedForPublish '>dbquery<\/span>",
            "widgetId": "x99"
        }, {
            "name": "DynamicExecutes",
            "isFolder": true,
            "objectId": "x89",
            "props": {
                "name": "DynamicExecutes",
                "allowedCategoryRoots": [],
                "ancestors": ["x1", "x2"],
                "assignedGroup": null,
                "assignedUser": null,
                "canClaimPage": false,
                "canTranslate": false,
                "checkedOut": false,
                "error": null,
                "icon": 1,
                "isAssignedToOtherUser": false,
                "isEditable": false,
                "isInWorkflow": false,
                "justRecycled": false,
                "languageRootId": "",
                "lingualMaps": {
                    "clones": [],
                    "master": null
                },
                "locale": "",
                "localeInherited": true,
                "markedForPublish": true,
                "markedForPublishAny": true,
                "markedForPublishPropagated": true,
                "nextPageId": null,
                "nextPageIndex": 0,
                "noDnd": false,
                "numChildPages": 6,
                "pageId": "x89",
                "parentId": null,
                "pendingMasterVersion": 0,
                "referenceProps": {
                    "created": "20140107T21:57:04",
                    "createdBy": "INGENIUX\\awang",
                    "endDate": "00010101T00:00:00",
                    "lastModified": "20140122T21:48:30",
                    "lastModifiedBy": "User\/INGENIUX___awang",
                    "publishAs": "",
                    "startDate": "00010101T00:00:00"
                },
                "remoteServer": "",
                "schemaFriendlyName": null,
                "schemaName": "Folder",
                "schemaOnLatestVersion": false,
                "securityLevel": 2,
                "userCanCopyPage": true,
                "workflow": null
            },
            "readOnly": false,
            "title": "<span unselectable='on'><img src='\/CMStrunk\/images\/icons\/inactive\/folder16.png' \/><\/span>&nbsp;<span unselectable='on' class=' markedForPublish '>DynamicExecutes<\/span>",
            "widgetId": "x89"
        }, {
            "name": "Home",
            "isFolder": true,
            "objectId": "x5",
            "props": {
                "name": "Home",
                "allowedCategoryRoots": [],
                "ancestors": ["x1", "x2"],
                "assignedGroup": null,
                "assignedUser": {
                    "name": "Turtle Master",
                    "email": "awang@ingeniux.com",
                    "userId": "INGENIUX\\awang"
                },
                "canClaimPage": false,
                "canTranslate": false,
                "checkedOut": true,
                "error": null,
                "icon": 8,
                "isAssignedToOtherUser": false,
                "isEditable": true,
                "isInWorkflow": false,
                "justRecycled": false,
                "languageRootId": "",
                "lingualMaps": {
                    "clones": [],
                    "master": null
                },
                "locale": "",
                "localeInherited": true,
                "markedForPublish": true,
                "markedForPublishAny": true,
                "markedForPublishPropagated": true,
                "nextPageId": null,
                "nextPageIndex": 0,
                "noDnd": false,
                "numChildPages": 4,
                "pageId": "x5",
                "parentId": null,
                "pendingMasterVersion": 0,
                "referenceProps": {
                    "created": "20131207T00:07:46",
                    "createdBy": "INGENIUX\\awang",
                    "endDate": "00010101T00:00:00",
                    "lastModified": "20140125T01:04:19",
                    "lastModifiedBy": "User\/INGENIUX___awang",
                    "publishAs": "",
                    "startDate": "00010101T00:00:00"
                },
                "remoteServer": "",
                "schemaFriendlyName": null,
                "schemaName": "Home",
                "schemaOnLatestVersion": false,
                "securityLevel": 2,
                "userCanCopyPage": true,
                "workflow": null
            },
            "readOnly": false,
            "title": "<span unselectable='on'><img src='\/CMStrunk\/images\/icons\/over\/section16.png' \/><\/span>&nbsp;<span unselectable='on' class=' markedForPublish '>Home<\/span>",
            "widgetId": "x5"
        }, {
            "name": "Internal Components",
            "isFolder": true,
            "objectId": "x3",
            "props": {
                "name": "Internal%20Components",
                "allowedCategoryRoots": [],
                "ancestors": ["x1", "x2"],
                "assignedGroup": null,
                "assignedUser": null,
                "canClaimPage": false,
                "canTranslate": false,
                "checkedOut": false,
                "error": null,
                "icon": 1,
                "isAssignedToOtherUser": false,
                "isEditable": false,
                "isInWorkflow": false,
                "justRecycled": false,
                "languageRootId": "",
                "lingualMaps": {
                    "clones": [],
                    "master": null
                },
                "locale": "",
                "localeInherited": true,
                "markedForPublish": true,
                "markedForPublishAny": true,
                "markedForPublishPropagated": true,
                "nextPageId": null,
                "nextPageIndex": 0,
                "noDnd": false,
                "numChildPages": 62,
                "pageId": "x3",
                "parentId": null,
                "pendingMasterVersion": 0,
                "referenceProps": {
                    "created": "20131206T23:58:14",
                    "createdBy": "INGENIUX\\awang",
                    "endDate": "00010101T00:00:00",
                    "lastModified": "20140128T18:15:02",
                    "lastModifiedBy": "User\/INGENIUX___awang",
                    "publishAs": "",
                    "startDate": "00010101T00:00:00"
                },
                "remoteServer": "",
                "schemaFriendlyName": null,
                "schemaName": "Folder",
                "schemaOnLatestVersion": false,
                "securityLevel": 2,
                "userCanCopyPage": true,
                "workflow": null
            },
            "readOnly": false,
            "title": "<span unselectable='on'><img src='\/CMStrunk\/images\/icons\/inactive\/folder16.png' \/><\/span>&nbsp;<span unselectable='on' class=' markedForPublish '>Internal Components<\/span>",
            "widgetId": "x3"
        }, {
            "name": "List",
            "isFolder": true,
            "objectId": "x117",
            "props": {
                "name": "List",
                "allowedCategoryRoots": [],
                "ancestors": ["x1", "x2"],
                "assignedGroup": null,
                "assignedUser": {
                    "name": "Turtle Master",
                    "email": "awang@ingeniux.com",
                    "userId": "INGENIUX\\awang"
                },
                "canClaimPage": false,
                "canTranslate": false,
                "checkedOut": true,
                "error": null,
                "icon": 99,
                "isAssignedToOtherUser": false,
                "isEditable": true,
                "isInWorkflow": false,
                "justRecycled": false,
                "languageRootId": "x117",
                "lingualMaps": {
                    "clones": [],
                    "master": {
                        "name": "Listing",
                        "id": "x112",
                        "locale": "en-us"
                    }
                },
                "locale": "zh-cn",
                "localeInherited": false,
                "markedForPublish": false,
                "markedForPublishAny": false,
                "markedForPublishPropagated": false,
                "nextPageId": null,
                "nextPageIndex": 0,
                "noDnd": false,
                "numChildPages": 2,
                "pageId": "x117",
                "parentId": null,
                "pendingMasterVersion": 0,
                "referenceProps": {
                    "created": "20140123T23:49:20",
                    "createdBy": "INGENIUX\\awang",
                    "endDate": "00010101T00:00:00",
                    "lastModified": "20140123T23:49:51",
                    "lastModifiedBy": "User\/INGENIUX___awang",
                    "publishAs": "",
                    "startDate": "00010101T00:00:00"
                },
                "remoteServer": "",
                "schemaFriendlyName": null,
                "schemaName": "ListTest",
                "schemaOnLatestVersion": false,
                "securityLevel": 2,
                "userCanCopyPage": true,
                "workflow": null
            },
            "readOnly": false,
            "title": "<span unselectable='on'><img src='\/CMStrunk\/images\/icons\/over\/document16.png' \/><\/span>&nbsp;<span unselectable='on' class=''>List<\/span>",
            "widgetId": "x117"
        }],
        "myParentId": "x2"
    }, {
        "children": [{
            "name": "zBrush",
            "isFolder": false,
            "objectId": "x116",
            "props": {
                "name": "zBrush",
                "allowedCategoryRoots": [],
                "ancestors": ["x1", "x2", "x112"],
                "assignedGroup": null,
                "assignedUser": null,
                "canClaimPage": false,
                "canTranslate": false,
                "checkedOut": false,
                "error": null,
                "icon": 3,
                "isAssignedToOtherUser": false,
                "isEditable": false,
                "isInWorkflow": false,
                "justRecycled": false,
                "languageRootId": "x112",
                "lingualMaps": {
                    "clones": [{
                        "name": "zBrush",
                        "id": "x118",
                        "locale": "zh-cn"
                    }],
                    "master": null
                },
                "locale": "en-us",
                "localeInherited": true,
                "markedForPublish": false,
                "markedForPublishAny": false,
                "markedForPublishPropagated": false,
                "nextPageId": null,
                "nextPageIndex": 0,
                "noDnd": false,
                "numChildPages": 0,
                "pageId": "x116",
                "parentId": null,
                "pendingMasterVersion": 0,
                "referenceProps": {
                    "created": "20140122T00:37:10",
                    "createdBy": "INGENIUX\\awang",
                    "endDate": "00010101T00:00:00",
                    "lastModified": "20140127T21:24:37",
                    "lastModifiedBy": "User\/INGENIUX___awang",
                    "publishAs": "",
                    "startDate": "00010101T00:00:00"
                },
                "remoteServer": "",
                "schemaFriendlyName": null,
                "schemaName": "Image",
                "schemaOnLatestVersion": false,
                "securityLevel": 2,
                "userCanCopyPage": true,
                "workflow": null
            },
            "readOnly": false,
            "title": "<span unselectable='on'><img src='\/CMStrunk\/images\/icons\/inactive\/image16.png' \/><\/span>&nbsp;<span unselectable='on' class=''>zBrush<\/span>",
            "widgetId": "x116"
        }, {
            "name": "zBrush",
            "isFolder": false,
            "objectId": "x119",
            "props": {
                "name": "zBrush",
                "allowedCategoryRoots": [],
                "ancestors": ["x1", "x2", "x112"],
                "assignedGroup": null,
                "assignedUser": {
                    "name": "Turtle Master",
                    "email": "awang@ingeniux.com",
                    "userId": "INGENIUX\\awang"
                },
                "canClaimPage": false,
                "canTranslate": false,
                "checkedOut": true,
                "error": null,
                "icon": 3,
                "isAssignedToOtherUser": false,
                "isEditable": true,
                "isInWorkflow": false,
                "justRecycled": false,
                "languageRootId": "x112",
                "lingualMaps": {
                    "clones": [{
                        "name": "zBrush",
                        "id": "x120",
                        "locale": "zh-cn"
                    }],
                    "master": null
                },
                "locale": "en-us",
                "localeInherited": true,
                "markedForPublish": false,
                "markedForPublishAny": false,
                "markedForPublishPropagated": false,
                "nextPageId": null,
                "nextPageIndex": 0,
                "noDnd": false,
                "numChildPages": 0,
                "pageId": "x119",
                "parentId": null,
                "pendingMasterVersion": 0,
                "referenceProps": {
                    "created": "20140123T23:49:33",
                    "createdBy": "INGENIUX\\awang",
                    "endDate": "00010101T00:00:00",
                    "lastModified": "20140123T23:49:33",
                    "lastModifiedBy": "User\/INGENIUX___awang",
                    "publishAs": "",
                    "startDate": "00010101T00:00:00"
                },
                "remoteServer": "",
                "schemaFriendlyName": null,
                "schemaName": "Image",
                "schemaOnLatestVersion": false,
                "securityLevel": 2,
                "userCanCopyPage": true,
                "workflow": null
            },
            "readOnly": false,
            "title": "<span unselectable='on'><img src='\/CMStrunk\/images\/icons\/over\/image16.png' \/><\/span>&nbsp;<span unselectable='on' class=''>zBrush<\/span>",
            "widgetId": "x119"
        }],
        "myParentId": "x112"
    }]
}
Remarks

The first item in the listing is the Content Store's children information. The "myParentId" field is null. Rest of entries have the "myParentId" set to Page Id

This is an expensive operation, due to the number of Pages it needs to query and return. The deep the Page node is, the more expensive it becomes

See Also

Reference