Update the manual user note of a non-mapped Task Instance.
New in version 2.5.0
643 matches
67 actions
Airflow API (Stable)
67 actions
- Clear a DAG runPOSTv1.0.0
- Clear a set of task instancesPOSTv1.0.0
- Create a connectionPOSTv1.0.0
- Create a poolPOSTv1.0.0
- Create a rolePOSTv1.0.0
- Create a userPOSTv1.0.0
- Create a variablePOSTv1.0.0
- Delete a connectionDELETEv1.0.0
- Delete a DAGDELETEv1.0.0
- Delete a DAG runDELETEv1.0.0
- Delete a poolDELETEv1.0.0
- Delete a roleDELETEv1.0.0
- Delete a userDELETEv1.0.0
- Delete a variableDELETEv1.0.0
- Get a connectionGETv1.0.0
- Get a DAG runGETv1.0.0
- Get a datasetGETv1.0.0
- Get a list of loaded pluginsGETv1.0.0
- Get a log entryGETv1.0.0
- Get a mapped task instanceGETv1.0.0
- Get a poolGETv1.0.0
- Get a roleGETv1.0.0
- Get a simplified representation of DAGGETv1.0.0
- Get a source codeGETv1.0.0
- Get a task instanceGETv1.0.0
- Get a userGETv1.0.0
- Get a variableGETv1.0.0
- Get an XCom entryGETv1.0.0
- Get basic information about a DAGGETv1.0.0
- Get current configurationGETv1.0.0
- Get dataset eventsGETv1.0.0
- Get dataset events for a DAG runGETv1.0.0
- Get logsGETv1.0.0
- Get simplified representation of a taskGETv1.0.0
- Get tasks for DAGGETv1.0.0
- List connectionsGETv1.0.0
- List DAG runsGETv1.0.0
- List dag warningsGETv1.0.0
- List DAGsGETv1.0.0
- List datasetsGETv1.0.0
- List extra linksGETv1.0.0
- List log entriesGETv1.0.0
- List mapped task instancesGETv1.0.0
- List permissionsGETv1.0.0
- List poolsGETv1.0.0
- List providersGETv1.0.0
- List rolesGETv1.0.0
- List task instancesGETv1.0.0
- List usersGETv1.0.0
- List variablesGETv1.0.0
- List XCom entriesGETv1.0.0
- Modify a DAG runPATCHv1.0.0
- Set a state of task instancesPOSTv1.0.0
- Test a connectionPOSTv1.0.0
- Trigger a new DAG runPOSTv1.0.0
- Update a connectionPATCHv1.0.0
- Update a DAGPATCHv1.0.0
- Update a poolPATCHv1.0.0
- Update a rolePATCHv1.0.0
- Update a userPATCHv1.0.0
- Update a variablePATCHv1.0.0
- Update DAGsPATCHv1.0.0
- Update the DagRun note.PATCHv1.0.0
- Update the TaskInstance note.PATCHv1.0.0
- Update the TaskInstance note.PATCHv1.0.0
- Updates the state of a mapped task instancePATCHv1.0.0
- Updates the state of a task instancePATCHv1.0.0
Communication/Airflow API (Stable)
Update the TaskInstance note.
v1.0.0Input
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
{
"type": "object",
"required": [
"note"
],
"properties": {
"note": {
"type": "string",
"description": "The custom note to set for this Task Instance."
}
}
}Output
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
- 100
- 101
- 102
- 103
- 104
- 105
- 106
- 107
- 108
- 109
- 110
- 111
- 112
- 113
- 114
- 115
- 116
- 117
- 118
- 119
- 120
- 121
- 122
- 123
- 124
- 125
- 126
- 127
- 128
- 129
- 130
- 131
- 132
- 133
- 134
- 135
- 136
- 137
- 138
- 139
- 140
- 141
- 142
- 143
- 144
- 145
- 146
- 147
- 148
- 149
- 150
- 151
- 152
- 153
- 154
- 155
- 156
- 157
- 158
- 159
- 160
- 161
- 162
- 163
- 164
- 165
- 166
- 167
- 168
- 169
- 170
- 171
- 172
- 173
- 174
- 175
- 176
- 177
- 178
- 179
- 180
- 181
- 182
- 183
- 184
- 185
- 186
{
"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"
}
}
}