Apache Airflow · JSON Structure

Openapi.Yaml List Dag Runs Form Structure

ListDagRunsForm schema from Apache Airflow API

Type: object Properties: 11
ApacheDAGData PipelineETLOpen SourceOrchestrationPythonSchedulingWorkflow

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

Properties

dag_ids end_date_gte end_date_lte execution_date_gte execution_date_lte order_by page_limit page_offset start_date_gte start_date_lte states

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-list-dag-runs-form-structure.json",
  "name": "ListDagRunsForm",
  "description": "ListDagRunsForm schema from Apache Airflow API",
  "type": "object",
  "properties": {
    "dag_ids": {
      "description": "Return objects with specific DAG IDs.\nThe value can be repeated to retrieve multiple matching values (OR condition).",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "end_date_gte": {
      "description": "Returns objects greater or equal the specified date.\n\nThis can be combined with end_date_lte parameter to receive only the selected period.\n",
      "format": "date-time",
      "type": "string"
    },
    "end_date_lte": {
      "description": "Returns objects less than or equal to the specified date.\n\nThis can be combined with end_date_gte parameter to receive only the selected period.\n",
      "format": "date-time",
      "type": "string"
    },
    "execution_date_gte": {
      "description": "Returns objects greater or equal to the specified date.\n\nThis can be combined with execution_date_lte key to receive only the selected period.\n",
      "format": "date-time",
      "type": "string"
    },
    "execution_date_lte": {
      "description": "Returns objects less than or equal to the specified date.\n\nThis can be combined with execution_date_gte key to receive only the selected period.\n",
      "format": "date-time",
      "type": "string"
    },
    "order_by": {
      "description": "The name of the field to order the results by. Prefix a field name\nwith `-` to reverse the sort order.\n\n*New in version 2.1.0*\n",
      "type": "string"
    },
    "page_limit": {
      "default": 100,
      "description": "The numbers of items to return.",
      "minimum": 1,
      "type": "integer"
    },
    "page_offset": {
      "description": "The number of items to skip before starting to collect the result set.",
      "minimum": 0,
      "type": "integer"
    },
    "start_date_gte": {
      "description": "Returns objects greater or equal the specified date.\n\nThis can be combined with start_date_lte key to receive only the selected period.\n",
      "format": "date-time",
      "type": "string"
    },
    "start_date_lte": {
      "description": "Returns objects less or equal the specified date.\n\nThis can be combined with start_date_gte parameter to receive only the selected period\n",
      "format": "date-time",
      "type": "string"
    },
    "states": {
      "description": "Return objects with specific states.\nThe value can be repeated to retrieve multiple matching values (OR condition).",
      "items": {
        "type": "string"
      },
      "type": "array"
    }
  }
}