wfm.GetHistWorkItemRelEntriesByActivity

This job determines all historical entries for the specified work item.

1. Input Parameters

Name Type Required Description

RActivityId

STRING

Yes

Instance ID of the activity

2. Output Parameters

Name Type Dependency Description

HistWorkItemRelEntries

BASE64

—

The requested entries in XML format

3. Return Value

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

4. Example

Structure of HistWorkItemRelEntries:

<HistWorkItemRelEntries>
  <HistWorkItemRelEntry RActivityId="" ActivityName="" OrganisationId=""
                        UserId="" UserName="" Reason="" HistType=""
                        HistId="" EntryNr="" Time=""/>
</HistWorkItemRelEntries>
Table 1. Fields of <HistWorkItemRelEntry>
Attribute Type Description

RActivityId

STRING

Instance ID of the activity

ActivityName

STRING

Name of the activity

OrganisationId

STRING

ID of the organization

UserId

STRING

ID of the user who had the activity in the inbox

UserName

STRING

Name of the user

Reason

INT

Reason why the user had the activity in the inbox:

* 0 = Set up as participant * 1 = Assigned to user due to reminder period * 2 = Assigned by administrator (HistType = 11) / removed (HistType = 12) * 3 = Assigned by script (HistType = 11) / removed (HistType = 12)

HistType

INT

Type of the historical entry:

* 10 = STARTWORKITEM * 11 = PERSONALIZED * 12 = DEPERSONALIZED

HistId

STRING

ID of the historical entry

EntryNr

INT

Reflects the temporal sequence

Time

INT

Creation time of the entry

5. See Also

wfm.GetHistWorkItemRelActivitiesByProcess