webMethods and Intelligent Business Operations 10.2 | Designing and Implementing Business Process Models | Task Engine API and Service Reference | Using the Task Engine RESTful Web Services in Integration Server | Summary of REST Resources and Requests | GET Tasks with a Simple Search Request
 
GET Tasks with a Simple Search Request
This REST request retrieves tasks that match simple search criteria. The underlying built-in service is pub.task.taskclient:searchTasks.
The HTTP request will be formed as follows:
GET /rest/pub/opentasksearch[?param1=value][&param2=value]...[&param6=value]
Input Parameters
includeTaskData
String Optional. Specifies whether the service will return the TaskData document as well as the pub.task:TaskInfo document for each task matching the search criteria. Set to:
*true to include the TaskData document in the result set.
*false (default) to include only the TaskInfo document in the result set.
maxRes
String Optional. The maximum number of tasks to return in the result set. If maxRes is not specified, all results in the result set are returned. Note: This element does not apply to tasks with an indexed search provider. In this case, the specified value is ignored.
nonActive
String Optional. This field can be used when executing queries to fetch tasks from a user's inbox. Set to:
*true to include non-active tasks from a user's inbox (that is, those tasks already completed by user).
*false (default) to return only active tasks.
notOthers
String Optional. Exclude tasks which are accepted by a user other than the user ID used in the search. Set to:
*true to exclude tasks that are accepted by a user other than user.
*false (default) to search all tasks to which user has access.
searchUserTasks
String Optional. Specifies whether the service searches all tasks or just the user's inbox. Set to:
*true to search only the inbox for user.
*false (default) to search all tasks to which user has access.
user
String Optional. The user ID of the My webMethods Server user on whose behalf this service will execute. If user is not specified, the user ID associated with the WmTaskClient package is used. For information about configuring this user ID, see webMethods Task Engine User’s Guide.
Note: Only tasks to which user has access are searched.
Output Parameters
Tasks
Document list The result set containing the tasks that match the search criteria in pub.task:TaskSearchQuery. Each document in the result set has the following structure:
*TaskID String The identifier assigned to the task instance.
*TaskInfo Document The TaskInfo document containing standard information about the task. See pub.task:TaskInfo for a description of the fields in this document.
*TaskData Document The TaskData document containing the business data associated with the task. Returned only if includeTaskData is set to true.
Usage Notes
This request can be used for simple listing of tasks based on parameters. To run a more complex query, see POST a Complex Task Search Request, which allows submitting various search queries.
Copyright © 2018 | Software AG, Darmstadt, Germany and/or Software AG USA, Inc., Reston, VA, USA, and/or its subsidiaries and/or its affiliates and/or their licensors.
Innovation Release