PUT Information in a Task Instance

Designing and Implementing Business Process Models : Task Engine API and Service Reference : Using the Task Engine RESTful Web Services in Integration Server : PUT Information in a Task Instance

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

You use this request to change information in the task's TaskInfo and TaskData documents. By default, this service enables you to update only tasks in Active, Error, and Suspended state. For information about updating tasks with other statuses, see Usage Notes, below. To end a task instance, you use this service to change the status field in the task's TaskInfo document to "closed" or "cancelled" as appropriate.

To use the request to update a task, the HTTP request is formed as follows:

PUT /rest/pub/opentask/taskID[?param1=value][&param2=value]...[&param4=value]

PUT /rest/pub/opentask?taskID=taskID[&param1=value]...[&param4=value]

Input Parameters

taskID	String The ID that identifies the task that you want to modify. This can be either passed in the URL as shown above, or as an input parameter.
taskInfo or TaskInfo	Document The TaskInfo document that specifies the changes you want to make to the standard information maintained for the task. See pub.task:TaskInfo for a description of the fields in this document.
taskData or TaskData	Document The TaskData document that contains the business data that you want to associate with the task. TaskData does not have a specified structure. The content varies according to the task
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.

Output Parameters

None.

Usage Notes

When you use this service to update information in the task's TaskInfo document, the Task Engine modifies only the fields that have assigned values in TaskInfo. All other fields in the target task retain their existing values. For example, to change just the name assigned to a task, set only the name field in the TaskInfo document that you pass to this service.

When you use this service to update information in the task's TaskData document, the TaskData document that you pass to the service replaces the task's existing TaskData document in its entirety.

By default, this operation enables you to update only tasks in Active, Error, and Suspended state. Tasks with other statuses (such as Completed, Canceled, or Expired) cannot be updated.

However, a Task Engine optional setting, -Dupdate.completed.task=true, is available to apply update actions to a task regardless of its current status. When this option is not present or set to false, task updates apply only to tasks in Active, Error, or Suspended status.

For information about setting this option, see "Specifying Task Update Behavior" and "Applying Task Engine Optional Settings" in Chapter 6 of the PDF publication, webMethods Task Engine User’s Guide.

Contact Support | Community | Feedback