Task Engine 10.11 | Task Engine Webhelp | webMethods Task Engine API and Service Reference | Using the Task Engine Web Service API | searchTaskFields
Returns a list of tasks that match specified field search criteria.
This API can return only primitive types (for example, Strings, Numbers, Dates) or lists (arrays) of primitives. It cannot return complex objects such as all task business data.
Input Message
String 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 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.
String Optional. The user ID of the 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.
Only tasks to which user has access are searched.
String List of tasks fields that are to be returned by this service. For information about specifying fields, see the fields and operator elements in TaskSearchQueryTerm. For example, suppose you want to return the following fields as result of the query:
*The business data field orderID from task data documents.
You would then pass in following field specifications:
This API returns the values for these fields only.
Output Parameters
Task Field
Document List Result set containing the tasks that match the search criteria in TaskSearchQuery. Each document in the result set has the following structure:
*name String Name of the task.
*value Object The value of the field contents for the specified field(s).
That is, the service returns a collection of tasks that match the query. For each task, it returns a collection of specified fields.
The purpose of this API is to ease performance issues with searchTasks(). It is quite common that only few taskInfo fields along with some business data fields are returned. When using searchTasks() it returns the entire TaskInfo plus TaskData documents; the TaskData could be very large. This could cause the SOAP response size to become an issue, severely limiting performance of this service. By using searchTaskFields() instead, the user can choose to return only a few fields which can help improve performance.
Usage Notes
If no tasks match the search criteria, an empty list is returned.