WorkflowServices.GetWorkflowReports Method

WorkflowServicesGetWorkflowReports Method

Ingeniux CMS Web Services API

Retrieves a list of Pages that are in Workflow, and their current state

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

Syntax

C++

Copy

public XHRServiceResponseGeneric<WorkflowReportData> GetWorkflowReports(
	string wfDefId = ""
)

Public Function GetWorkflowReports ( 
	Optional wfDefId As String = ""
) As XHRServiceResponseGeneric(Of WorkflowReportData)

public:
virtual XHRServiceResponseGeneric<WorkflowReportData^>^ GetWorkflowReports(
	String^ wfDefId = L""
) sealed

abstract GetWorkflowReports : 
        ?wfDefId : string 
(* Defaults:
        let _wfDefId = defaultArg wfDefId ""
*)
-> XHRServiceResponseGeneric<WorkflowReportData> 
override GetWorkflowReports : 
        ?wfDefId : string 
(* Defaults:
        let _wfDefId = defaultArg wfDefId ""
*)
-> XHRServiceResponseGeneric<WorkflowReportData>

Parameters

wfDefId (Optional): Type: SystemString
Operational parameter - Id of the Workflow Definition to get reports one. If not provided, retrieves reports for all Workflow Definitions

Return Value

Type: XHRServiceResponseGenericWorkflowReportData

Object containing listing of Pages in Workflow. It is designed to be injected into a Table/Grid.

Examples

Sample JSON return

JavaScript

Copy

{
    "code": 0,
    "error": null,
    "message": {
        "columns": [{
            "name": "Page",
            "field": "pageName",
            "igxtype": "pagename",
            "relWidth": 2
        }, {
            "name": "xID",
            "field": "id",
            "igxtype": "xid",
            "relWidth": 1
        }, {
            "name": "Workflow",
            "field": "workflow",
            "igxtype": null,
            "relWidth": 2
        }, {
            "name": "Workstate",
            "field": "workstate",
            "igxtype": null,
            "relWidth": 2
        }, {
            "name": "Group",
            "field": "group",
            "igxtype": null,
            "relWidth": 2
        }, {
            "name": "Assigned To",
            "field": "assignedTo",
            "igxtype": null,
            "relWidth": 2
        }, {
            "name": "Last Updated",
            "field": "lastUpdated",
            "igxtype": "date",
            "relWidth": 2
        }, {
            "name": "Last Comment",
            "field": "lastComment",
            "igxtype": null,
            "relWidth": 2
        }],
        "report": [{
            "assignedTo": "Administrators",
            "group": "Administrators",
            "id": "x11",
            "lastComment": "Existing page added to workflow",
            "lastUpdated": "20140204T17:09:09",
            "pageName": "About Us",
            "workflow": "Standard",
            "workstate": "Authoring"
        }, {
            "assignedTo": "Administrators",
            "group": "Administrators",
            "id": "x9",
            "lastComment": "Existing page added to workflow",
            "lastUpdated": "20140204T17:10:46",
            "pageName": "Terms",
            "workflow": "Standard",
            "workstate": "Authoring"
        }]
    }
}

Remarks

If Workflow Definition Id is specified, but Definition doesn't exist, returns error status.

Reference

WorkflowServices Class

IngeniuxCMService Namespace