Previous Topic: getApprovedJNDIUsers Operation

Next Topic: Exceptions Thrown

Complex Types - Worklist Web Services

This section details the complex types that are used in the wlService WSDL.

WorkItem - wlService WSDL

Parameters

Field

Type

Description

expression

string

Specifies the expression assigned to this parameter

name

string

specifies the name of the parameter

type

Integer

Specifies the type of the parameter (see Attribute for a list of types)

typeQName

QName

Specifies the type of the parameter as a QName

xalue

string

Specifies the value of the parameter

Parameter

string

Description

id

string

Specifies the ID of the workitem

parentWorkItemId

string

Specifies the ID of the parent workitem

processInstanceId

string

Specifies the ID of the process instance to which this workitem belongs

processId

string

Specifies the ID of the process definition version which has been instantiated

processName

string

Specifies the name of the process

label

string

Specifies the value of the activity label attribute

processValues

Parameter [ ]

Specifies an array of process attributes and their values

These are the process attributes that have been marked as external.

nodeId

string

Specifies the ID of the node for which this workitem has been created

nodeName

string

Specifies the name of the node

nodeDescription

string

Specifies the contents of the node description field

This can be used to provide additional information to the actor.

executionId

string

 

iteration

int

In the case of an iteration node, contains the iteration number

controlAttribute

string

In the case of an iteration node, specifies the name of the variable that is being iterated over if this workitem is part of an iteration

controlValue

string

In the case of an iteration node, specifies the value of the controlAttribute when this workitem was created

operation

string

Specifies the operation that is to be performed

activated

long

Specifies the date when this workitem was created and activated

completed

long

Specifies the date when this workitem was completed

dueDate

long

Specifies the date when this workitem is due

inputParameters

Parameter [ ]

Specifies an array of input parameters and their values

outputParameters

Parameter [ ]

Specifies an array of output parameters that must be returned by the actor

actor

string

Specifies the actor name

valid

boolean

Specifies whether this workitem is valid

completedBy

string

Specifies who completed the workitem

sendEmail

boolean

Specifies whether to send an email

EmailObject

EmailObject

Specifies email details

Parameter Values - wlService WSDL

Parameter

Type

Description

name

string

Specifies the parameter name

type

int

Specifies the parameter type

Possible values are:

TYPE_STRING

TYPE_BYTE

TYPE_SHORT

TYPE_INTEGER

TYPE_LONG

TYPE_FLOAT

TYPE_DOUBLE

TYPE_BOOLEAN

TYPE_XML

TYPE_LIST

TYPE_DECIMAL

TYPE_DATETIME

TYPE_BIGINTEGER

TYPE_COMPLEX

TYPE_ARRAY

value

Object

Specifies the parameter value

complexTypeQName

Qname

Specifies a qualified name of a complex type as defined in the XML specification

expression

Object

Specifies the expression that makes up a complex type