Apache Airflow · Schema

BulkTaskInstanceBody

Request body for bulk update, and delete task instances.

Workflow OrchestrationData PipelineOpen SourceApacheDAGSchedulingETLData Engineering

Properties

Name Type Description
new_state object
note object
include_upstream boolean
include_downstream boolean
include_future boolean
include_past boolean
task_id string
map_index object
dag_id object
dag_run_id object
View JSON Schema on GitHub

JSON Schema

airflow-bulk-task-instance-body-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/airflow/refs/heads/main/json-schema/airflow-bulk-task-instance-body-schema.json",
  "title": "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": "integer"
        },
        {
          "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
}