WorkflowServicesSetWorkflowData Method

Ingeniux CMS Web Services API

Updates a Workflow Definition with new data

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

public XHRServiceResponseGeneric<WorkflowSaveData> SetWorkflowData(
	WorkflowDefinitionDesignerInfo data
)

Parameters

data
Type: WorkflowDefinitionDesignerInfo

Full details of the update for the Workflow Definition

Examples

Sample JSON input
JavaScript
{
    "data": {
        "id": "WorkflowDefinitions/3",
        "name": "One Step",
        "desc": "",
        "tran": [{
            "name": "Initial",
            "id": "WorkflowTransition_WorkflowDefinitions/3_1",
            "desc": "",
            "actions": [],
            "allowNextGroupToAdvance": false,
            "currentState": "WorkStates/1",
            "defaultUser": "",
            "description": "",
            "isDefault": false,
            "nextGroupName": "UserGroups/1",
            "nextGroupNameStr": "Authors",
            "nextState": "WorkStates/35",
            "endPos": {
                "x": -1.0014430014430014,
                "y": -0.0014598540145985828
            }
        }, {
            "name": "Publish",
            "id": "WorkflowTransition_WorkflowDefinitions/3_2",
            "desc": "",
            "actions": [],
            "allowNextGroupToAdvance": false,
            "currentState": "WorkStates/35",
            "defaultUser": "",
            "description": "",
            "isDefault": false,
            "nextGroupName": "UserGroup/1",
            "nextGroupNameStr": "Administrators",
            "nextState": "WorkStates/38",
            "startPos": {
                "x": -1.0014430014430014,
                "y": -0.0014598540145985828
            },
            "endPos": {
                "x": -1.0014430014430014,
                "y": 0.9970802919708028
            }
        }]
    }
}

Return Value

Type: XHRServiceResponseGenericWorkflowSaveData

Information of the updated Workflow Definition and its Transitions

Examples

Sample JSON return
JavaScript
{
    "code": 0,
    "error": null,
    "message": {
        "newDefinition": {
            "name": "One Step",
            "id": "WorkflowDefinitions\/3",
            "desc": ""
        },
        "trans": [{
            "Key": "WorkflowTransition_WorkflowDefinitions\/3_1",
            "Value": {
                "actions": [],
                "id": "WorkflowTransition_WorkflowDefinitions\/3_1"
            }
        }, {
            "Key": "WorkflowTransition_WorkflowDefinitions\/3_2",
            "Value": {
                "actions": [],
                "id": "WorkflowTransition_WorkflowDefinitions\/3_2"
            }
        }]
    }
}
Remarks

If Workflow Definition doesn't exist, returns error status

See Also

Reference