Tasks List Widget - Filter Event (Handled)
The widget applies the filter to its default list definition.
Event Name
com.ibm.task.Filter
General purpose: The widget applies the filter to retrieve the list of objects.
The filter can be specified in one of three ways:
- Single identifier
- The filter is a single object identifier of the given type.
- List of identifiers
- The filter is a list of object identifiers of one or multiple types.
Identifiers of the same type are combined inclusively (OR behaviour).
Filter of distinct types are combined (AND behaviour).
- Filter definition
- A filter expression using the query table condition language.
For all properties defined on the list definition the respective attributes defined on the corresponding query table
can be referenced. Constants are available for some attributes of predefined query tables, for example, STATE_RUNNING.
Payload
Type: JSON
{ "type" : "object",
"description" : "Reference single or multiple items or a complete filter.",
"properties" : [
{
"filter" : { "type": "string" },
"name" : { "type": "string" }
},
{
"id" : { "type": "string" },
"type" : { "type": "string" },
"name" : { "type": "string", "optional": "true" }
},
{
"items" : { "type":"array", "optional":"true", "items": { "properties": {
"id" : { "type": "string", "optional": "true", "requires": "type" },
"type" : { "type": "string", "optional": "true", "requires": "id" },
"name" : { "type": "string", "optional": "true", "requires":"id"}
}
}
]
}
If the filter is specified as an identifier or list of identifiers, the possible values are
- id
- Identifier for a task definition or process.
- type
- com.ibm.task.TaskTemplate or com.ibm.bfm.Process.
- name
- Name for this task definition or process.
Handled Since
6.2.0.1 + FEP
Parent Topic: Tasks List Widget