wfm.AdminSuspendActivity

This job suspends an activity. The activity cannot be processed afterwards.

1. Input Parameters

Name Type Required Description

RActivityId

STRING

Yes

Instance ID of the activity

UserId

STRING

Yes

ID of the user performing the action

2. Output Parameters

Name Type Dependency Description

State

INT

Status of the activity before suspension (bitmask):

* 0x00000001 (1) — The activity was initialized. * 0x00000002 (2) — The activity was started (e.g. variables were created). * 0x00000004 (4) — The StartActivity event was executed. * 0x00000008 (8) — The EndActivity event was executed. * 0x00000010 (16) — Only for loops: The loop condition was checked. * 0x00000020 (32) — Only for loops: The loop body is being processed. * 0x00000040 (64) — Only for work steps: The work step is ready in the inbox. * 0x00000080 (128) — Only for work steps: The work step is personalized. * 0x00000100 (256) — Waiting for the expiration of a lock period. * 0x00000400 (1024) — The activity was executed (e.g. a work step was forwarded or a loop activity was completely processed). * 0x00000800 (2048) — Subsequent activities were calculated and possibly already created. * 0x00001000 (4096) — The activity is finished, but no subsequent activities have been initiated yet. * 0x00002000 (8192) — The activity was suspended by a user. * 0x00004000 (16384) — The activity is finished. * 0x00008000 (32768) — Only for multi-instance activities: The activity was created. * 0x00010000 (65536) — Only for ad-hoc activities: The ad-hoc activity was created. * 0x00020000 (131072) — Activity canceled. * 0x00040000 (262144) — Only for ad-hoc activities: The ad-hoc activity is being executed. * 0x10000000 (268435456) — The activity was suspended by the system due to an error.

3. Return Value

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