Schedule

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

ApacheDAGData PipelineOpen SourceOrchestrationPythonSchedulingWorkflow

Properties

Name	Type	Description
id	integer	Schedule ID.
processDefinitionCode	integer	Workflow definition code to schedule.
crontab	string	Cron expression for the schedule.
startTime	string	Schedule start datetime.
endTime	string	Schedule end datetime.
timezoneId	string	Timezone for cron evaluation.
failureStrategy	string	Strategy on schedule failure.
warningType	string	When to send alerts.
releaseState	string	Whether this schedule is active.

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-schedule-schema.json",
  "title": "Schedule",
  "description": "A cron-based schedule for automatic workflow execution in Apache DolphinScheduler.",
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "description": "Schedule ID.",
      "example": 301
    },
    "processDefinitionCode": {
      "type": "integer",
      "description": "Workflow definition code to schedule.",
      "example": 8888888888888
    },
    "crontab": {
      "type": "string",
      "description": "Cron expression for the schedule.",
      "example": "0 0 1 * * ? *"
    },
    "startTime": {
      "type": "string",
      "format": "date-time",
      "description": "Schedule start datetime.",
      "example": "2025-01-01T00:00:00Z"
    },
    "endTime": {
      "type": "string",
      "format": "date-time",
      "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"
  ]
}