Click or drag to resize

PageCommandsServicesUndoCheckout Method

Abandons all changes made in the Check out version of Page, change Page state back to Checked in.

Namespace:  IngeniuxCMService
Assembly:  IngeniuxCMService (in IngeniuxCMService.dll) Version: 10.5.94
Syntax
Copy
public XHRServiceResponseGeneric<PageCommandReturnInformation> UndoCheckout(
	string pageId,
	bool includeChildren,
	string pubTarget
)

Parameters

pageId
Type: SystemString
Id of the the Page to undo check out on
includeChildren
Type: SystemBoolean
Specified whether to perform undo check out on all descendant of the given Page
pubTarget
Type: SystemString
Id of current Publishing Targett

Return Value

Type: XHRServiceResponseGenericPageCommandReturnInformation

Information of the Page Command action and the properties of the Page after undo check out

Examples
Sample JSON return
JavaScript
Copy
{
    "code": 0,
    "error": null,
    "message": {
        "contentChanged": false,
        "pageAction": "undocheckout",
        "pageProperties": {
            "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": false,
            "markedForPublishAny": false,
            "markedForPublishPropagated": false,
            "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
        },
        "pages": [{
            "id": "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": false,
                "markedForPublishAny": false,
                "markedForPublishPropagated": false,
                "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
            }
        }],
        "queryString": {
            "assignTargetId": null,
            "assignToGroup": null,
            "comment": null,
            "includeChildren": false,
            "newPageName": null,
            "pageAction": null,
            "pageId": null,
            "pageIds": null,
            "transitionId": null
        }
    }
}
Remarks

If Page is not checked out, operation and the events before/after will not be carried out. This also means Before/After Undo Checkout custom hooks will be carried out either.

When include children on this operation, only the checked out Pages in the descendants will be affected.

See Also