Apache Airflow · JSON Structure

Openapi.Yaml Dag Run Structure

DAGRun schema from Apache Airflow API

Type: object Properties: 14
ApacheDAGData PipelineETLOpen SourceOrchestrationPythonSchedulingWorkflow

DAGRun is a JSON Structure definition published by Apache Airflow, describing 14 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

conf dag_id dag_run_id data_interval_end data_interval_start end_date execution_date external_trigger last_scheduling_decision logical_date note run_type start_date state

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

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/apache-airflow/refs/heads/main/json-structure/openapi.yaml-dag-run-structure.json",
  "name": "DAGRun",
  "description": "DAGRun schema from Apache Airflow API",
  "type": "object",
  "properties": {
    "conf": {
      "description": "JSON object describing additional configuration parameters.\n\nThe value of this field can be set only when creating the object. If you try to modify the\nfield of an existing object, the request fails with an BAD_REQUEST error.\n",
      "type": "object"
    },
    "dag_id": {
      "readOnly": true,
      "type": "string"
    },
    "dag_run_id": {
      "description": "Run ID.\n\nThe value of this field can be set only when creating the object. If you try to modify the\nfield of an existing object, the request fails with an BAD_REQUEST error.\n\nIf not provided, a value will be generated based on execution_date.\n\nIf the specified dag_run_id is in use, the creation request fails with an ALREADY_EXISTS error.\n\nThis together with DAG_ID are a unique key.\n",
      "nullable": true,
      "type": "string"
    },
    "data_interval_end": {
      "format": "date-time",
      "nullable": true,
      "readOnly": true,
      "type": "string"
    },
    "data_interval_start": {
      "format": "date-time",
      "nullable": true,
      "readOnly": true,
      "type": "string"
    },
    "end_date": {
      "format": "date-time",
      "nullable": true,
      "readOnly": true,
      "type": "string"
    },
    "execution_date": {
      "deprecated": true,
      "description": "The execution date. This is the same as logical_date, kept for backwards compatibility.\nIf both this field and logical_date are provided but with different values, the request\nwill fail with an BAD_REQUEST error.\n\n*Changed in version 2.2.0*: Field becomes nullable.\n\n*Deprecated since version 2.2.0*: Use 'logical_date' instead.\n",
      "format": "date-time",
      "nullable": true,
      "type": "string"
    },
    "external_trigger": {
      "default": true,
      "readOnly": true,
      "type": "boolean"
    },
    "last_scheduling_decision": {
      "format": "date-time",
      "nullable": true,
      "readOnly": true,
      "type": "string"
    },
    "logical_date": {
      "description": "The logical date (previously called execution date). This is the time or interval covered by\nthis DAG run, according to the DAG definition.\n\nThe value of this field can be set only when creating the object. If you try to modify the\nfield of an existing object, the request fails with an BAD_REQUEST error.\n\nThis together with DAG_ID are a unique key.\n\n*New in version 2.2.0*\n",
      "format": "date-time",
      "nullable": true,
      "type": "string"
    },
    "note": {
      "description": "Contains manually entered notes by the user about the DagRun.\n\n*New in version 2.5.0*\n",
      "nullable": true,
      "type": "string"
    },
    "run_type": {
      "enum": [
        "backfill",
        "manual",
        "scheduled",
        "dataset_triggered"
      ],
      "readOnly": true,
      "type": "string"
    },
    "start_date": {
      "description": "The start time. The time when DAG run was actually created.\n\n*Changed in version 2.1.3*: Field becomes nullable.\n",
      "format": "date-time",
      "nullable": true,
      "readOnly": true,
      "type": "string"
    },
    "state": {
      "$ref": "#/components/schemas/DagState"
    }
  }
}