DELETE a Task Instance

Edit online

This REST request deletes an instance of a task on the Task Engine connected to the Integration Server. The underlying built-in service is pub.task.taskclient:deleteTask.

The HTTP request is formed as follows:

DELETE /rest/pub/opentask/taskID[?user=value]

or

DELETE /rest/pub/opentask?taskID=taskID[&user=value]

Input Parameters

taskID String The ID that identifies the task that you want to delete. This can be either passed in the URL as shown above, or as an input parameter.
user String 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.

Output Parameters

None.

Usage Notes

To delete a task with this request, you must supply the ID of the task that you want to delete. To obtain this ID, use GET Task Instance Information in list task mode or one of the opentasksearch requests to locate the task and then extract the task ID from the Task document that it returns.

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