PageCommandsServicesAdvance Method

Ingeniux CMS Web Services API

Advances a Page in Workflow via specified transition.

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

public XHRServiceResponseGeneric<PageCommandReturnInformation> Advance(
	string pageId,
	string transitionId,
	string assignTargetId,
	string pubTarget,
	string comment,
	bool assignToGroup
)

Parameters

pageId
Type: SystemString
Id of Page to advance in workflow
transitionId
Type: SystemString
Id of the transition to use in advancement
assignTargetId
Type: SystemString
User Id to assign the Page to after advancement
pubTarget
Type: SystemString
Id of current Publishing Target
comment
Type: SystemString
Comment to be record for this advancement in Workflow Log
assignToGroup
Type: SystemBoolean

[Missing <param name="assignToGroup"/> documentation for "M:IngeniuxCMService.PageCommandsServices.Advance(System.String,System.String,System.String,System.String,System.String,System.Boolean)"]

Return Value

Type: XHRServiceResponseGenericPageCommandReturnInformation

Information of the Page Command action and the properties of updated Pages

Examples

Sample JSON return
JavaScript
{
    "code": 0,
    "error": null,
    "message": {
        "contentChanged": false,
        "pageAction": "addtoworkflow",
        "pageProperties": {
            "name": "Home",
            "allowedCategoryRoots": [],
            "ancestors": ["x1", "x2"],
            "assignedGroup": {
                "name": "Authors",
                "canClaimPage": false,
                "groupId": "UserGroup\/2"
            },
            "assignedUser": null,
            "canClaimPage": false,
            "canTranslate": false,
            "checkedOut": false,
            "error": null,
            "icon": 7,
            "isAssignedToOtherUser": true,
            "isEditable": false,
            "isInWorkflow": true,
            "justRecycled": false,
            "languageRootId": "",
            "lingualMaps": {
                "clones": [],
                "master": null
            },
            "locale": "",
            "localeInherited": true,
            "markedForPublish": true,
            "markedForPublishAny": true,
            "markedForPublishPropagated": true,
            "nextPageId": null,
            "nextPageIndex": 0,
            "noDnd": false,
            "numChildPages": 9,
            "pageId": "x11",
            "parentId": null,
            "pendingMasterVersion": 0,
            "referenceProps": {
                "created": "20081117T07:28:18",
                "createdBy": "ingeniux\\ashley",
                "endDate": "99991231T23:59:59",
                "lastModified": "20140124T23:15:18",
                "lastModifiedBy": "User\/ingeniux___awang",
                "publishAs": "",
                "startDate": "00010101T00:00:00"
            },
            "remoteServer": "",
            "schemaFriendlyName": null,
            "schemaName": "Home",
            "schemaOnLatestVersion": false,
            "securityLevel": 2,
            "userCanCopyPage": true,
            "workflow": null
        },
        "pages": [{
            "id": "x11",
            "props": {
                "name": "Home",
                "allowedCategoryRoots": [],
                "ancestors": ["x1", "x2"],
                "assignedGroup": {
                    "name": "Authors",
                    "canClaimPage": false,
                    "groupId": "UserGroup\/2"
                },
                "assignedUser": null,
                "canClaimPage": false,
                "canTranslate": false,
                "checkedOut": false,
                "error": null,
                "icon": 7,
                "isAssignedToOtherUser": true,
                "isEditable": false,
                "isInWorkflow": true,
                "justRecycled": false,
                "languageRootId": "",
                "lingualMaps": {
                    "clones": [],
                    "master": null
                },
                "locale": "",
                "localeInherited": true,
                "markedForPublish": true,
                "markedForPublishAny": true,
                "markedForPublishPropagated": true,
                "nextPageId": null,
                "nextPageIndex": 0,
                "noDnd": false,
                "numChildPages": 9,
                "pageId": "x11",
                "parentId": null,
                "pendingMasterVersion": 0,
                "referenceProps": {
                    "created": "20081117T07:28:18",
                    "createdBy": "ingeniux\\ashley",
                    "endDate": "99991231T23:59:59",
                    "lastModified": "20140124T23:15:18",
                    "lastModifiedBy": "User\/ingeniux___awang",
                    "publishAs": "",
                    "startDate": "00010101T00:00:00"
                },
                "remoteServer": "",
                "schemaFriendlyName": null,
                "schemaName": "Home",
                "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 doesn't exist, or Page is not in Workflow, returns error status

If transtion id is not provided, or transition doesn't exist, Workflow use the default transition from current state to advance. If current Work State has to transitions available, returns error status.

If assign target User Id if not specified, will try to assign to transition's next default user. If next default user is not specified, will assign page to next user group.

See Also

Reference