WorkflowDefinition

A workflow (process) definition in Apache DolphinScheduler, representing a DAG of tasks.

ApacheDAGData PipelineOpen SourceOrchestrationPythonSchedulingWorkflow

Properties

Name	Type	Description
id	integer	Unique workflow definition ID.
code	integer	Globally unique code for the workflow definition.
name	string	Workflow definition name.
version	integer	Version number of this workflow definition.
releaseState	string	Whether the workflow is online (released) or offline.
projectCode	integer	Code of the project this workflow belongs to.
description	string	Human-readable description of the workflow.
globalParams	string	Global parameters for this workflow in JSON format.
timeout	integer	Workflow execution timeout in minutes. 0 means no timeout.
tenantCode	string	Tenant code for resource isolation.
createTime	string	ISO 8601 creation timestamp.
updateTime	string	ISO 8601 last update timestamp.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/apache-dolphinscheduler/refs/heads/main/json-schema/apache-dolphinscheduler-workflow-definition-schema.json",
  "title": "WorkflowDefinition",
  "description": "A workflow (process) definition in Apache DolphinScheduler, representing a DAG of tasks.",
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "description": "Unique workflow definition ID.",
      "example": 1001
    },
    "code": {
      "type": "integer",
      "description": "Globally unique code for the workflow definition.",
      "example": 8888888888888
    },
    "name": {
      "type": "string",
      "description": "Workflow definition name.",
      "example": "daily-etl-pipeline"
    },
    "version": {
      "type": "integer",
      "description": "Version number of this workflow definition.",
      "example": 3
    },
    "releaseState": {
      "type": "string",
      "description": "Whether the workflow is online (released) or offline.",
      "enum": [
        "ONLINE",
        "OFFLINE"
      ],
      "example": "ONLINE"
    },
    "projectCode": {
      "type": "integer",
      "description": "Code of the project this workflow belongs to.",
      "example": 7777777777777
    },
    "description": {
      "type": "string",
      "description": "Human-readable description of the workflow.",
      "example": "Daily ETL pipeline for processing sales data"
    },
    "globalParams": {
      "type": "string",
      "description": "Global parameters for this workflow in JSON format.",
      "example": "[]"
    },
    "timeout": {
      "type": "integer",
      "description": "Workflow execution timeout in minutes. 0 means no timeout.",
      "example": 60
    },
    "tenantCode": {
      "type": "string",
      "description": "Tenant code for resource isolation.",
      "example": "etl-team"
    },
    "createTime": {
      "type": "string",
      "format": "date-time",
      "description": "ISO 8601 creation timestamp.",
      "example": "2025-03-15T14:30:00Z"
    },
    "updateTime": {
      "type": "string",
      "format": "date-time",
      "description": "ISO 8601 last update timestamp.",
      "example": "2025-03-20T10:00:00Z"
    }
  },
  "required": [
    "name",
    "projectCode"
  ]
}