Conductor · Schema

WorkflowTask

AutomationOrchestrationStateTasksWorkflows

Properties

Name	Type	Description
name	string	Name of the task
taskReferenceName	string	Unique reference name for the task within the workflow
type	string	The type of task
description	string	Task description
inputParameters	object	Input parameter mappings
optional	boolean	Whether this task is optional
startDelay	integer	Delay in seconds before starting the task
asyncComplete	boolean	Whether the task is completed asynchronously
retryCount	integer	Number of retries
sink	string	Sink for EVENT tasks
subWorkflowParam	object	Sub workflow parameters
joinOn	array	List of task reference names to join on
forkTasks	array	List of forked task lists
decisionCases	object	Decision cases for SWITCH/DECISION tasks
defaultCase	array	Default case tasks for SWITCH/DECISION
loopCondition	string	Loop condition for DO_WHILE tasks
loopOver	array	Tasks to loop over in DO_WHILE

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "WorkflowTask",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "Name of the task"
    },
    "taskReferenceName": {
      "type": "string",
      "description": "Unique reference name for the task within the workflow"
    },
    "type": {
      "type": "string",
      "description": "The type of task"
    },
    "description": {
      "type": "string",
      "description": "Task description"
    },
    "inputParameters": {
      "type": "object",
      "description": "Input parameter mappings"
    },
    "optional": {
      "type": "boolean",
      "description": "Whether this task is optional"
    },
    "startDelay": {
      "type": "integer",
      "description": "Delay in seconds before starting the task"
    },
    "asyncComplete": {
      "type": "boolean",
      "description": "Whether the task is completed asynchronously"
    },
    "retryCount": {
      "type": "integer",
      "description": "Number of retries"
    },
    "sink": {
      "type": "string",
      "description": "Sink for EVENT tasks"
    },
    "subWorkflowParam": {
      "type": "object",
      "description": "Sub workflow parameters"
    },
    "joinOn": {
      "type": "array",
      "description": "List of task reference names to join on"
    },
    "forkTasks": {
      "type": "array",
      "description": "List of forked task lists"
    },
    "decisionCases": {
      "type": "object",
      "description": "Decision cases for SWITCH/DECISION tasks"
    },
    "defaultCase": {
      "type": "array",
      "description": "Default case tasks for SWITCH/DECISION"
    },
    "loopCondition": {
      "type": "string",
      "description": "Loop condition for DO_WHILE tasks"
    },
    "loopOver": {
      "type": "array",
      "description": "Tasks to loop over in DO_WHILE"
    }
  }
}