@camunda8/orchestration-cluster-api
Preparing search index...
index
SearchProcessInstancesData
Type Alias SearchProcessInstancesData
type
SearchProcessInstancesData
=
{
body
?:
SearchQueryRequest
&
{
filter
?:
BaseProcessInstanceFilterFields
&
{
processDefinitionId
?:
StringFilterProperty
;
processDefinitionKey
?:
ProcessDefinitionKeyFilterProperty
;
processDefinitionName
?:
StringFilterProperty
;
processDefinitionVersion
?:
IntegerFilterProperty
;
processDefinitionVersionTag
?:
StringFilterProperty
;
}
&
{
$or
?:
(
BaseProcessInstanceFilterFields
&
{
processDefinitionId
?:
StringFilterProperty
;
processDefinitionKey
?:
ProcessDefinitionKeyFilterProperty
;
processDefinitionName
?:
StringFilterProperty
;
processDefinitionVersion
?:
IntegerFilterProperty
;
processDefinitionVersionTag
?:
StringFilterProperty
;
}
)
[]
;
}
;
sort
?:
{
field
:
|
"processInstanceKey"
|
"processDefinitionId"
|
"processDefinitionName"
|
"processDefinitionVersion"
|
"processDefinitionVersionTag"
|
"processDefinitionKey"
|
"parentProcessInstanceKey"
|
"parentElementInstanceKey"
|
"startDate"
|
"endDate"
|
"state"
|
"hasIncident"
|
"tenantId"
;
order
?:
SortOrderEnum
;
}
[]
;
}
;
path
?:
never
;
query
?:
never
;
url
:
"/process-instances/search"
;
}
Index
Properties
body?
path?
query?
url
Properties
Optional
body
body
?:
SearchQueryRequest
&
{
filter
?:
BaseProcessInstanceFilterFields
&
{
processDefinitionId
?:
StringFilterProperty
;
processDefinitionKey
?:
ProcessDefinitionKeyFilterProperty
;
processDefinitionName
?:
StringFilterProperty
;
processDefinitionVersion
?:
IntegerFilterProperty
;
processDefinitionVersionTag
?:
StringFilterProperty
;
}
&
{
$or
?:
(
BaseProcessInstanceFilterFields
&
{
processDefinitionId
?:
StringFilterProperty
;
processDefinitionKey
?:
ProcessDefinitionKeyFilterProperty
;
processDefinitionName
?:
StringFilterProperty
;
processDefinitionVersion
?:
IntegerFilterProperty
;
processDefinitionVersionTag
?:
StringFilterProperty
;
}
)
[]
;
}
;
sort
?:
{
field
:
|
"processInstanceKey"
|
"processDefinitionId"
|
"processDefinitionName"
|
"processDefinitionVersion"
|
"processDefinitionVersionTag"
|
"processDefinitionKey"
|
"parentProcessInstanceKey"
|
"parentElementInstanceKey"
|
"startDate"
|
"endDate"
|
"state"
|
"hasIncident"
|
"tenantId"
;
order
?:
SortOrderEnum
;
}
[]
;
}
Process instance search request.
Type Declaration
Optional
filter
?:
BaseProcessInstanceFilterFields
&
{
processDefinitionId
?:
StringFilterProperty
;
processDefinitionKey
?:
ProcessDefinitionKeyFilterProperty
;
processDefinitionName
?:
StringFilterProperty
;
processDefinitionVersion
?:
IntegerFilterProperty
;
processDefinitionVersionTag
?:
StringFilterProperty
;
}
&
{
$or
?:
(
BaseProcessInstanceFilterFields
&
{
processDefinitionId
?:
StringFilterProperty
;
processDefinitionKey
?:
ProcessDefinitionKeyFilterProperty
;
processDefinitionName
?:
StringFilterProperty
;
processDefinitionVersion
?:
IntegerFilterProperty
;
processDefinitionVersionTag
?:
StringFilterProperty
;
}
)
[]
;
}
Process instance search filter.
Optional
sort
?:
{
field
:
|
"processInstanceKey"
|
"processDefinitionId"
|
"processDefinitionName"
|
"processDefinitionVersion"
|
"processDefinitionVersionTag"
|
"processDefinitionKey"
|
"parentProcessInstanceKey"
|
"parentElementInstanceKey"
|
"startDate"
|
"endDate"
|
"state"
|
"hasIncident"
|
"tenantId"
;
order
?:
SortOrderEnum
;
}
[]
Sort field criteria.
Optional
path
path
?:
never
Optional
query
query
?:
never
url
url
:
"/process-instances/search"
Settings
Member Visibility
Inherited
External
Theme
OS
Light
Dark
On This Page
Properties
body
path
query
url
@camunda8/orchestration-cluster-api
Loading...
Process instance search request.