WMChangeWorkitemState

This call changes the state of the named workitem. This command is defined to allow a workitem to be changed temporarily to a specific state such as Completed, Running, Not Started, Terminated, Aborted, Suspended or custom States.

You can view the XML input and output parameters, which have to be passed for changing the workitem state. There is a list of errors and warning that ca                                                                                                                                    x  b   n occur in the execution.

 

Input Parameter description

 View Sample InputXML

Output Parameter description

 View Sample OutputXML

Errors and Warnings

View Sample Code

 

Input Parameter description

* implies for the mandatory parameter.

Name

Parent Tag

Description

Valid Value

Option *

Root

It refers to the case sensitive call name.

case sensitive call name.

EngineName *

Root

It is the cabinet or database name, which has to be connected.

NA

SessionID *

Root

It is the logged in user session id

NA

ProcessInstanceId*

Root

It refers to the id of the process.

NA

WorkItemId *

Root

It is the id of the workitem whose state has to be changed.

NA

WorkItemState *

Root

It is the workitem state that has to be changed.

Completed, Running, Not Started, Terminated, Aborted, Suspended or custom States

 

Output Parameter description

Name

Parent Tag

Description

Option

Root

It refers to the case sensitive call name.

MainCode

Exception

Error code specified by WAPI.

 

Errors and Warnings

Code

Constant Value

Message

11

WM_INVALID_SESSION_HANDLE

Invalid session

502

WM_INVALID_PROCESS_DEFINITION

The process definition ID was not valid.

9

WM_INVALID_STATE

Invalid state.

10

WM_TRANSITION_NOT_ALLOWED

The requested state transition is not allowed.