WmTaskClient. Service that 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. TaskData does not have a specified structure. Its
content varies according to the task.
Input Parameters
user
|
String
Optional. The user ID of the
IBM 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
IBM webMethods Task Engine User’s Guide.
|
taskID
|
String
The ID that identifies the task that you want to retrieve.
|
includeTaskData
|
String
Optional. Specifies whether you want to retrieve the TaskData document as well
as the TaskInfo document.
Set to:
-
true to
retrieve TaskData in addition to TaskInfo.
-
false
(default) to get TaskInfo only.
|
retryOnFailure
Count
|
String
Optional. Specifies the number of times to attempt to invoke the service. The
default is 0 times. When specified, this value will override the configuration
value set on the WmTaskClient Home page in IS Administrator.
|
retryDelay
|
String
Optional. Specifies the number of milliseconds to wait between attempts. The
default is 1000 ms (this field is ignored if retryOnFailureCount = 0). When
specified, this value will override the configuration value set on the
WmTaskClient Home page in IS Administrator
|
|
Output Parameters
TaskInfo
|
Document TaskInfo document containing standard
information about the task. See
pub.task:TaskInfo
for a description of the fields in this document.
|
TaskData
|
Document A document containing the business data
associated with the task. TaskData does not have a specified structure. Its
content varies according to the task.
TaskData is returned only if
includeTaskData is set to true.
|
|
Usage Notes
To get a task using this service, you must supply
the ID of the task that you want to retrieve. To obtain this ID, use the
pub.task.taskclient:searchTasks
service to locate the task and then extract the task ID from the
Task
document that the
searchTasks
service 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.