The state selector defines whether the data is in an active or finished state.
See the various Functions for examples.
| Property | Type | Description |
|---|---|---|
| matchAll | Boolean | If true all records (considering the other selectors) will be selected. If unspecified or false at least one other property must be set |
| finished | Boolean | If true then only finished records will be returned |
Finished Records
Data is considered finished if it can no longer be interacted with.
Workflow
Completed workflow instances are considered finished. These workflows have terminated by erroring, being cancelled, or reaching an end/terminate event. When inspecting processes in the workflow modeller they are those listed as "completed".
History
Histories exist in one of two states, set by the boolean flag "sealed". Sealed histories can no longer be written to, ie no further events can be added to them. Histories are sealed by default when their corresponding workflow process instance ends, or if created using the "History Write Event" form action. Sealed histories are considered finished.
Objects
iCM objects have no concept of "ending" or "completing". They can always be updated and so are always considered "unfinished". Setting
"state": {
"finished": true
}
when selecting iCM objects would return zero results.
Share this page
