WMChangeProcessDefinitionState

This call is defined to allow a process definition to be changed temporarily to a specific state such as disabled (thus disallowing temporarily the creation of new process definitions), or enabled (thus allowing again the creation of new process definitions based on the named definition).

You can view the XML input and output parameters which have to be passed for changing the process definition and displaying it. There is a list of errors and warning that can occur in the process.

 

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

ProcessDefinitionID *

Root

It refers to the id of the process definition which has to be changed..

NA

ProcessDefinitionState*

Root

It refers to the process state that has to be changed.

Enabled/ Disabled

 

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

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.