action apache_set_mapped_task_instance_note { label: "Update the TaskInstance note." description: "Update the manual user note of a mapped Task Instance.\n\n*New in version 2.5.0*\n" provider: apache method: PATCH path: "/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/{map_index}/setNote" encoding: json input: { type: "object" required: ["note"] properties: { note: { type: "string" description: "The custom note to set for this Task Instance." } } } output: { type: "object" properties: { dag_id: { type: "string" } dag_run_id: { type: "string" description: "The DagRun ID for this task instance\n\n*New in version 2.3.0*\n" } duration: { type: "number" } end_date: { type: "string" format: "datetime" } execution_date: { type: "string" format: "datetime" } executor_config: { type: "string" } hostname: { type: "string" } map_index: { type: "integer" } max_tries: { type: "integer" } note: { type: "string" description: "Contains manually entered notes by the user about the TaskInstance.\n\n*New in version 2.5.0*\n" } operator: { type: "string" description: "*Changed in version 2.1.1*: Field becomes nullable.\n" } pid: { type: "integer" } pool: { type: "string" } pool_slots: { type: "integer" } priority_weight: { type: "integer" } queue: { type: "string" } queued_when: { type: "string" } rendered_fields: { type: "object" description: "JSON object describing rendered fields.\n\n*New in version 2.3.0*\n" } sla_miss: { type: "object" properties: { dag_id: { type: "string" description: "The DAG ID." } description: { type: "string" } email_sent: { type: "boolean" } execution_date: { type: "string" format: "datetime" } notification_sent: { type: "boolean" } task_id: { type: "string" description: "The task ID." } timestamp: { type: "string" format: "datetime" } } } start_date: { type: "string" format: "datetime" } state: { type: "string" description: "Task state.\n\n*Changed in version 2.0.2*: 'removed' is added as a possible value.\n\n*Changed in version 2.2.0*: 'deferred' is added as a possible value.\n\n*Changed in version 2.4.0*: 'sensing' state has been removed.\n*Changed in version 2.4.2*: 'restarting' is added as a possible value\n" enum: ["success", "running", "failed", "upstream_failed", "skipped", "up_for_retry", "up_for_reschedule", "queued", "none", "scheduled", "deferred", "removed", "restarting"] } task_id: { type: "string" } trigger: { type: "object" properties: { classpath: { type: "string" } created_date: { type: "string" format: "datetime" } id: { type: "integer" } kwargs: { type: "string" } triggerer_id: { type: "integer" } } } triggerer_job: { type: "object" properties: { dag_id: { type: "string" } end_date: { type: "string" format: "datetime" } executor_class: { type: "string" } hostname: { type: "string" } id: { type: "integer" } job_type: { type: "string" } latest_heartbeat: { type: "string" format: "datetime" } start_date: { type: "string" format: "datetime" } state: { type: "string" } unixname: { type: "string" } } } try_number: { type: "integer" } unixname: { type: "string" } } } }