Update Task

A system task to update the status of other tasks.

The task status can be updated in two different ways:

1. Using the workflow ID (containing the task) & the reference name of the task to be updated.
2. Using the task execution ID.

note

The user running this workflow should have access to the task being updated.

Definitions

   {
     "name": "update_task",
     "taskReferenceName": "update_task_ref",
     "inputParameters": {
       "taskStatus": "COMPLETED",
       "mergeOutput": false,
       "taskId": "f5c23c77-27b8-11ef-9dad-e2819f8ee22d"
     },
     "type": "UPDATE_TASK"
   }

Input Parameters

Attribute	Description
taskStatus	Specify the status of the task to be updated. Supported values: FAILED_WITH_TERMINAL_ERROR FAILED COMPLETED You can also pass this value as a variable.
workflowId	The execution ID of the workflow containing the task to be updated. Required if updating using workflowId.
taskRefName	The reference name of the task to be updated. Required if updating using workflowId.
taskId	The execution ID of the task to be updated. Required if updating using taskId.
taskOutput	A key-value map that will be updated as the task output..
mergeOutput	An optional parameter to merge the output. By default, this is set to false. If set to true, the outputs generated by this task (taskOutput) will be combined with the existing task output.

Output Parameters

Attribute	Description
updatedTaskId	Displays the task execution ID of the updated task.
taskOutput	Displays the new output of the task if defined.

Examples

UI

1. Add task type Update Task.
2. Provide the input parameters.

JSON

   {
     "name": "update_task",
     "taskReferenceName": "update_task_ref",
     "inputParameters": {
       "taskStatus": "COMPLETED",
       "mergeOutput": false,
       "taskId": "f5c23c77-27b8-11ef-9dad-e2819f8ee22d"
     },
     "type": "UPDATE_TASK"
   }