TaskFilterSpec

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.

AllOf

This class requires all of the following:

DataObject

JSON Example

{
    "_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"
    ]
}

entity

Optional

The filter specification for retrieving tasks by managed entity.

If not provided, then the tasks attached to all managed entities are collected.

time

Optional

The filter specification for retrieving tasks by time.

If not provided, then the tasks with any time stamp are collected.

userName

Optional

The filter specification for retrieving tasks by user name.

If not provided, then the tasks belonging to any user are collected.

array of string

activationId

Optional

This property, if provided, limits the set of collected tasks to those associated with the specified activation Ids.

array of TaskInfoState_enum

state

Optional

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.

alarm

Optional

This property, if provided, limits the set of collected tasks to those associated with the specified alarm.

If not provided, tasks are collected regardless of their association with alarms.

scheduledTask

Optional

This property, if provided, limits the set of collected tasks to those associated with the specified scheduled task.

If not provided, tasks are collected regardless of their association with any scheduled task.

array of integer

eventChainId

Optional

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.

array of string

tag

Optional

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.

array of string

parentTaskKey

Optional

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.

array of string

rootTaskKey

Optional

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.

Property Of

ArrayOfTaskFilterSpec