WorkflowServicesGetGlobalWorkflowData Method

Ingeniux CMS Web Services API

Retrieves the items in Ingeniux CMS Workflow system.

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

public XHRServiceResponseGeneric<GlobalWorkflowInfo> GetGlobalWorkflowData(
	bool definitionsOnly
)

Parameters

definitionsOnly
Type: SystemBoolean
Whether to retrieve on Workflow Definitions, or Workflow Defintions and Workstates.

Return Value

Type: XHRServiceResponseGenericGlobalWorkflowInfo

Object containg collection of Workflow Definition, and Workstate if specified.

Examples

Sample JSON return
JavaScript
{
    "code": 0,
    "error": null,
    "message": {
        "wfDefs": [{
            "name": "One Step",
            "id": "WorkflowDefinitions\/3",
            "desc": "",
            "pages": 0
        }, {
            "name": "Standard",
            "id": "WorkflowDefinitions\/2",
            "desc": "",
            "pages": 0
        }],
        "wfStates": [{
            "name": "Approving",
            "id": "WorkStates\/36",
            "desc": "",
            "active": false
        }, {
            "name": "Authoring",
            "id": "WorkStates\/35",
            "desc": "",
            "active": false
        }, {
            "name": "Initial",
            "id": "WorkStates\/1",
            "desc": "The initial WorkState of a workflow",
            "active": true
        }, {
            "name": "Publishing",
            "id": "WorkStates\/38",
            "desc": "",
            "active": false
        }, {
            "name": "Reviewing",
            "id": "WorkStates\/37",
            "desc": "",
            "active": false
        }]
    }
}
Remarks

If "definitesOnly" parameter is true, then "wfStates" field of the return object will be null.

See Also

Reference