WmTaskClient. Service that deletes an instance of a task on
the
Task Engine to which the
Integration Server is connected.
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 delete.
|
|
retryOn
FailureCount
|
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
|
|
Usage Notes
To delete a task using this service, you must
supply the ID of the task that you want to delete. 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 delete a task successfully, the user ID in
user must
have permission to access the specified task. If the supplied ID does not have
access to the task, or if the specified task does not exist, an exception will
be thrown.