wfm.AdminGetProcessListByRole

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

1. Input Parameters

Name Type Required Description

OrganisationId

STRING

Yes

ID of the organization.

RoleId

STRING

Yes

ID of the role.

2. Return Value

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

3. Output Parameters

Name Type Dependency Description

Processes

BASE64

List of all work items in the inbox in XML format.

Structure of Processes
<Processes>
  <Process Id="" Name="" Subject="" State="">
    <Creation UserId="" UserName="" Time=""/>
    <Activity CreationTime="" Name="" Id="" Owner="" OwnerId=""
              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, Owner (STRING) name of the user who personalized the work item, OwnerId (STRING) ID of this user, ReminderTime (INT) reminder period (0 = no reminder period), OwnerTime (INT) time of personalization, WICreationTime (INT) time when the work item was created in the inbox.
Activity.State (INT) — Bitmask, status values identical to those in wfm.AdminGetProcessActivities.