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": "IN_PROGRESS",
       "mergeOutput": true,
       "workflowId": "f1055d00-af87-11ee-acea-ea0e2d4a2d25",
       "taskRefName": "http_ref",
       "taskOutput": {
         "Some-Key-l740s": "Some-Value-l740s",
         "Some-Key-3dh21": "Some-Value-3dh21"
       }
     },
     "type": "UPDATE_TASK",
}

Input Parameters

Attributes	Description
taskStatus	Specify the status of the task to be updated. It can take values: PENDING SKIPPED TIMED_OUT COMPLETED_WITH_ERRORS CANCELED SCHEDULED FAILED_WITH_TERMINAL_ERROR FAILED IN_PROGRESS COMPLETED You can also pass this value as a variable.
workflowId	The execution ID of the workflow containing the task to be updated. Note:If the task status is updated using workflowId, ensure that you also provide the task reference name.
taskRefName	The reference name of the task whose status is to be updated.
taskId	If you are updating the status of the task simply using taskId, then provide the execution ID of the task whose status is to be updated.
taskOutput	Provide the key-value map that will be updated as the task output, whose status is being updated.
mergeOutput	An optional parameter to merge the output. By default, this is set to false. Setting this to true allows the outputs generated by this task (taskOutput) to be combined with the existing task output (whose status is being updated). It can be used to append new output key values to the existing task output.

Output Parameters

Attributes	Description
taskOutput	Displays the new output of the task if defined in the task definition.

Examples

UI

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

JSON Example

    {
     "name": "update_task",
     "taskReferenceName": "update_task_ref",
     "inputParameters": {
       "taskStatus": "IN_PROGRESS",
       "mergeOutput": true,
       "workflowId": "f1055d00-af87-11ee-acea-ea0e2d4a2d25",
       "taskRefName": "http_ref",
       "taskOutput": {
         "Some-Key-l740s": "Some-Value-l740s",
         "Some-Key-3dh21": "Some-Value-3dh21"
       }
     },
     "type": "UPDATE_TASK",
}