TaskFilterSpec
This data object type defines the specification for the task filter used to query tasks in the history collector database.
The client creates a task history collector with a filter specification, then retrieves the tasks from the task history collector.
{
"_typeName": "string",
"entity": {
"_typeName": "string",
"entity": {
"_typeName": "string",
"type": "string",
"value": "string"
},
"recursion": "string"
},
"time": {
"_typeName": "string",
"timeType": "string",
"beginTime": "string",
"endTime": "string"
},
"userName": {
"_typeName": "string",
"systemUser": false,
"userList": [
"string"
]
},
"activationId": [
"string"
],
"state": [
"string"
],
"alarm": {
"_typeName": "string",
"type": "string",
"value": "string"
},
"scheduledTask": {
"_typeName": "string",
"type": "string",
"value": "string"
},
"eventChainId": [
0
],
"tag": [
"string"
],
"parentTaskKey": [
"string"
],
"rootTaskKey": [
"string"
]
}
This data object type specifies a managed entity used to filter task history.
This data object type specifies a time range used to filter task history.
This data object type enables you to filter task history according to the users who performed the tasks.
This property, if provided, limits the set of collected tasks to those associated with the specified activation Ids.
This property, if provided, limits the set of collected tasks by their states.
Task states are enumerated in State. If not provided, tasks are collected regardless of their state.
Reference to an instance of the ScheduledTask managed object.
The filter specification for retrieving tasks by chain ID.
If it is set, tasks not with the given eventChainId will be filtered out. If the property is not set, tasks' chain ID is disregarded for filtering purposes.
The filter specification for retrieving tasks by tag.
If it is set, tasks not with the given tag(s) will be filtered out. If the property is not set, tasks' tag is disregarded for filtering purposes. If it is set, and includes an empty string, tasks without a tag will be returned.
The filter specification for retrieving tasks by parentTaskKey.
If it is set, tasks not with the given parentTaskKey(s) will be filtered out. If the property is not set, tasks' parentTaskKey is disregarded for filtering purposes.
The filter specification for retrieving tasks by rootTaskKey.
If it is set, tasks not with the given rootTaskKey(s) will be filtered out. If the property is not set, tasks' rootTaskKey is disregarded for filtering purposes.