wfm.GetHistProcessList

This job determines all processes for a historical workflow model.

1. Input Parameters

Name Type Required Description

Name	Type	Required	Description
`OrganisationId`	STRING	Yes	ID of the organization
`HistWorkfowId`	STRING	Yes	Historical ID of the model
`[ChunkSize]`	INT	No	Number of processes to be returned with a request at most. Default: `0` returns all processes.
`[OrderColumn]`	STRING	No	Column by which the result list is sorted. Possible values: `processname`, `creationtime` (default), `endtime`. The process ID is always used as a secondary sorting criterion.
`[Order]`	INT	No	Sorting direction: `1` = ascending (default), `2` = descending.
`[LastFetchedProcessId]`	STRING	No	Required for paging. The last `ProcessId` returned in the hit list must be passed in the new call to start the list after the previous chunk. Only necessary when specifying `ChunkSize`.
`[LastFetchedOrderValue]`	STRING	No	Required for paging. Should be the last value of the sorted column from a previous call with `ChunkSize`. Can be a numeric value or a string. If this parameter is not specified, the value of the column with the corresponding process ID is retrieved. Requires a set `LastFetchedProcessId`.
`[States]`	INT	No	Status of processes to be displayed. Other statuses are filtered out. If the parameter is not set or `0`, all statuses are displayed. Values are specified as deprecated: * `0x10 (16)` = TERMINATED * `0x20 (32)` = COMPLETED * `0x30 (48)` = TERMINATED / COMPLETED
`[Filter]`	STRING	No	Filter text for the process name. If specified, only processes whose name contains this string anywhere are returned.

OrganisationId

STRING

Yes

ID of the organization

HistWorkfowId

STRING

Yes

Historical ID of the model

[ChunkSize]

INT

Number of processes to be returned with a request at most. Default: 0 returns all processes.

[OrderColumn]

STRING

Column by which the result list is sorted. Possible values: processname, creationtime (default), endtime. The process ID is always used as a secondary sorting criterion.

[Order]

INT

Sorting direction: 1 = ascending (default), 2 = descending.

[LastFetchedProcessId]

STRING

Required for paging. The last ProcessId returned in the hit list must be passed in the new call to start the list after the previous chunk. Only necessary when specifying ChunkSize.

[LastFetchedOrderValue]

STRING

Required for paging. Should be the last value of the sorted column from a previous call with ChunkSize. Can be a numeric value or a string. If this parameter is not specified, the value of the column with the corresponding process ID is retrieved. Requires a set LastFetchedProcessId.

[States]

INT

Status of processes to be displayed. Other statuses are filtered out. If the parameter is not set or 0, all statuses are displayed. Values are specified as deprecated: * 0x10 (16) = TERMINATED * 0x20 (32) = COMPLETED * 0x30 (48) = TERMINATED / COMPLETED

[Filter]

STRING

Filter text for the process name. If specified, only processes whose name contains this string anywhere are returned.

2. Output Parameters

Name Type Dependency Description

Name	Type	Dependency	Description
`Processes`	BASE64	—	The requested processes in XML format

Processes

BASE64

—

The requested processes in XML format

3. Return Value

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

4. Example

Structure of Processes:

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

Table 1. Fields of `<Process>`
Attribute	Type	Description
`Id`	STRING	ID of the process
`Name`	STRING	Name of the process
`FinalSubject`	STRING	Last subject of the process
`UserName`	STRING	Name of the process creator
`CreationTime`	STRING	Start time of the process
`EndTime`	STRING	End time of the process

wfm.GetHistProcessList

1. Input Parameters

2. Output Parameters

3. Return Value

4. Example

5. See Also