@camunda8/sdk
Preparing search index...
index
<internal>
SearchElementInstancesRequest
Interface SearchElementInstancesRequest
interface
SearchElementInstancesRequest
{
filter
:
{
elementId
?:
string
;
elementInstanceKey
?:
string
;
elementName
?:
string
;
hasIncident
?:
boolean
;
incidentKey
?:
string
;
processDefinitionId
?:
string
;
processDefinitionKey
?:
string
;
processInstanceKey
?:
string
;
state
?:
"ACTIVE"
|
"COMPLETED"
|
"TERMINATED"
;
tenantId
?:
string
;
type
?:
|
"UNKNOWN"
|
"UNSPECIFIED"
|
"PROCESS"
|
"SUB_PROCESS"
|
"EVENT_SUB_PROCESS"
|
"START_EVENT"
|
"INTERMEDIATE_CATCH_EVENT"
|
"INTERMEDIATE_THROW_EVENT"
|
"BOUNDARY_EVENT"
|
"END_EVENT"
|
"SERVICE_TASK"
|
"RECEIVE_TASK"
|
"USER_TASK"
|
"MANUAL_TASK"
|
"TASK"
|
"EXCLUSIVE_GATEWAY"
|
"INCLUSIVE_GATEWAY"
|
"PARALLEL_GATEWAY"
|
"EVENT_BASED_GATEWAY"
|
"SEQUENCE_FLOW"
|
"MULTI_INSTANCE_BODY"
|
"CALL_ACTIVITY"
|
"BUSINESS_RULE_TASK"
|
"SCRIPT_TASK"
|
"SEND_TASK"
|
"AD_HOC_SUB_PROCESS"
;
}
;
page
?:
SearchPageRequest
;
sort
:
{
field
:
|
"type"
|
"processDefinitionKey"
|
"processInstanceKey"
|
"incidentKey"
|
"tenantId"
|
"state"
|
"elementId"
|
"elementInstanceKey"
|
"processDefinitionId"
|
"startDate"
|
"endDate"
;
order
?:
"ASC"
|
"DESC"
;
}
[]
;
}
Index
Properties
filter
page?
sort
Properties
filter
filter
:
{
elementId
?:
string
;
elementInstanceKey
?:
string
;
elementName
?:
string
;
hasIncident
?:
boolean
;
incidentKey
?:
string
;
processDefinitionId
?:
string
;
processDefinitionKey
?:
string
;
processInstanceKey
?:
string
;
state
?:
"ACTIVE"
|
"COMPLETED"
|
"TERMINATED"
;
tenantId
?:
string
;
type
?:
|
"UNKNOWN"
|
"UNSPECIFIED"
|
"PROCESS"
|
"SUB_PROCESS"
|
"EVENT_SUB_PROCESS"
|
"START_EVENT"
|
"INTERMEDIATE_CATCH_EVENT"
|
"INTERMEDIATE_THROW_EVENT"
|
"BOUNDARY_EVENT"
|
"END_EVENT"
|
"SERVICE_TASK"
|
"RECEIVE_TASK"
|
"USER_TASK"
|
"MANUAL_TASK"
|
"TASK"
|
"EXCLUSIVE_GATEWAY"
|
"INCLUSIVE_GATEWAY"
|
"PARALLEL_GATEWAY"
|
"EVENT_BASED_GATEWAY"
|
"SEQUENCE_FLOW"
|
"MULTI_INSTANCE_BODY"
|
"CALL_ACTIVITY"
|
"BUSINESS_RULE_TASK"
|
"SCRIPT_TASK"
|
"SEND_TASK"
|
"AD_HOC_SUB_PROCESS"
;
}
Optional
page
page
?:
SearchPageRequest
sort
sort
:
{
field
:
|
"type"
|
"processDefinitionKey"
|
"processInstanceKey"
|
"incidentKey"
|
"tenantId"
|
"state"
|
"elementId"
|
"elementInstanceKey"
|
"processDefinitionId"
|
"startDate"
|
"endDate"
;
order
?:
"ASC"
|
"DESC"
;
}
[]
Type declaration
field
:
|
"type"
|
"processDefinitionKey"
|
"processInstanceKey"
|
"incidentKey"
|
"tenantId"
|
"state"
|
"elementId"
|
"elementInstanceKey"
|
"processDefinitionId"
|
"startDate"
|
"endDate"
The field to sort by.
Optional
order
?:
"ASC"
|
"DESC"
Default: ASC
Settings
Member Visibility
Protected
Inherited
Theme
OS
Light
Dark
On This Page
Properties
filter
page
sort
@camunda8/sdk
Loading...
The field to sort by.