Apache Airflow · JSON Structure

Airflow Bulk Task Instance Body Structure

Request body for bulk update, and delete task instances.

Type: object Properties: 10 Required: 1

Workflow OrchestrationData PipelineOpen SourceApacheDAGSchedulingETLData Engineering

BulkTaskInstanceBody is a JSON Structure definition published by Apache Airflow, describing 10 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

new_state note include_upstream include_downstream include_future include_past task_id map_index dag_id dag_run_id

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

JSON Structure

{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/airflow/refs/heads/main/json-structure/airflow-bulk-task-instance-body-structure.json",
  "name": "BulkTaskInstanceBody",
  "description": "Request body for bulk update, and delete task instances.",
  "type": "object",
  "properties": {
    "new_state": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/TaskInstanceState"
        },
        {
          "type": "null"
        }
      ]
    },
    "note": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 1000
        },
        {
          "type": "null"
        }
      ],
      "title": "Note"
    },
    "include_upstream": {
      "type": "boolean",
      "title": "Include Upstream",
      "default": false
    },
    "include_downstream": {
      "type": "boolean",
      "title": "Include Downstream",
      "default": false
    },
    "include_future": {
      "type": "boolean",
      "title": "Include Future",
      "default": false
    },
    "include_past": {
      "type": "boolean",
      "title": "Include Past",
      "default": false
    },
    "task_id": {
      "type": "string",
      "title": "Task Id"
    },
    "map_index": {
      "anyOf": [
        {
          "type": "int32"
        },
        {
          "type": "null"
        }
      ],
      "title": "Map Index"
    },
    "dag_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Dag Id"
    },
    "dag_run_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Dag Run Id"
    }
  },
  "required": [
    "task_id"
  ],
  "additionalProperties": false
}