WebSphere Process Server, Version 6.2.0.1 Operating Systems: AIX, HP-UX, Linux, Solaris, Windows, i5/OS, z/OS


Human Task Manager REST Interface - Task Instance Resource - PUT (Update) Method

Use this method to update the properties of a task, for example, the priority, category, or a custom property.

Resource URI

PUT /v1/task/{tkiid}?{parameters}

Parameters

Required Parameters
NameValue TypeDescription
action string
Action to be performed for the specified task.
ValueDescription
update
Change task properties (e.g., priority, category, or a custom property).

Request Content

Human task details to be updated.

The default content-type is application/json.

MIME Type: application/json


+ View Schema
{  "description": "HTM Task Update", 
   "type": "object",
   "properties":
   {  "contextAuthorizationOfOwner": { "type": "string", "optional": true,
         "description": "Authorization rights of the task owner to the associated context."
      },
      "customProperties": { "type": "object", "optional": true, "additionalProperties": {"type": "string"},
         "description": "List of custom property names and values."
      },
      "description": {"type": "string", "optional": true,
         "description": "Description of the task."
      },
      "displayName": {"type": "string", "optional": true,
         "description": "Display name of the task."
      },
      "durationUntilDeleted": {"type": "string", "optional": true,
         "description": "Duration that the task is kept after it has reached an end state."
      },
      "durationUntilDue": {"type": "string", "optional": true,
         "description": "Duration when the task becomes due."
      },
      "eventHandlerName": {"type": "string", "optional": true,
         "description": "Name of the associated event handler."
      },
      "isBusinessRelevant": {"type": "boolean", "optional": true,
         "description": "States whether the task is a business relevant or an 'auxiliary' step."
      },
      "name": {"type": "string", "optional": true,
         "description": "Name of the task instance."
      },
      "namespace": {"type": "string", "optional": true,
         "description": "Namespace that categorizes the task instance."
      },
      "parentContextID": {"type": "string", "optional": true,
         "description": "ID of the parent context of the task instance."
      },
      "priority": {"type": "integer", "optional": true,
         "description": "Priority of the task instance."
      },
      "supportsClaimIfSuspended":{"type": "boolean", "optional": true,
         "description": "States whether the task can be claimed even if it is suspended."
      },
      "supportsDelegation": {"type": "boolean", "optional": true,
         "description": "States whether the task supports delegation, for example, by transferring work items."
      },
      "supportsFollowOnTasks": {"type": "boolean", "optional": true,
         "description": "States whether the task supports the creation of follow-on tasks."
      },
      "supportsSubTasks": {"type": "boolean", "optional": true,
         "description": "States whether the task supports the creation of subtasks."
      },
      "type": {"type": "string", "optional": true,
         "description": "Type of the task."
      }
   }
}

Response Content

None.

Error Response Content

Detailed error information.

The default content-type is application/json.

MIME Type: application/json


+ View Schema
{  "description": "HTM Error Response", 
   "type": "object",
   "properties":
   {  "errorNumber": {"type": "string",
         "description": "Message ID of the exception."
      },
      "errorMessage": {"type": "string",
         "description": "Message text of the exception."
      },
      "programmersDetails": {"type": "object", "optional": true,
         "description":"Additional, exception details, for example, a stack trace."
      }
   }
} 

Status Codes

The method returns one of the following status codes:
CodeDescription
200 OKSuccess completion.
400 Bad RequestThe parameters are not valid or they are missing.
401 UnauthorizedThe caller is not authorized for this request.
404 Not Found
The task does not exist.
500 Internal Server ErrorA severe problem has occurred, programmer's details are provided.

Available Since

6.1.2

Parent Topic: Task Instance Resource