wfm.AdminSuspendProcess

This job suspends a process. No activities of the process can be processed anymore.

1. Input Parameters

Name Type Required Description

Name	Type	Required	Description
`ProcessId`	STRING	Yes	ID of the process
`UserId`	STRING	Yes	ID of the user performing the action

ProcessId

STRING

Yes

ID of the process

UserId

STRING

Yes

ID of the user performing the action

2. Output Parameters

Name Type Dependency Description

Name	Type	Dependency	Description
`State`	INT	—	Status of the process before suspension: * `0` — neutral value * `1` — process is initialized * `2` — process is running * `3` — process was suspended * `4` — process is active * `5` — process is terminated * `6` — process is finished * `7` — process was suspended by the system (error occurred)

State

INT

—

Status of the process before suspension:

* 0 — neutral value * 1 — process is initialized * 2 — process is running * 3 — process was suspended * 4 — process is active * 5 — process is terminated * 6 — process is finished * 7 — process was suspended by the system (error occurred)

3. Return Value

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

4. See Also

wfm.AdminResumeProcess