WorkflowServices.GetWorkflowData Method

WorkflowServicesGetWorkflowData Method

Ingeniux CMS Web Services API

Retrieves the detailed information of a Workflow Definition.

Namespace: IngeniuxCMService
Assembly: IngeniuxCMService (in IngeniuxCMService.dll) Version: 9.0.565.0 (9.0.565)

Syntax

C++

Copy

public XHRServiceResponseGeneric<WorkflowDefinitionDesignerInfo> GetWorkflowData(
	string wfDefId
)

Public Function GetWorkflowData ( 
	wfDefId As String
) As XHRServiceResponseGeneric(Of WorkflowDefinitionDesignerInfo)

public:
virtual XHRServiceResponseGeneric<WorkflowDefinitionDesignerInfo^>^ GetWorkflowData(
	String^ wfDefId
) sealed

abstract GetWorkflowData : 
        wfDefId : string -> XHRServiceResponseGeneric<WorkflowDefinitionDesignerInfo> 
override GetWorkflowData : 
        wfDefId : string -> XHRServiceResponseGeneric<WorkflowDefinitionDesignerInfo>

Parameters

wfDefId: Type: SystemString
Id of the Workflow Definition

Return Value

Type: XHRServiceResponseGenericWorkflowDefinitionDesignerInfo

Full details of the Workflow Definition

Examples

Sample JSON return

JavaScript

Copy

{
    "code": 0,
    "error": null,
    "message": {
        "name": "Standard",
        "id": "WorkflowDefinitions\/2",
        "desc": "",
        "tran": [{
            "name": "Initial",
            "id": "WorkflowTransition_WorkflowDefinitions\/2_1",
            "desc": "",
            "actions": [],
            "allowNextGroupToAdvance": false,
            "currentState": "WorkStates\/1",
            "defaultUser": "",
            "description": "",
            "isDefault": false,
            "nextGroupName": "UserGroup\/1",
            "nextGroupNameStr": "Administrators",
            "nextState": "WorkStates\/35"
        }, {
            "name": "Transition5",
            "id": "WorkflowTransition_WorkflowDefinitions\/2_2",
            "desc": "",
            "actions": [],
            "allowNextGroupToAdvance": false,
            "currentState": "WorkStates\/35",
            "defaultUser": "",
            "description": "",
            "isDefault": false,
            "nextGroupName": "UserGroup\/1",
            "nextGroupNameStr": "Administrators",
            "nextState": "WorkStates\/37"
        }, {
            "name": "Transition6",
            "id": "WorkflowTransition_WorkflowDefinitions\/2_3",
            "desc": "",
            "actions": [],
            "allowNextGroupToAdvance": false,
            "currentState": "WorkStates\/37",
            "defaultUser": "",
            "description": "",
            "isDefault": false,
            "nextGroupName": "UserGroup\/1",
            "nextGroupNameStr": "Administrators",
            "nextState": "WorkStates\/36"
        }, {
            "name": "Transition7",
            "id": "WorkflowTransition_WorkflowDefinitions\/2_4",
            "desc": "",
            "actions": [],
            "allowNextGroupToAdvance": false,
            "currentState": "WorkStates\/36",
            "defaultUser": "",
            "description": "",
            "isDefault": false,
            "nextGroupName": "UserGroup\/1",
            "nextGroupNameStr": "Administrators",
            "nextState": "WorkStates\/38"
        }]
    }
}

Remarks

If Workflow Definition doesn't exist, returns error status.

Reference

WorkflowServices Class

IngeniuxCMService Namespace