Flows

Get a flow task

Changed on
get/api/v1/{tenant}/flows/{namespace}/{id}/tasks/{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}/tasks/{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

Query parameters

revisioninteger nullable

The flow revision

Response

getTaskFromFlow 200 response

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 response

{
  "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": "{}"
}

Changes

  • f5eab92a5b09Revision changes
    • info

      added to the response property allOf list for the response status

    • info

      removed from the response property allOf list for the response status