WorkflowServices.CreateWorkstate Method

WorkflowServicesCreateWorkstate Method

Ingeniux CMS Web Services API

Creates a new Workstate. Workstates are stages within a workflow. A Workstate is available to every Workflow Definition.

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

Syntax

C++

Copy

public XHRServiceResponseGeneric<WorkstateSimpleInfo> CreateWorkstate(
	WorkstateSimpleInfo data
)

Public Function CreateWorkstate ( 
	data As WorkstateSimpleInfo
) As XHRServiceResponseGeneric(Of WorkstateSimpleInfo)

public:
virtual XHRServiceResponseGeneric<WorkstateSimpleInfo^>^ CreateWorkstate(
	WorkstateSimpleInfo^ data
) sealed

abstract CreateWorkstate : 
        data : WorkstateSimpleInfo -> XHRServiceResponseGeneric<WorkstateSimpleInfo> 
override CreateWorkstate : 
        data : WorkstateSimpleInfo -> XHRServiceResponseGeneric<WorkstateSimpleInfo>

Parameters

data

Type: WorkstateSimpleInfo

Information for the new Workstate to be created

Examples

Sample JSON input

JavaScript

Copy

{
    "data": {
        "id": "",
        "name": "Translating",
        "desc": "Translating content to another language",
        "active": true
    }
}

Return Value

Type: XHRServiceResponseGenericWorkstateSimpleInfo

Information of the newly created Workstate.

Remarks

If name is null or empty, returns error status.

If there is another Workstate that has the same name, returns error status.

Reference

WorkflowServices Class

IngeniuxCMService Namespace