SiteTreeServicesMoveCopyPage Method

Ingeniux CMS Web Services API

Moves or Copies a Page node from one location to another location. All the descendants of the Page node gets moved/copied together.

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

public XHRServiceResponseGeneric<PageNodeInformation> MoveCopyPage(
	ContentItemMoveCopyInformation data,
	string pubTarget
)

Parameters

data
Type: ContentItemMoveCopyInformation

Instructions on the Move/Copy action

Examples

Sample JSON input
JavaScript
{
    "child": {
        "widgetId": "x108",
        "objectId": "x108",
        "index": 1
    },
    "oldParent": {
        "widgetId": "x100",
        "objectId": "x100",
        "index": 1
    },
    "oldParentTree": {
        "widgetId": "x0",
        "objectId": ""
    },
    "newParent": {
        "widgetId": "x103",
        "objectId": "x103",
        "index": 4
    },
    "newParentTree": {
        "widgetId": "x0",
        "objectId": ""
    },
    "newIndex": 0,
    "deep": true,
    "tree": {
        "widgetId": "x0",
        "objectId": ""
    },
    "toCopy": true,
    "toSmartCopy": false
}
pubTarget
Type: SystemString
Id of the current Publishing Target, optional

Return Value

Type: XHRServiceResponseGenericPageNodeInformation

Updated information of the Page node that was moved, or new Page node that from created from the copy action

Examples

Sample JSON return
JavaScript
{
    "code": 0,
    "error": null,
    "message": {
        "name": "Soap",
        "isFolder": false,
        "objectId": "x123",
        "props": {
            "name": "Soap",
            "allowedCategoryRoots": [],
            "ancestors": ["x1", "x2", "x100", "x103"],
            "assignedGroup": null,
            "assignedUser": {
                "name": "Turtle Master",
                "email": "awang@ingeniux.com",
                "userId": "INGENIUX\\awang"
            },
            "canClaimPage": false,
            "canTranslate": false,
            "checkedOut": true,
            "error": null,
            "icon": 9,
            "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": 0,
            "pageId": "x123",
            "parentId": null,
            "pendingMasterVersion": 0,
            "referenceProps": {
                "created": "20140130T18:12:31",
                "createdBy": "INGENIUX\\awang",
                "endDate": "00010101T00:00:00",
                "lastModified": "20140130T18:12:31",
                "lastModifiedBy": "User\/INGENIUX___awang",
                "publishAs": "",
                "startDate": "00010101T00:00:00"
            },
            "remoteServer": "",
            "schemaFriendlyName": null,
            "schemaName": "SOAPServiceClient",
            "schemaOnLatestVersion": false,
            "securityLevel": 2,
            "userCanCopyPage": true,
            "workflow": null
        },
        "readOnly": false,
        "title": "<span unselectable='on'><img src='\/CMStrunk\/images\/icons\/over\/comcomponent16.png' \/><\/span>&nbsp;<span unselectable='on' class=''>Soap<\/span>",
        "widgetId": "x123"
    }
}
Remarks

This operation put all instructions of the move/copy action info one parameter. For operation that divice instructions into separate parameters, use the MoveCopyPageAdvanced(String, String, String, Boolean, Boolean, String, String, Boolean) opertaion.

If target parent Page Is is not provided, use "x1", which is the Content Store Id

If either original Page or target parent Page doesn't exist, returns error status

See Also

Reference