WFGetProcessDefinition

This call returns definition details of a Process. You can view the XML input and output parameters, which have to be passed for fetching the details. 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

ProcessDefinitionId*

Root

It refers to the id of the process definition whose details are to be fetched.

NA

DataFlag

Root

Whether to fetch data or not

Y = Yes

N = No

ActivityId

Root

It is the Id of Activity

 

 

Output Parameter description

Name

Parent Tag

Description

Option

Root

It refers to the case sensitive call name.

MainCode

Exception

Error code specified by WAPI.

Process Name

Root

It is the process name

VersionNo

Root

It is the process version

RegisterationPrefix

Root

It is the process instance id generation - prefix

RegisterationSuffix

Root

It is the process instance id generation - suffix

ActivityId

ActivityInfo

It is the activity id for the process.

Name

ActivityInfo

It is the activity name for the process

ReassignmentAllowed

ActivityInfo

It is the flag which allows re-assigning of the activity.

ActivityType

ActivityInfo

It is the activity type

Expiry

ActivityInfo

It is the expiry date for the activity.

NoOfEntryRules

ActivityInfo

It is the number of entry rules associated with the activity

NoOfExitRules

ActivityInfo

It is the number of exit rules associated with the activity.

NoOfStreams

ActivityInfo

It is the number of streams associated with the activity.

NoOfInterfaces

ActivityInfo

It is the number of interfaces associated with the activity.

 

Errors and Warnings

Code

Constant Value

Message

18

WM_NO_MORE_DATA

No more records

11

WM_INVALID_SESSION_HANDLE

Invalid session

15

WM_INVALID_FILTER

The requested filter is invalid.