Tasks

Update a task

All request values are optional. For example, you can only include the assignee attribute in the request body JSON-object, only updating the assignee of the task, leaving all other fields unaffected. When an attribute is explicitly included and is set to null, the task-value will be updated to null. Example: {"dueDate" : null} will clear the duedate of the task).

put/cmmn-runtime/tasks/{taskId}

Request

Path parameters

taskIdstring required

Request body

ownerstring
assigneestring
delegationStatestring
namestring
descriptionstring
dueDatestring date-time
priorityinteger
parentTaskIdstring
categorystring
tenantIdstring
formKeystring
ownerSetboolean
assigneeSetboolean
delegationStateSetboolean
nameSetboolean
descriptionSetboolean
duedateSetboolean
prioritySetboolean
parentTaskIdSetboolean
categorySetboolean
tenantIdSetboolean
formKeySetboolean

Response

Indicates the task was updated.

idstring
urlstring
ownerstring
assigneestring
delegationStatestring

Delegation-state of the task, can be null, "pending" or "resolved".

namestring
descriptionstring
createTimestring date-time
dueDatestring date-time
priorityinteger
suspendedboolean
claimTimestring
taskDefinitionKeystring
scopeDefinitionIdstring
scopeIdstring
subScopeIdstring
scopeTypestring
propagatedStageInstanceIdstring
tenantIdstring
categorystring
formKeystring
caseInstanceIdstring
caseInstanceUrlstring
caseDefinitionIdstring
caseDefinitionUrlstring
parentTaskIdstring
parentTaskUrlstring
executionIdstring
processInstanceIdstring
processDefinitionIdstring

Example response

{
  "id": "8",
  "url": "http://localhost:8182/cmmn-runtime/tasks/8",
  "owner": "owner",
  "assignee": "kermit",
  "delegationState": "pending",
  "name": "My task",
  "description": "Task description",
  "createTime": "2013-04-17T10:17:43.902+0000",
  "dueDate": "2013-04-17T10:17:43.902+0000",
  "priority": 50,
  "claimTime": "2018-04-17T10:17:43.902+0000",
  "taskDefinitionKey": "theTask",
  "scopeDefinitionId": "123",
  "scopeId": "123",
  "subScopeId": "123",
  "scopeType": "cmmn",
  "propagatedStageInstanceId": "123",
  "tenantId": "null",
  "category": "ExampleCategory",
  "caseInstanceId": "5",
  "caseInstanceUrl": "http://localhost:8182/cmmn-runtime/case-instances/5",
  "caseDefinitionId": "oneTaskCase%3A1%3A4",
  "caseDefinitionUrl": "http://localhost:8182/cmmn-runtime/case-definitions/oneTaskCase%3A1%3A4",
  "parentTaskId": "null",
  "parentTaskUrl": "null",
  "executionId": "123",
  "processInstanceId": "123",
  "processDefinitionId": "123",
  "variables": [
    {
      "name": "myVariable",
      "type": "string",
      "valueUrl": "http://...."
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.