PageCommandsServicesRename Method

Ingeniux CMS Web Services API

Renames a Page

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

public XHRServiceResponseGeneric<PageCommandReturnInformation> Rename(
	string pageId,
	string newPageName,
	string pubTarget = ""
)

Parameters

pageId
Type: SystemString
Id of the Page to rename
newPageName
Type: SystemString
New name for the Page
pubTarget (Optional)
Type: SystemString
Id of current Publishing Target

Return Value

Type: XHRServiceResponseGenericPageCommandReturnInformation

Information of the Page Command action and the properties of the Page after renaming

Examples

Sample JSON return
JavaScript
{
    "code": 0,
    "error": null,
    "message": {
        "contentChanged": false,
        "pageAction": "rename",
        "pageProperties": {
            "name": "Listing",
            "allowedCategoryRoots": [],
            "ancestors": ["x1", "x2"],
            "assignedGroup": null,
            "assignedUser": {
                "name": "Turtle Master",
                "email": "",
                "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": "20140123T23:49:33",
                "lastModifiedBy": "User\/INGENIUX___awang",
                "publishAs": "",
                "startDate": "00010101T00:00:00"
            },
            "remoteServer": "",
            "schemaFriendlyName": "ListTest",
            "schemaName": "ListTest",
            "schemaOnLatestVersion": true,
            "securityLevel": 2,
            "userCanCopyPage": true,
            "workflow": null
        },
        "pages": null,
        "queryString": {
            "assignTargetId": null,
            "assignToGroup": null,
            "comment": null,
            "includeChildren": false,
            "newPageName": "Listing",
            "pageAction": null,
            "pageId": null,
            "pageIds": null,
            "transitionId": null
        }
    }
}
Remarks

If Page with given Id doesn't exist, returns error status

Page must be checked out to rename, otherwise returns error status

See Also

Reference