wfm.GetRunningActivities

Liefert ausschließlich Aktivitäten, die für den angegebenen Benutzer aktuell im started-Zustand sind. Aktivitäten, die lediglich personalisiert, aber noch nicht gestartet wurden, sind nicht enthalten — für den vollständigen Eingangskorb siehe wfm.GetWorkItemList.

1. Eingabeparameter

Name Typ Pflicht Beschreibung

OrganisationId

STRING (GUID)

Ja

ID der Organisation. Muss gesetzt sein — leerer Wert führt zu Fehler -1043267169 mit Meldung GUID 'OrganisationId' is not set.

UserId

STRING (GUID)

Ja

Workflow-Organisations-Objekt-ID des Benutzers (NICHT die User-ID — Ermittlung über wfm.GetOrganisationObjects, gefiltert nach der User-Klassen-ID). Muss gesetzt sein — leerer Wert führt zu Fehler -1043267169 mit Meldung GUID 'UserId' is not set.

ClientTypeId

STRING (GUID)

Ja

ID des verwendeten Clienttyps. Muss gesetzt sein — leerer Wert führt zu Fehler -1043267169 mit Meldung GUID 'ClientTypeId' is not set.

2. Ausgabeparameter

Name Typ Abhängigkeit Beschreibung

RunningActivities

BASE64

—

Liste mit Daten aller laufenden Aktivitäten des Benutzers im XML-Format (siehe Hinweis)

3. Rückgabe

(INT): 0 = Job erfolgreich, sonst Fehlercode.

4. Hinweis

Aufbau von 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>
  <Resources/>
</RunningActivities>

RunningActivity — Struktur mit folgenden Elementen:

  • Activity: beschreibt eine laufende Aktivität

    • Id (STRING): ID der Aktivität im Modell

    • RActivityId (STRING): Instanz-ID der Aktivität

    • Name (STRING): Name der Aktivität

    • State (INT): Status der Aktivität

    • ClosureTime (INT): Sperrfrist — gibt an, wie lange die Aktivität noch gesperrt ist

    • OverTime (INT): Flag, das angibt, ob die Aktivität schon hätte erledigt (1) werden müssen

    • ReminderTime (INT): Mahnfrist — gibt an, bis wann die Aktivität erledigt sein soll

    • CanCancel (INT): Derzeit nicht unterstützt — 0 übergeben.

  • User:

    • Name (STRING): Name des personalisierenden Users

  • Process: beschreibt den zugehörigen Prozess

    • Id (STRING): ID des Prozesses

    • Name (STRING): Name des Prozesses

    • WorkflowId (STRING): ID des Workflows

    • Subject (STRING): Betreff des Prozesses

    • CreationTime (INT): Erstellzeitpunkt des Prozesses

    • IconId (INT): Icon-ID des Workflowmodells

    • ObjectId (STRING): ID des Dokuments, das von den Clients in der Vorschau angezeigt werden soll

  • Columns: Liste von Elementen des Typs Column

    • Column: dient zur Anzeige von Workflowvariablen

      • DisplayName (STRING): unter diesem Namen soll die Variable angezeigt werden

      • Value: Wert der Variablen

      • Position (INT): bestimmt die Reihenfolge der Elemente

  • Resources: enthält Lokalisierungen für ResId-Verweise (z. B. Spaltennamen). Ist auch bei leerer Trefferliste vorhanden — eine Antwort mit ausschließlich <Resources/> als Child von <RunningActivities> bedeutet „keine Treffer" und ist kein Fehlersignal.

5. Edge Cases

  • Leerer Wert in einem der drei GUID-Parameter (OrganisationId, UserId, ClientTypeId) → Fehlercode -1043267169 mit Meldung "GUID '<Parametername>' is not set" (siehe Fehlercodes).

  • Abgrenzung zu wfm.GetWorkItemList: GetRunningActivities liefert eine echte Teilmenge — nur Aktivitäten im started-Zustand. Ein Work-Item, das im Eingangskorb liegt und personalisiert (Activity.State enthält Bit 128), aber noch nicht gestartet wurde, erscheint hier nicht.

  • Eine leere Antwort enthält trotzdem ein <Resources/>-Element neben dem Wurzelelement — das ist erwartetes Verhalten.