Skip to main content
Version: 2026.0

LoadProcessInstanceConfig

Methods

active

active(pActive): LoadProcessInstanceConfig

Fetch only an active or only a suspended instance

Parameters

pActive
boolean

whether the instance must be active or suspended

Returns

LoadProcessInstanceConfig

current object


category

category(pCategory): CommonLoadProcessInstancesConfig

Fetch only process instances with the given category

Parameters

pCategory
string | number | boolean

the category

Returns

CommonLoadProcessInstancesConfig

current object


processDefinitionId

processDefinitionId(pProcessDefinitionId): CommonLoadProcessInstancesConfig

Fetch only process instances with the given process definition id

Parameters

pProcessDefinitionId
string | number | boolean

the process definition id

Returns

CommonLoadProcessInstancesConfig

current object


processDefinitionKey

processDefinitionKey(pProcessDefinitionKey): CommonLoadProcessInstancesConfig

Fetch only process instances with the given process definition key

Parameters

pProcessDefinitionKey
string | number | boolean

the process definition key

Returns

CommonLoadProcessInstancesConfig

current object


processInstanceId

processInstanceId(pProcessInstanceId): LoadProcessInstanceConfig

Fetch only a process instance with the given id

Parameters

pProcessInstanceId
string | number | boolean

the id of the instance

Returns

LoadProcessInstanceConfig

current object


variables

variables(pVariables): CommonLoadProcessInstancesConfig

Fetch only process instances that have the given variable values set

Parameters

pVariables
any

the values the variables have to have

Returns

CommonLoadProcessInstancesConfig

current object