PUT /rest/bpm/htm/v1/task?action={string}
Name | Value Type | Description | ||||
---|---|---|---|---|---|---|
action | string | Action to be performed for the specified tasks.
|
The default content-type is application/json.
{ "description": "Task Bulk Update", "type": "object", "properties": { "updatedTaskIDs" : { "type": ["string"] }, "updatedPropertyValues" : { "businessRelevance": {"type": "boolean", "optional": true, "description": "States whether the task is a business relevant or an 'auxiliary' step." }, "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." }, "deletionTime": {"type": "string", "format": "date-time", "optional": true, "description": "Time when the task is deleted." }, "description": {"type": "string", "optional": true, "description": "Description of the task." }, "displayName": {"type": "string", "optional": true, "description": "Display name of the task." }, "dueTime": {"type": "string", "format": "date-time", "optional": true, "description": "Time when the task is due." }, "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." }, "durationUntilExpires": {"type": "string", "optional": true, "description": "Duration when the task expires once it is activated." }, "eventHandlerName": {"type": "string", "optional": true, "description": "Name of the associated event handler." }, "expirationTime": {"type": "string", "format": "date-time", "optional": true, "description": "Time when the task instance will expire or was due to expire." }, "isEscalated": {"type": "boolean", "optional": true, "description": "States whether an escalation occurred." }, "isRead": {"type": "boolean", "optional": true, "description": "States whether the task instance is marked read." }, "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." }, "workBasketName": {"type": "string", "optional": true, "description": "The name of the work basket the task belongs to." } } } }
The default content-type is application/json.
{ "description": "Task Bulk Update Response", "type": "object", "properties": { "failedUpdates": [ { "tkiid": {"type": "string", "description": "ID of a task where the operation has failed." }, "errorNumber": {"type": "string", "description": "Message ID of the exception." }, "errorMessage": {"type": "string", "description": "Message text of the exception." } } ] } }
The default content-type is application/json.
{ "description": "Error Response", "type": "object", "properties": { "errorNumber": {"type": "string", "description": "Message ID of the exception." }, "errorMessage": {"type": "string", "description": "Message text of the exception." }, "errorMessageParameters": {"type": ["string"], "optional": true, "description":"Message text parameters of the exception." }, "programmersDetails": {"type": "object", "optional": true, "description":"Additional, exception details, for example, a stack trace." } } }
Code | Description |
---|---|
200 OK | Successful completion - detailed report returned.
|
400 Bad Request | The parameters are not valid or they are missing. |
406 Not Acceptable | The requested content type or content encoding is not supported. |
415 Unsupported Media Type | The content type or content encoding of the request is not supported. |
500 Internal Server Error | A severe problem has occurred, programmer's details are provided. |
Release | Description |
---|---|
7.5 | The sent human task details update object may contain new properties:
|
6.1.2
Parent Topic: Task Resource