Skip to main content
Version: 2026.0

LoadProcessInstancesConfig

Methods​

active​

active(pActive): LoadProcessInstancesConfig

Fetch only process instances that are active/suspended

Parameters​

pActive
boolean

whether to load active or suspended instances

Returns​

LoadProcessInstancesConfig

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


processInstanceIds​

processInstanceIds(pProcessInstanceIds): LoadProcessInstancesConfig

Fetch only process instances with one of the given ids

Parameters​

pProcessInstanceIds
string[]

the ids of the instances

Returns​

LoadProcessInstancesConfig

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