Returns an array of tasks that match
specified search criteria.
Input Message
|
includeTaskData
|
Boolean Optional. Specifies whether the operation
returns the TaskData object as well as the TaskInfo object for each task
matching the search criteria.
Set to:
-
true to
include the TaskData in the result set.
-
false
(default) to include only the TaskInfo in the result set.
|
|
taskSearchQuery
|
TaskSearchQuery The TaskSearchQuery object, which
specifies the search criteria. See
TaskSearchQuery for a description of
the fields in this object.
If
TaskSearchQuery is null, all
tasks for
user are returned.
|
|
user
|
String
Optional. The user ID of the
IBM My webMethods Server user on whose behalf this operation executes.
If
user is not specified, the
administrative user ID under which your client program logged on is used.
Note: Only tasks to which
user has access are searched.
|
|
userTasks
|
Boolean Optional. Specifies whether the operation
searches all tasks or just the user's inbox. This parameter is over-ridden if
the
user
parameter contains a value.
Set to:
-
true to
execute the search only on the user’s inbox.
-
false to
search accessible user tasks; this is the default value.
By default, only active tasks are
returned. This can be overridden with the
showNonActiveTasks parameter in
TaskSearchQuery.
|
|
Output Parameters
|
tasks
|
Task[
]An array of Task objects representing the tasks that matched the search
criteria in
TaskSearchQuery. See
Task for a description of the fields in a
Task object.
|
|
Usage Notes
If no tasks match the search criteria, an empty
array is returned.