Apache DolphinScheduler · JSON Structure

Apache Dolphinscheduler Schedule Structure

A cron-based schedule for automatic workflow execution in Apache DolphinScheduler.

Type: object Properties: 9 Required: 4
ApacheDAGData PipelineOpen SourceOrchestrationPythonSchedulingWorkflow

Schedule is a JSON Structure definition published by Apache DolphinScheduler, describing 9 properties, of which 4 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

id processDefinitionCode crontab startTime endTime timezoneId failureStrategy warningType releaseState

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

apache-dolphinscheduler-schedule-structure.json Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/apache-dolphinscheduler/refs/heads/main/json-structure/apache-dolphinscheduler-schedule-structure.json",
  "name": "Schedule",
  "description": "A cron-based schedule for automatic workflow execution in Apache DolphinScheduler.",
  "type": "object",
  "properties": {
    "id": {
      "type": "int32",
      "description": "Schedule ID.",
      "example": 301
    },
    "processDefinitionCode": {
      "type": "int32",
      "description": "Workflow definition code to schedule.",
      "example": 8888888888888
    },
    "crontab": {
      "type": "string",
      "description": "Cron expression for the schedule.",
      "example": "0 0 1 * * ? *"
    },
    "startTime": {
      "type": "datetime",
      "description": "Schedule start datetime.",
      "example": "2025-01-01T00:00:00Z"
    },
    "endTime": {
      "type": "datetime",
      "description": "Schedule end datetime.",
      "example": "2026-01-01T00:00:00Z"
    },
    "timezoneId": {
      "type": "string",
      "description": "Timezone for cron evaluation.",
      "example": "America/Los_Angeles"
    },
    "failureStrategy": {
      "type": "string",
      "description": "Strategy on schedule failure.",
      "enum": [
        "CONTINUE",
        "END"
      ],
      "example": "CONTINUE"
    },
    "warningType": {
      "type": "string",
      "description": "When to send alerts.",
      "enum": [
        "NONE",
        "SUCCESS",
        "FAILURE",
        "ALL"
      ],
      "example": "FAILURE"
    },
    "releaseState": {
      "type": "string",
      "description": "Whether this schedule is active.",
      "enum": [
        "ONLINE",
        "OFFLINE"
      ],
      "example": "ONLINE"
    }
  },
  "required": [
    "processDefinitionCode",
    "crontab",
    "startTime",
    "endTime"
  ]
}