Zeebe.Client.Api.Commands.IModifyProcessInstanceCommandStep1 Interface Reference

Command to modify a process instance. More...

Public Member Functions
IModifyProcessInstanceCommandStep3	ActivateElement (string elementId)
	Create an activate Instruction for the given element id. The element will be created within an existing element instance of the flow scope. When activating an element inside a multi-instance element the element instance key of the ancestor must be defined. For this use ActivateElement(string, long).
IModifyProcessInstanceCommandStep3	ActivateElement (string elementId, long ancestorElementInstanceKey)
	Create an activate Instruction for the given element id. The element will be created within the scope that is passed. This scope must be an ancestor of the element that's getting activated.
IModifyProcessInstanceCommandStep2	TerminateElement (long elementInstanceKey)
	Create a terminate instruction for the given element id.

Detailed Description

Command to modify a process instance.

Member Function Documentation

ActivateElement() [1/2]

IModifyProcessInstanceCommandStep3 Zeebe.Client.Api.Commands.IModifyProcessInstanceCommandStep1.ActivateElement

(

string

elementId

)

Create an activate Instruction for the given element id. The element will be created within an existing element instance of the flow scope. When activating an element inside a multi-instance element the element instance key of the ancestor must be defined. For this use ActivateElement(string, long).

Parameters

elementId

The id of the element to activate.

Returns

The builder for this command.

ActivateElement() [2/2]

IModifyProcessInstanceCommandStep3 Zeebe.Client.Api.Commands.IModifyProcessInstanceCommandStep1.ActivateElement	(	string	elementId,
		long	ancestorElementInstanceKey
	)

Create an activate Instruction for the given element id. The element will be created within the scope that is passed. This scope must be an ancestor of the element that's getting activated.

Parameters

elementId	The id of the element to activate.
ancestorElementInstanceKey	The element instance key in which the element will be created.

Returns

The builder for this command.

TerminateElement()

IModifyProcessInstanceCommandStep2 Zeebe.Client.Api.Commands.IModifyProcessInstanceCommandStep1.TerminateElement

(

long

elementInstanceKey

)

Create a terminate instruction for the given element id.

Parameters

elementInstanceKey

The element instance key of the element to terminate.

Returns

the builder for this command.

---

The documentation for this interface was generated from the following file:

• Client/Api/Commands/IModifyProcessInstanceCommandStep1.cs