wfm.GetWorkItemList

This job returns a list of all work items for which the specified user is configured as a participant and the work item is not yet personalized by another participant.

1. Input Parameters

Name Type Required Description

OrganisationId

STRING

Yes

ID of the organization

UserId

STRING

Yes

ID of the user

ClientTypeId

STRING

Yes

ID of the client type used

Flags

INT

Yes

With flags, the requested work items can be limited.
1 = INITIATED
2 = RUNNING
4 = SUSPENDED
16 = TERMINATED
32 = COMPLETED
64 = INUSE

2. Output Parameters

Name Type Dependency Description

WorkItems

BASE64

—

List of requested work items in XML format (see note)

3. Return Value

(INT): 0 = Job successful, otherwise error code.

4. See Also

wfm.GetWorkItem, wfm.StartWorkItem, wfm.GetWorkItemParams

5. Note

Structure of WorkItems
<WorkItems>
  <WorkItem Id="" State="" Personalized="" ProcessId="" ProcessName=""
    ProcessSubject="" ActivityId="" ActivityName="" WarningTime="" OverTime=""
    CreationTime="" WorkflowId="" Substitute="" IconId="" WorkflowType="2"
    WorkflowVersion="5" ObjectId="32">
    <Columns>
      <Column DisplayName="" Value="" Position=""/>
    </Columns>
  </WorkItem>
</WorkItems>

WorkItem — describes a work item:

  • Id (STRING): ID of the work item

  • State (INT): Status of the work item
    1 = INITIATED, 2 = RUNNING, 4 = SUSPENDED, 16 = TERMINATED, 32 = COMPLETED, 64 = INUSE

  • Personalized (STRING): Name of the user who personalized this item

  • ProcessId (STRING): Process ID

  • ProcessName (STRING): Process name

  • ProcessSubject (STRING): Process subject

  • ActivityId (STRING): Instance ID of the activity

  • ActivityName (STRING): Name of the activity

  • WarningTime (INT): Reminder period

  • OverTime (INT): Flag indicating whether the item should have been completed (1)

  • CreationTime (INT): Creation time of the activity

  • WorkflowId (STRING): Workflow ID

  • IconId (INT): Icon ID of the workflow model

  • Substitute (INT): 1 = user gets the work item as substitute, otherwise 0

  • WorkflowType (INT): 1 = ProductionWorkflow, 2 = Adhoc-Workflow

  • WorkflowVersion (INT): Version number of the workflow model

  • ObjectId (STRING): ID of the document to be displayed in preview by clients

  • Columns: List of elements of type Column

    • Column: used for displaying workflow variables

      • DisplayName (STRING): the variable should be displayed under this name

      • Value: value of the variable

      • Position (INT): determines the order of the elements