wfm.AdminGetProcessList

This job returns a list of all running processes for a workflow model.

1. Input Parameters

Name Type Required Description

OrganisationId

STRING

Yes

ID of the organization.

WorkflowId

STRING

Yes

ID of the workflow model.

ChunkSize

INT

Yes

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

OrderColumn

STRING

Yes

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

Order

INT

Yes

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

[LastFetchedProcessId]

STRING

No

For paging: The last process ID returned in the hit list. Pass in new call so that list starts after previous chunk. Only necessary when paging with ChunkSize.

[LastFetchedOrderValue]

STRING

No

For paging: The last value of the sorted column from a previous call with ChunkSize. Numeric or string values possible. Requires a fixed LastFetchedProcessId.

[States]

INT

No

States of processes to be displayed (bitmask). 0 or not set = all states. Available values (deprecated): INIT 0x01 (1), RUNNING 0x02 (2), SUSPENDED 0x04 (4), ACTIVE 0x08 (8), TERMINATED 0x10 (16), COMPLETED 0x20 (32), SYSSUSPENDED 0x40 (64).

[Filter]

STRING

No

Filter text for the process name. Only processes containing this string anywhere in the name are returned.

2. Return Value

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

3. Output Parameters

Name Type Dependency Description

Processes

BASE64

—

List of all running processes in XML format.
Structure of Processes
<Processes>
  <Process Id="" Name="" Subject="" State="" SuspendedActivity="">
    <Creation UserId="" UserName="" Time=""/>
    <LastActivity ExecTime="" Name="" Id="" UserId="" UserName=""/>
  </Process>
</Processes>
Detailed description of attributes and elements:
Id (STRING) — ID of a process.
Name (STRING) — Name of a process.
Subject (STRING) — Subject of the process.
State (INT) — State of a process: 1 = INIT, 2 = RUNNING, 4 = SUSPENDED, 8 = ACTIVE, 16 = TERMINATED, 32 = COMPLETED, 64 = SYSSUSPENDED (process was suspended by engine, e.g. due to an error in the event script).
SuspendedActivity (INT) — 1 = at least one activity of the process is suspended, otherwise 0.
Creation — Information about process creation: UserId (STRING) creator’s user ID, UserName (STRING) creator’s username, Time (INT) creation time.
LastActivity — Information about the last use of the process: ExecTime (INT) last execution time, Name (STRING) name of the last executed activity, Id (STRING) ID of the last executed activity, UserId (STRING) executor’s ID, UserName (STRING) executor’s name.

4. See Also

wfm.AdminGetWorkflowList, wfm.GetOrganisations, wfm.AdminDeleteProcesses