WorkflowServices.UpdateWorkstate Method

WorkflowServicesUpdateWorkstate Method

Ingeniux CMS Web Services API

Updates an existing Workstate with new data

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

Syntax

C++

Copy

public XHRServiceResponseGeneric<WorkstateSimpleInfo> UpdateWorkstate(
	WorkstateSimpleInfo data
)

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

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

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

Parameters

data

Type: WorkstateSimpleInfo

New information of the Workstate to be updated

Examples

Sample JSON input

JavaScript

Copy

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

Return Value

Type: XHRServiceResponseGenericWorkstateSimpleInfo

Information of updated Workstate

Examples

Sample JSON return

JavaScript

Copy

{
    "code": 0,
    "error": null,
    "message": {
        "name": "Translating",
        "id": "WorkStates\/67",
        "desc": "Translating content to another language",
        "active": true
    }
}

Remarks

If name is null or empty, returns error status.

If Workstate doesn't exist, returns error status.

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

Reference

WorkflowServices Class

IngeniuxCMService Namespace