wfm.GetRunningActivities

This job returns all activities to be processed for a specific user.

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

2. Output Parameters

Name Type Dependency Description

RunningActivities

BASE64

—

List of data for all running activities of the user in XML format (see note)

3. Return Value

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

4. Note

Structure of RunningActivities
<RunningActivities>
  <RunningActivity>
    <Activity Id="" RActivityId="" Name="" State="" ClosureTime="" OverTime=""
      ReminderTime="" CanCancel=""/>
    <User Name=""/>
    <Process Id="" Name="" WorkflowId="" Subject="" CreationTime="" IconId="" ObjectId=""/>
    <Columns>
      <Column DisplayName="" Value="" Position=""/>
    </Columns>
  </RunningActivity>
</RunningActivities>

RunningActivity — structure with the following elements:

  • Activity: describes a running activity

    • Id (STRING): ID of the activity in the model

    • RActivityId (STRING): instance ID of the activity

    • Name (STRING): name of the activity

    • State (INT): status of the activity

    • ClosureTime (INT): lock period — indicates how long the activity is still locked

    • OverTime (INT): flag indicating whether the activity should have been completed (1)

    • ReminderTime (INT): reminder period — indicates until when the activity should be completed

    • CanCancel (INT): currently not supported — pass 0.

  • User:

    • Name (STRING): name of the user who personalized

  • Process: describes the associated process

    • Id (STRING): ID of the process

    • Name (STRING): name of the process

    • WorkflowId (STRING): ID of the workflow

    • Subject (STRING): subject of the process

    • CreationTime (INT): creation time of the process

    • IconId (INT): icon ID 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