wfm.GetHistProcessList

Dieser Job ermittelt zu einem historischen Workflowmodell alle Prozesse.

1. Eingabeparameter

Name Typ Pflicht Beschreibung

Name	Typ	Pflicht	Beschreibung
`OrganisationId`	STRING	Ja	ID der Organisation
`HistWorkfowId`	STRING	Ja	Historische ID des Modells
`[ChunkSize]`	INT	Nein	Anzahl der Prozesse, die mit einer Anfrage maximal zurückgegeben werden sollen. Standard: `0` gibt alle Prozesse zurück.
`[OrderColumn]`	STRING	Nein	Spalte, nach der die Ergebnisliste sortiert wird. Mögliche Werte: `processname`, `creationtime` (Standard), `endtime`. Als zweites Sortierkriterium wird immer die Prozess-ID verwendet.
`[Order]`	INT	Nein	Sortierrichtung: `1` = aufsteigend (Standard), `2` = absteigend.
`[LastFetchedProcessId]`	STRING	Nein	Benötigt für Paging. Die letzte `ProcessId`, die in der Trefferliste zurückgegeben wurde, muss im neuen Aufruf übergeben werden, um die Liste erst nach dem vorigen Chunk starten zu lassen. Nur bei Angabe von `ChunkSize` notwendig.
`[LastFetchedOrderValue]`	STRING	Nein	Benötigt für Paging. Sollte der letzte Wert der sortierten Spalte aus einem vorherigen Aufruf mit `ChunkSize` sein. Kann ein numerischer Wert oder eine Zeichenfolge sein. Ist dieser Parameter nicht angegeben, wird der Wert der Spalte mit der entsprechenden Prozess-ID abgerufen. Erfordert eine gesetzte `LastFetchedProcessId`.
`[States]`	INT	Nein	Status der Prozesse, die angezeigt werden sollen. Andere Status werden ausgefiltert. Ist der Parameter nicht gesetzt oder `0`, werden alle Status angezeigt. Werte werden verodert angegeben: `0x10 (16)` = TERMINATED `0x20 (32)` = COMPLETED `0x30 (48)` = TERMINATED / COMPLETED
`[Filter]`	STRING	Nein	Filtertext für den Prozessnamen. Wenn angegeben, werden nur Prozesse zurückgegeben, deren Name diesen String an beliebiger Stelle enthält.

OrganisationId

STRING

ID der Organisation

HistWorkfowId

STRING

Historische ID des Modells

[ChunkSize]

INT

Nein

Anzahl der Prozesse, die mit einer Anfrage maximal zurückgegeben werden sollen. Standard: 0 gibt alle Prozesse zurück.

[OrderColumn]

STRING

Nein

Spalte, nach der die Ergebnisliste sortiert wird. Mögliche Werte: processname, creationtime (Standard), endtime. Als zweites Sortierkriterium wird immer die Prozess-ID verwendet.

[Order]

INT

Nein

Sortierrichtung: 1 = aufsteigend (Standard), 2 = absteigend.

[LastFetchedProcessId]

STRING

Nein

Benötigt für Paging. Die letzte ProcessId, die in der Trefferliste zurückgegeben wurde, muss im neuen Aufruf übergeben werden, um die Liste erst nach dem vorigen Chunk starten zu lassen. Nur bei Angabe von ChunkSize notwendig.

[LastFetchedOrderValue]

STRING

Nein

Benötigt für Paging. Sollte der letzte Wert der sortierten Spalte aus einem vorherigen Aufruf mit ChunkSize sein. Kann ein numerischer Wert oder eine Zeichenfolge sein. Ist dieser Parameter nicht angegeben, wird der Wert der Spalte mit der entsprechenden Prozess-ID abgerufen. Erfordert eine gesetzte LastFetchedProcessId.

[States]

INT

Nein

Status der Prozesse, die angezeigt werden sollen. Andere Status werden ausgefiltert. Ist der Parameter nicht gesetzt oder 0, werden alle Status angezeigt. Werte werden verodert angegeben:

0x10 (16) = TERMINATED
0x20 (32) = COMPLETED
0x30 (48) = TERMINATED / COMPLETED

[Filter]

STRING

Nein

Filtertext für den Prozessnamen. Wenn angegeben, werden nur Prozesse zurückgegeben, deren Name diesen String an beliebiger Stelle enthält.

2. Ausgabeparameter

Name Typ Abhängigkeit Beschreibung

Name	Typ	Abhängigkeit	Beschreibung
`Processes`	BASE64	—	Die angeforderten Prozesse im XML-Format

Processes

BASE64

—

Die angeforderten Prozesse im XML-Format

3. Rückgabe

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

4. Beispiel

Aufbau von Processes:

<Processes>
  <Process Id=".." Name=".." FinalSubject=".." UserName=".." CreationTime=".."
           EndTime=".."/>
  <Process Id=".." Name=".." FinalSubject=".." UserName=".." CreationTime=".."
           EndTime=".."/>
</Processes>

Table 1. Felder von `<Process>`
Attribut	Typ	Beschreibung
`Id`	STRING	ID des Prozesses
`Name`	STRING	Name des Prozesses
`FinalSubject`	STRING	Letzter Betreff des Prozesses
`UserName`	STRING	Name des Prozesserstellers
`CreationTime`	STRING	Startzeit des Prozesses
`EndTime`	STRING	Endzeit des Prozesses

5. Siehe auch

wfm.GetHistWorkflowList, wfm.GetHistActivitiesByProcess, wfm.GetHistEntries, wfm.GetHistTimersByProcess