Skip to main content
Version: 2025.2

LoadHistoricProcessInstancesConfig

Methods

category

category(pCategory): CommonLoadProcessInstancesConfig

Fetch only process instances with the given category

Parameters

pCategory
string | number | boolean

the category

Returns

CommonLoadProcessInstancesConfig

current object


finished

finished(pFinished): LoadHistoricProcessInstancesConfig

Fetch only historic process instances that are finished or unfinished

Parameters

pFinished
boolean

true for finished instances, false for unfinished ones

Returns

LoadHistoricProcessInstancesConfig

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): LoadHistoricProcessInstancesConfig

Fetch only historic process instances with one of the given ids

Parameters

pProcessInstanceIds
string[]

the ids of the instances

Returns

LoadHistoricProcessInstancesConfig

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