ProcessInstanceMethods

Methods

cancel()

cancel(options?: ProcessInstanceOperationOptions): Promise<OperationResponse<ProcessInstanceOperationResponse>>

Cancels this process instance

Parameters

Parameter	Type	Description
options?	ProcessInstanceOperationOptions	Optional cancellation options with comment

Returns

Promise<OperationResponse<ProcessInstanceOperationResponse>>

Promise resolving to operation result

---

getBpmn()

getBpmn(): Promise<string>

Gets BPMN XML file for this process instance

Returns

Promise<string>

Promise resolving to BPMN XML file

---

getExecutionHistory()

getExecutionHistory(): Promise<ProcessInstanceExecutionHistoryResponse[]>

Gets execution history (spans) for this process instance

Returns

Promise<ProcessInstanceExecutionHistoryResponse[]>

Promise resolving to execution history

---

getIncidents()

getIncidents(): Promise<ProcessIncidentGetResponse[]>

Gets incidents for this process instance

Returns

Promise<ProcessIncidentGetResponse[]>

Promise resolving to array of incidents for this instance

---

getVariables()

getVariables(options?: ProcessInstanceGetVariablesOptions): Promise<ProcessInstanceGetVariablesResponse>

Gets global variables for this process instance

Parameters

Parameter	Type	Description
options?	ProcessInstanceGetVariablesOptions	Optional options including parentElementId to filter by parent element

Returns

Promise<ProcessInstanceGetVariablesResponse>

Promise resolving to variables response with elements and globals

---

pause()

pause(options?: ProcessInstanceOperationOptions): Promise<OperationResponse<ProcessInstanceOperationResponse>>

Pauses this process instance

Parameters

Parameter	Type	Description
options?	ProcessInstanceOperationOptions	Optional pause options with comment

Returns

Promise<OperationResponse<ProcessInstanceOperationResponse>>

Promise resolving to operation result

---

resume()

resume(options?: ProcessInstanceOperationOptions): Promise<OperationResponse<ProcessInstanceOperationResponse>>

Resumes this process instance

Parameters

Parameter	Type	Description
options?	ProcessInstanceOperationOptions	Optional resume options with comment

Returns

Promise<OperationResponse<ProcessInstanceOperationResponse>>

Promise resolving to operation result