wfm.AdminGetProcessListByUser

This job returns all processes for a user ID where work items are currently in the inbox.

1. Input Parameters

Name Type Required Description

OrganisationId

STRING (GUID)

Yes

ID of the organisation.

UserId

STRING (GUID)

Yes

Workflow-organisation user object ID — NOT the user ID returned by mng.GetUserList. Resolve via wfm.GetOrganisationObjects filtered by ClassIds of the user class (typically 9AB24246BB9040A29FCD6015CF4F4BD9).

2. Return Value

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

3. Output Parameters

Name Type Dependency Description

Processes

BASE64

—

Contains requested information in XML format.
Structure of Processes
<Processes>
  <Process Id="" Name="" Subject="" State="">
    <Creation UserId="" UserName="" Time=""/>
    <Activity CreationTime="" Name="" Id="" ReminderTime=""
              OwnerTime="" WICreationTime="" State=""/>
  </Process>
</Processes>
Detailed description of attributes and elements:
Id (STRING) — ID of the process.
Name (STRING) — Name of the process.
Subject (STRING) — Subject of the process.
State (INT) — State of the process: 1 = INIT, 2 = RUNNING, 4 = SUSPENDED, 8 = ACTIVE, 16 = TERMINATED, 32 = COMPLETED, 64 = SYSSUSPENDED.
Creation — Information about creation: UserId (STRING) creator’s user ID, UserName (STRING) creator’s username, Time (INT) process creation time.
Activity — Information about the activity: CreationTime (INT) creation time, Name (STRING) name of the activity, Id (STRING) ID of the activity, ReminderTime (INT) reminder period (0 = no reminder period), WICreationTime (INT) time when the work item was created in the inbox.
Activity.Owner (STRING, optional) — Name of the user who personalised the work item. Not delivered in every call context / server version — in observed responses the attribute can be absent even when the activity is personalised.
Activity.OwnerId (STRING, optional) — ID of that user. Same caveat as Owner.
Activity.OwnerTime (INT) — Unix timestamp of the personalisation. 0 indicates the activity is not currently personalised; the value is reset when personalisation is withdrawn.
Activity.State (INT) — Bitmask. Full bit list see wfm.AdminGetProcessActivities.

4. See Also

wfm.GetOrganisations, wfm.AdminGetUserProcesses, wfm.AdminGetProcessActivities, wfm.AdminDeleteProcesses