workflowStateFilter

JSON reference for the workflowStateFilter clause that filters objects by workflow state.

On this page

Property description

The workflowStateFilter clause filters objects based on the workflow state(s) they are in.

{
  "type": "workflowStateFilter",
  "workflowStateKeys": [""],
  "operand": ""
}

Property	Description	Values	Mandatory
`type`	workflowStateFilter	string	Yes
`workflowStateKeys`	Key(s) of the workflow state(s) the filter applies to.	array of strings	Yes
`operand`	See supported `operand` values.	string	Yes

Value	Description
`in`	Selects objects in the specified workflow state(s).
`notIn`	Excludes objects in the specified workflow state(s).