PageCommandsServices.Rollback Method

PageCommandsServicesRollback Method

Ingeniux CMS Web Services API

Rolls back the Page to its previous version. After rolling back, Page will keep it current version number, but its content was changed to the previous version's content; and it will be in checked in state.

Namespace: IngeniuxCMService
Assembly: IngeniuxCMService (in IngeniuxCMService.dll) Version: 9.0.565.0 (9.0.565)

Syntax

C++

Copy

public XHRServiceResponseGeneric<PageCommandReturnInformation> Rollback(
	string pageId,
	string pubTarget
)

Public Function Rollback ( 
	pageId As String,
	pubTarget As String
) As XHRServiceResponseGeneric(Of PageCommandReturnInformation)

public:
virtual XHRServiceResponseGeneric<PageCommandReturnInformation^>^ Rollback(
	String^ pageId, 
	String^ pubTarget
) sealed

abstract Rollback : 
        pageId : string * 
        pubTarget : string -> XHRServiceResponseGeneric<PageCommandReturnInformation> 
override Rollback : 
        pageId : string * 
        pubTarget : string -> XHRServiceResponseGeneric<PageCommandReturnInformation>

Parameters

pageId: Type: SystemString
Id of the Page to roll back
pubTarget: Type: SystemString
Id of current Publishing Target

Return Value

Type: XHRServiceResponseGenericPageCommandReturnInformation

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

Examples

Sample JSON return

JavaScript

Copy

{
    "code": 0,
    "error": null,
    "message": {
        "contentChanged": false,
        "pageAction": "rollback",
        "pageProperties": {
            "name": "ContactUs",
            "allowedCategoryRoots": [],
            "ancestors": ["x1", "x2", "x3"],
            "assignedGroup": null,
            "assignedUser": null,
            "canClaimPage": false,
            "canTranslate": false,
            "checkedOut": false,
            "error": null,
            "icon": 5,
            "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": 0,
            "pageId": "x70",
            "parentId": null,
            "pendingMasterVersion": 0,
            "referenceProps": {
                "created": "20131218T23:22:52",
                "createdBy": "INGENIUX\\awang",
                "endDate": "00010101T00:00:00",
                "lastModified": "20140128T01:27:35",
                "lastModifiedBy": "User\/INGENIUX___awang",
                "publishAs": "",
                "startDate": "00010101T00:00:00"
            },
            "remoteServer": "",
            "schemaFriendlyName": null,
            "schemaName": "ContactInformation",
            "schemaOnLatestVersion": false,
            "securityLevel": 2,
            "userCanCopyPage": true,
            "workflow": null
        },
        "pages": [{
            "id": "x70",
            "props": {
                "name": "ContactUs",
                "allowedCategoryRoots": [],
                "ancestors": ["x1", "x2", "x3"],
                "assignedGroup": null,
                "assignedUser": null,
                "canClaimPage": false,
                "canTranslate": false,
                "checkedOut": false,
                "error": null,
                "icon": 5,
                "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": 0,
                "pageId": "x70",
                "parentId": null,
                "pendingMasterVersion": 0,
                "referenceProps": {
                    "created": "20131218T23:22:52",
                    "createdBy": "INGENIUX\\awang",
                    "endDate": "00010101T00:00:00",
                    "lastModified": "20140128T01:27:35",
                    "lastModifiedBy": "User\/INGENIUX___awang",
                    "publishAs": "",
                    "startDate": "00010101T00:00:00"
                },
                "remoteServer": "",
                "schemaFriendlyName": null,
                "schemaName": "ContactInformation",
                "schemaOnLatestVersion": false,
                "securityLevel": 2,
                "userCanCopyPage": true,
                "workflow": null
            }
        }],
        "queryString": {
            "assignTargetId": null,
            "assignToGroup": null,
            "comment": null,
            "includeChildren": false,
            "newPageName": null,
            "pageAction": null,
            "pageId": null,
            "pageIds": null,
            "transitionId": null
        }
    }
}

Reference

PageCommandsServices Class

IngeniuxCMService Namespace