Designing and Implementing Business Process Models : Task Engine API and Service Reference : Using the Task Engine Web Service API : searchTasksIndexed
searchTasksIndexed
Returns a subset of tasks that match the specified search criteria against indexed business data.
The query must contain a search term specifying the taskTypeID when searching for business data fields. The Task Engine uses the taskTypeID to identify the specific index table to use. You can search for multiple task types in a single query by specifying multiple taskTypeID values when you define the search criteria. If you are not searching for business data fields, then taskTypeID is not required.
If you are working with standard business data fields use searchTasks.
Input Message
businessData
Boolean Optional. Indicates whether the search query operation includes indexed business data when processing the search query. Use this property when your search query contains search terms that reference indexed business data fields.
Set to:
*true to include business data in the search query processing.
*false when your search query does not require processing of business data or when your task type does not use any defined indexed business fields.
The default value for businessData is false.
taskSearchQuery
TaskSearchQueryV2 Specifies the TaskSearchQueryV2 object that provides the search criteria. If taskSearchQueryV2 is null, an error occurs.
user
String Optional. Specifies the user ID of the My webMethods Server user for which the operation executes. If user is not specified, the administrative user ID under which your client program logged on as is used. When you use this parameter, the search is limited to tasks that are accessible by the user.
userTasks
Boolean Optional. Indicates whether the operation searches all tasks or only 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.
Usage Notes
The search query must contain a search term specifying the taskTypeID; this is required to search business fields and page the results.
The TaskSearchQuery data structure referenced in TaskSearchQueryV2 must contain a value for taskTypeID in the field’s element to identify the search target. You can search for multiple task types in a single query by specifying multiple taskTypeID values. When specifying multiple taskTypeIDs, enter them as a string array.
Output Parameters
tasks
Task Specifies an array of Task objects representing the tasks that match the search criteria in TaskSearchQueryV2.
If no tasks match the search criteria, an empty array is returned.
Copyright © 2017 Software AG, Darmstadt, Germany.
Product LogoContact Support   |   Community   |   Feedback