PageCommandsServicesMassAdvance Method Ingeniux CMS Web Services API
Advances multiple Pages that are at the Workstates that have the specified transition available.

Namespace: IngeniuxCMService
Assembly: IngeniuxCMService (in IngeniuxCMService.dll) Version: 9.0.565.0 (9.0.565)
Syntax
Copy
public XHRServiceResponseGeneric<PageCommandReturnInformation> MassAdvance(
	string[] pageIds,
	string transitionId,
	string assignTargetId,
	string pubTarget,
	string comment
)

Parameters

pageIds
Type: SystemString
Ids of Pages to be advanced
transitionId
Type: SystemString
Id of the transition
assignTargetId
Type: SystemString
Id of the user to assign the pages to
pubTarget
Type: SystemString

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

comment
Type: SystemString
Comment to be record for this advancement in Workflow Log

Return Value

Type: XHRServiceResponseGenericPageCommandReturnInformation

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

Examples
Sample JSON return
JavaScript
Copy
{
    "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

The Pages needs to be on the same Workflow, but don't have to be on the same Workf State, as long as the transition is available from that state. If not, error will be returned and all advancements will be cancelled.

See Also

Reference

PageCommandsServices Class
IngeniuxCMService Namespace