WorkflowServices.DeleteWorkstate Method

WorkflowServicesDeleteWorkstate Method

Ingeniux CMS Web Services API

Deletes a collection of Workstates. Opertaion will not stop when encount errors on individual Workstate deletion. Instead of the problematic Workstate Ids and the actual errors will be records and returned

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

Syntax

C++

Copy

public XHRServiceResponseGeneric<DeleteWorkStateOutput> DeleteWorkstate(
	DeleteWorkstateInput data
)

Public Function DeleteWorkstate ( 
	data As DeleteWorkstateInput
) As XHRServiceResponseGeneric(Of DeleteWorkStateOutput)

public:
virtual XHRServiceResponseGeneric<DeleteWorkStateOutput^>^ DeleteWorkstate(
	DeleteWorkstateInput^ data
) sealed

abstract DeleteWorkstate : 
        data : DeleteWorkstateInput -> XHRServiceResponseGeneric<DeleteWorkStateOutput> 
override DeleteWorkstate : 
        data : DeleteWorkstateInput -> XHRServiceResponseGeneric<DeleteWorkStateOutput>

Parameters

data

Type: DeleteWorkstateInput

Object containing array of Id of Workstates to be deleted

Examples

Sample JSON input

JavaScript

Copy

{
    "data": {
        "ids": "WorkStates/67, WorkStates/38, WorkStates/12"
    }
}

Return Value

Type: XHRServiceResponseGenericDeleteWorkStateOutput

Object containing the Id of the Workstates that has been removed, also Id and error of the Workstates that could not be deleted.

Examples

Sample JSON return

JavaScript

Copy

{
    "code": 0,
    "error": null,
    "message": {
        "deletedIds": ["WorkStates\/67", "WorkStates\/38"],
        "problemIds": [{
            "id": "WorkStates\/12",
            "error": "Workstate with Id \"WorkStates\/12\" doesn't exist"
        }]
    }
}

Reference

WorkflowServices Class

IngeniuxCMService Namespace