WFGetExternalInterfaceList

This call fetches the list of external interfaces. You can view the XML input and output parameters, which have to be passed for fetching the list. 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 is the process definition id whose interface list has to be fetched.

NA

ActivityId

Root

It is the activity id..

NA

InterfaceId

Root

It is the Interface id

NA

ProcessName

Root

It is the name of Process to be given if ProcessDefinitionID is 0

NA

 

Output Parameter description

Name

Parent Tag

Description

Option

Root

It refers to the case sensitive call name.

MainCode

Exception

Error code specified by WAPI.

InterfaceId

InterfaceInfo

It is the id of the interface.

InterfaceName

InterfaceInfo

It is the name of the interface

Id

Element

It is the id of the element of the specific interface.

Name

Element

It is the name of the element of the specific interface.

TotalCount

Root

It is the total number of external interfaces.

 

Errors and Warnings

Code

Constant Value

Message

11

WM_INVALID_SESSION_HANDLE

Invalid session

15

WM_INVALID_FILTER

The requested filter is invalid.