Click or drag to resize

PageCommandsServicesAddToWorkflow Method


Adds the given Pages to Workflow, with specified Workflow Definition.

Namespace:  IngeniuxCMService
Assembly:  IngeniuxCMService (in IngeniuxCMService.dll) Version: 10.3.169
Syntax
public XHRServiceResponseGeneric<PageCommandReturnInformation> AddToWorkflow(
	string[] pageIds,
	string wfDefId,
	string pubTarget
)

Parameters

pageIds
Type: SystemString
Array of Id of Pages to add to Workflow
wfDefId
Type: SystemString
Id of the Workflow Definition
pubTarget
Type: SystemString
Current Publishing Target Id

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

Page properties in return message will indicate page in Workflow if advancement is successful, but detailed Workflow information will not be included

Error status will be returned, if Workflow Definition doesn't exist. Also, if a Page was already in Workflow, it will be removed from current Workflow and added to the new one.

See Also