Apache Airflow · JSON Structure

Airflow Patch Task Instance Body Structure

Request body for Clear Task Instances endpoint.

Type: object Properties: 6
Workflow OrchestrationData PipelineOpen SourceApacheDAGSchedulingETLData Engineering

PatchTaskInstanceBody is a JSON Structure definition published by Apache Airflow, describing 6 properties. 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

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/airflow/refs/heads/main/json-structure/airflow-patch-task-instance-body-structure.json",
  "name": "PatchTaskInstanceBody",
  "description": "Request body for Clear Task Instances endpoint.",
  "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
    }
  },
  "additionalProperties": false
}