WMAddQueue

This call allows adding the queue. You can view the XML input and output parameters, which have to be passed for adding the queue. 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

QueueName *

Root

it is the queue name for the new queue.

NA

Description *

Root

It is the description for the queue

NA

QueueType *

Root

It is the type of queue

U- Personal Queue or S- Shared Queue

AllowReassignment

Root

It is the reassignment flag for the queue

"Y" for yes and "N" for No

OrderBy

Root

It is the sort order for the queue.

NA

FilterValue

Root

It is the filter value for the queue.

NA

FilterOption

Root

It is the filter option for the queue.

NA

Activityid *

StreamInfo

It is the activity name associated with the queue

NA

Id *

StreamInfo

It is the stream id associated with the activity

NA

ProcessDefinitionID*

StreamInfo

It is the process definition id

NA

Id

UserInfo

It is the user id

NA

AssignedTilldate

UserInfo

It is the date/time till which the user is assigned for the queue

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.

QueueId

Root

It is the new queue id which is added.

ActivityId

StreamInfo

It is the activity name associated with the queue.

Id*

StreamInfo

It is the stream id associated with the activity.

ProcessDefinitionID*

StreamInfo

It is the process definition id.

Id

UserInfo

It is the user id.

Id

GroupInfo

It is the group id of the user.

 

Errors and Warnings

Code

Constant Value

Message

11

WM_INVALID_SESSION_HANDLE

Invalid session

15

WM_INVALID_FILTER

The requested filter is invalid.