getTask

getTask

Returns the TaskInfo object, and optionally the TaskData object, for a specified task.

The TaskInfo object contains standard information about a task, including its status, expiration date, and the list of users to which it is assigned. The TaskData object contains the business data that is associated with the task.

Input

includeTaskData	Boolean Optional. Specifies whether you want to retrieve the TaskData object as well as the TaskInfo object. Set to true to retrieve TaskData in addition to TaskInfo. Default is false.
taskID	String The ID that identifies the task that you want to retrieve.
user	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.

Output

Task	Task A Task object containing the task's TaskInfo object and, optionally, its TaskData object. See Task for a description of the fields in this object. The TaskData object is included in Task only if includeTaskData is set to true.

Usage Notes

To get a task using this operation, you must supply the ID of the task that you want to retrieve. To obtain this ID, use the searchTasks operation to locate the task and then extract the task ID from the result set that the searchTasks operation returns.

To retrieve a task successfully, the user ID specified in user must have permission to access that task. If the supplied ID does not have access to the task, or if the specified task does not exist, an exception is thrown.