Flows

Update a single task on a flow

Changed on Mar 2, 2026

patch/api/v1/{tenant}/flows/{namespace}/{id}/{taskId}

Request

Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
URL: /api/v1/{tenant}/flows/{namespace}/{id}/{taskId}
Auth: one of:
- HTTP bearer
- HTTP basic

Path parameters

namespacestring required

The flow namespace

idstring required

The flow id

taskIdstring required

The task id

tenantstring required

Request body

idstring required

typestring required

versionstring

Defines the version of the plugin to use.

The version must follow the Semantic Versioning (SemVer) specification:

A single-digit MAJOR version (e.g., 1).
A MAJOR.MINOR version (e.g., 1.1).
A MAJOR.MINOR.PATCH version, optionally with any qualifier (e.g., 1.1.2, 1.1.0-SNAPSHOT).

descriptionstring

retryobject

disabledboolean

logLevel'ERROR' | 'WARN' | 'INFO' | 'DEBUG' | 'TRACE'

allowFailureboolean

logToFileboolean

runIfstring

allowWarningboolean

Example request

{
  "taskCache": {
    "ttl": "ttl",
    "enabled": true
  },
  "description": "description",
  "type": "type",
  "logToFile": true,
  "version": "version",
  "timeout": {
    "expression": "expression",
    "value": "value"
  },
  "allowWarning": true,
  "allowFailure": true,
  "assets": "",
  "logLevel": "ERROR",
  "runIf": "runIf",
  "disabled": true,
  "id": "id",
  "workerGroup": {
    "fallback": "FAIL",
    "key": "key"
  },
  "retry": "{}"
}

Response

updateTask 200 response

idstring required

namespacestring required

revisioninteger

updatedstring date-time

The timestamp when this revision was created or last updated.

descriptionstring

disabledboolean required

variablesobject

deletedboolean required

retryAbstractRetry

Example response

