WMGetProcessInstance

This call returns a specific process instance record. The WMGetProcessInstance provides information about what work has been done within a process instance and what is the current work being done within the process instance.

You can view the XML input and output parameters, which have to be passed for fetching the list and displaying it. There is a list of errors and warning that can 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 instance which has to be fetched.

NA

 

 

Output Parameter description

Name

Parent Tag

Description

Option

Root

It refers to the case sensitive call name.

ProcessName

ProcessInstance

It is the process name which is fetched.

ProcessInstanceId

ProcessInstance

It is the process instance id under the process fetched.

ProcessDefinitionId

ProcessInstance

It is the process definition id which is fetched.

ProcessInstanceState

ProcessInstance

Process Instance State can be any of the following-

Completed, Running, Suspended, Aborted, Not Started, Terminated

Priority Level

ProcessInstance

Priority set for process instance.

Participant

Participants

User has locked the process instance.

 

Errors and Warnings

Code

Constant Value

Message

11

WM_INVALID_SESSION_HANDLE

Invalid session

4

WM_INVALID_PROCESS_INSTANCE

The process instance ID was not valid.