wfm.GetEvents

This job returns the list of all established events for an activity or the entire workflow model.

1. Input Parameters

Name Type Required Description

OrganisationId

STRING

Yes

ID of the organization

WorkflowId

STRING

Yes

ID of the workflow model

ActivityId

STRING

Yes

ID of the activity. If this parameter is left empty, all events of the workflow model are returned.

ClientTypeId

STRING

Yes

ID of the client type used. If this parameter is left empty, events for all defined client types are returned.

EventTypeGroups

INT

Yes

Combinable flag indicating which events are requested.
1 = all client events are returned
2 = the global client script is returned
4 = all server events are returned
8 = the global server script is returned
15 = all events are returned

Code

INT

Yes

0 = no script code is transferred; 1 = script code is transferred

2. Output Parameters

Name Type Dependency Description

Events

BASE64

—

Requested event list in XML format (see note)

3. Return Value

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

4. See Also

wfm.SaveEvent, wfm.DeleteEvent

5. Note

Structure of Events
<Events>
  <Event>
    <Id></Id>
    <EventType></EventType>
    <ActivityId></ActivityId>
    <Params></Params>
    <Description></Description>
    <ClientTypeId></ClientTypeId>
    <Script Id="" Name="" Time="" Description="" ScriptLanguage="1">Skript</Script>
  </Event>
</Events>

Event — contains additional elements and the Script structure:

  • Id (STRING): ID of the event

  • EventType (INT): Type of the event
    1 = BeforeForward, 2 = AfterForward, 3 = BeforeForwardTo, 4 = ButtonClick,
    5 = BeforeOpen, 6 = AfterSignature, 7 = BeforeCancel, 8 = SimulateMaskEdit,
    10000 = StartActivity, 10001 = EndActivity, 10003 = PersonalizeWorkItem,
    10004 = GetWorkItemParams, 1000000 = Global server script, 1000001 = Global client script

  • Params: for event type ButtonClick this contains the ID of the button

  • Description (STRING): Currently not supported — pass 0.

  • ActivityId (STRING): ID of the activity for which the event was created

  • ClientTypeId (STRING): ID of the client type for which the event was created

  • Script: Structure containing the script:

    • Id (STRING): ID of the script

    • Name (STRING): Name of the script

    • Time (INT): Creation time of the script

    • Description (STRING): Currently not supported — pass 0.

    • ScriptLanguage (INT): Script language (1 = VB-Script, 2 = J-Script)

    • CDATA: Data (contains the script code)