{
  "outputs": [
    {
      "displayName": "displayName",
      "description": "description",
      "id": "id",
      "type": "STRING",
      "value": "{}",
      "required": true
    },
    {
      "displayName": "displayName",
      "description": "description",
      "id": "id",
      "type": "STRING",
      "value": "{}",
      "required": true
    }
  ],
  "variables": null,
  "inputs": [
    {
      "dependsOn": "",
      "defaults": "",
      "displayName": "displayName",
      "prefill": "",
      "description": "description",
      "id": "id",
      "type": "",
      "required": true
    },
    {
      "dependsOn": "",
      "defaults": "",
      "displayName": "displayName",
      "prefill": "",
      "description": "description",
      "id": "id",
      "type": "",
      "required": true
    }
  ],
  "finally": [
    {
      "taskCache": {
        "ttl": "ttl",
        "enabled": true
      },
      "description": "description",
      "type": "type",
      "logToFile": true,
      "version": "version",
      "timeout": {
        "expression": "expression",
        "value": "value"
      },
      "allowWarning": true,
      "allowFailure": true,
      "assets": "",
      "logLevel": "ERROR",
      "runIf": "runIf",
      "disabled": true,
      "id": "id",
      "workerGroup": {
        "fallback": "FAIL",
        "key": "key"
      },
      "retry": "{}"
    },
    {
      "taskCache": {
        "ttl": "ttl",
        "enabled": true
      },
      "description": "description",
      "type": "type",
      "logToFile": true,
      "version": "version",
      "timeout": {
        "expression": "expression",
        "value": "value"
      },
      "allowWarning": true,
      "allowFailure": true,
      "assets": "",
      "logLevel": "ERROR",
      "runIf": "runIf",
      "disabled": true,
      "id": "id",
      "workerGroup": {
        "fallback": "FAIL",
        "key": "key"
      },
      "retry": "{}"
    }
  ],
  "description": "description",
  "sla": [
    {
      "id": "id",
      "type": "MAX_DURATION",
      "behavior": "FAIL",
      "labels": [
        "SLA_labels",
        "SLA_labels"
      ]
    },
    {
      "id": "id",
      "type": "MAX_DURATION",
      "behavior": "FAIL",
      "labels": [
        "SLA_labels",
        "SLA_labels"
      ]
    }
  ],
  "afterExecution": [
    {
      "taskCache": {
        "ttl": "ttl",
        "enabled": true
      },
      "description": "description",
      "type": "type",
      "logToFile": true,
      "version": "version",
      "timeout": {
        "expression": "expression",
        "value": "value"
      },
      "allowWarning": true,
      "allowFailure": true,
      "assets": "",
      "logLevel": "ERROR",
      "runIf": "runIf",
      "disabled": true,
      "id": "id",
      "workerGroup": {
        "fallback": "FAIL",
        "key": "key"
      },
      "retry": "{}"
    },
    {
      "taskCache": {
        "ttl": "ttl",
        "enabled": true
      },
      "description": "description",
      "type": "type",
      "logToFile": true,
      "version": "version",
      "timeout": {
        "expression": "expression",
        "value": "value"
      },
      "allowWarning": true,
      "allowFailure": true,
      "assets": "",
      "logLevel": "ERROR",
      "runIf": "runIf",
      "disabled": true,
      "id": "id",
      "workerGroup": {
        "fallback": "FAIL",
        "key": "key"
      },
      "retry": "{}"
    }
  ],
  "triggers": [
    {
      "allowConcurrent": true,
      "stopAfter": [
        "CREATED",
        "CREATED"
      ],
      "description": "description",
      "type": "type",
      "logToFile": true,
      "version": "version",
      "labels": [
        "The_labels_to_pass_to_the_execution_created_",
        "The_labels_to_pass_to_the_execution_created_"
      ],
      "failOnTriggerError": true,
      "assets": {
        "outputs": {
          "expression": "expression",
          "value": [
            {
              "metadata": {
                "key": "{}"
              },
              "displayName": "displayName",
              "namespace": "namespace",
              "description": "description",
              "id": "id",
              "type": "type"
            },
            {
              "metadata": {
                "key": "{}"
              },
              "displayName": "displayName",
              "namespace": "namespace",
              "description": "description",
              "id": "id",
              "type": "type"
            }
          ]
        },
        "inputs": {
          "expression": "expression",
          "value": [
            {
              "id": "id",
              "type": "type"
            },
            {
              "id": "id",
              "type": "type"
            }
          ]
        },
        "enableAuto": {
          "expression": "expression",
          "value": true
        }
      },
      "logLevel": null,
      "disabled": false,
      "id": "id",
      "workerGroup": {
        "fallback": "FAIL",
        "key": "key"
      },
      "conditions": [
        {
          "type": "type"
        },
        {
          "type": "type"
        }
      ]
    },
    {
      "allowConcurrent": true,
      "stopAfter": [
        "CREATED",
        "CREATED"
      ],
      "description": "description",
      "type": "type",
      "logToFile": true,
      "version": "version",
      "labels": [
        "The_labels_to_pass_to_the_execution_created_",
        "The_labels_to_pass_to_the_execution_created_"
      ],
      "failOnTriggerError": true,
      "assets": {
        "outputs": {
          "expression": "expression",
          "value": [
            {
              "metadata": {
                "key": "{}"
              },
              "displayName": "displayName",
              "namespace": "namespace",
              "description": "description",
              "id": "id",
              "type": "type"
            },
            {
              "metadata": {
                "key": "{}"
              },
              "displayName": "displayName",
              "namespace": "namespace",
              "description": "description",
              "id": "id",
              "type": "type"
            }
          ]
        },
        "inputs": {
          "expression": "expression",
          "value": [
            {
              "id": "id",
              "type": "type"
            },
            {
              "id": "id",
              "type": "type"
            }
          ]
        },
        "enableAuto": {
          "expression": "expression",
          "value": true
        }
      },
      "logLevel": null,
      "disabled": false,
      "id": "id",
      "workerGroup": {
        "fallback": "FAIL",
        "key": "key"
      },
      "conditions": [
        {
          "type": "type"
        },
        {
          "type": "type"
        }
      ]
    }
  ],
  "pluginDefaults": [
    {
      "forced": true,
      "values": "{}",
      "type": "type"
    },
    {
      "forced": true,
      "values": "{}",
      "type": "type"
    }
  ],
  "revision": 1,
  "labels": [
    {
      "value": "value",
      "key": "key"
    },
    {
      "value": "value",
      "key": "key"
    }
  ],
  "concurrency": {
    "limit": 1,
    "behavior": "QUEUE"
  },
  "deleted": true,
  "checks": [
    {
      "condition": "condition",
      "style": "ERROR",
      "message": "message",
      "behavior": "BLOCK_EXECUTION"
    },
    {
      "condition": "condition",
      "style": "ERROR",
      "message": "message",
      "behavior": "BLOCK_EXECUTION"
    }
  ],
  "namespace": "namespace",
  "disabled": true,
  "id": "id",
  "workerGroup": {
    "fallback": "FAIL",
    "key": "key"
  },
  "updated": "2000-01-23T04:56:07.000+00:00",
  "tasks": [
    {
      "taskCache": {
        "ttl": "ttl",
        "enabled": true
      },
      "description": "description",
      "type": "type",
      "logToFile": true,
      "version": "version",
      "timeout": {
        "expression": "expression",
        "value": "value"
      },
      "allowWarning": true,
      "allowFailure": true,
      "assets": "",
      "logLevel": "ERROR",
      "runIf": "runIf",
      "disabled": true,
      "id": "id",
      "workerGroup": {
        "fallback": "FAIL",
        "key": "key"
      },
      "retry": "{}"
    },
    {
      "taskCache": {
        "ttl": "ttl",
        "enabled": true
      },
      "description": "description",
      "type": "type",
      "logToFile": true,
      "version": "version",
      "timeout": {
        "expression": "expression",
        "value": "value"
      },
      "allowWarning": true,
      "allowFailure": true,
      "assets": "",
      "logLevel": "ERROR",
      "runIf": "runIf",
      "disabled": true,
      "id": "id",
      "workerGroup": {
        "fallback": "FAIL",
        "key": "key"
      },
      "retry": "{}"
    }
  ],
  "errors": [
    {
      "taskCache": {
        "ttl": "ttl",
        "enabled": true
      },
      "description": "description",
      "type": "type",
      "logToFile": true,
      "version": "version",
      "timeout": {
        "expression": "expression",
        "value": "value"
      },
      "allowWarning": true,
      "allowFailure": true,
      "assets": "",
      "logLevel": "ERROR",
      "runIf": "runIf",
      "disabled": true,
      "id": "id",
      "workerGroup": {
        "fallback": "FAIL",
        "key": "key"
      },
      "retry": "{}"
    },
    {
      "taskCache": {
        "ttl": "ttl",
        "enabled": true
      },
      "description": "description",
      "type": "type",
      "logToFile": true,
      "version": "version",
      "timeout": {
        "expression": "expression",
        "value": "value"
      },
      "allowWarning": true,
      "allowFailure": true,
      "assets": "",
      "logLevel": "ERROR",
      "runIf": "runIf",
      "disabled": true,
      "id": "id",
      "workerGroup": {
        "fallback": "FAIL",
        "key": "key"
      },
      "retry": "{}"
    }
  ],
  "retry": null
}

Changes

Mar 2, 2026b6097dbc46ae Revision changes
- info
  added the optional property //// to the response with the status
Feb 18, 2026f5eab92a5b09 Revision changes
- breaking
  added to the request property allOf list
- warning
  removed from the request property allOf list
- warning
  removed the optional property //// from the response with the status
- warning
  removed the optional property //// from the response with the status
- info
  added the optional property //// to the response with the status
- info
  added the optional property //// to the response with the status
- info
  added the optional property //// to the response with the status
- info
  added to the /// response property allOf list for the response status
- info
  added to the /// response property allOf list for the response status
- info
  added to the /// response property allOf list for the response status
- info
  added to the /// response property allOf list for the response status
- info
  removed from the /// response property allOf list for the response status
- info
  removed from the /// response property allOf list for the response status
- info
  removed from the /// response property allOf list for the response status
- info
  removed from the /// response property allOf list for the response status
- info
  removed subschema #1 subschema #2 from the /// response property oneOf list for the response status

Operation history