Update the manual user note of a DagRun.
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 DagRun note.
v1.0.0Input
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
{
"type": "object",
"properties": {
"note": {
"type": "string",
"description": "Custom notes left by users for this Dag Run."
}
}
}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
{
"type": "object",
"properties": {
"conf": {
"type": "object",
"description": "JSON object describing additional configuration parameters.\n\nThe value of this field can be set only when creating the object. If you try to modify the\nfield of an existing object, the request fails with an BAD_REQUEST error.\n"
},
"dag_id": {
"type": "string"
},
"dag_run_id": {
"type": "string",
"description": "Run ID.\n\nThe value of this field can be set only when creating the object. If you try to modify the\nfield of an existing object, the request fails with an BAD_REQUEST error.\n\nIf not provided, a value will be generated based on execution_date.\n\nIf the specified dag_run_id is in use, the creation request fails with an ALREADY_EXISTS error.\n\nThis together with DAG_ID are a unique key.\n"
},
"data_interval_end": {
"type": "string",
"format": "date-time"
},
"data_interval_start": {
"type": "string",
"format": "date-time"
},
"end_date": {
"type": "string",
"format": "date-time"
},
"execution_date": {
"type": "string",
"format": "date-time",
"description": "The execution date. This is the same as logical_date, kept for backwards compatibility.\nIf both this field and logical_date are provided but with different values, the request\nwill fail with an BAD_REQUEST error.\n\n*Changed in version 2.2.0*: Field becomes nullable.\n\n*Deprecated since version 2.2.0*: Use 'logical_date' instead.\n"
},
"external_trigger": {
"type": "boolean"
},
"last_scheduling_decision": {
"type": "string",
"format": "date-time"
},
"logical_date": {
"type": "string",
"format": "date-time",
"description": "The logical date (previously called execution date). This is the time or interval covered by\nthis DAG run, according to the DAG definition.\n\nThe value of this field can be set only when creating the object. If you try to modify the\nfield of an existing object, the request fails with an BAD_REQUEST error.\n\nThis together with DAG_ID are a unique key.\n\n*New in version 2.2.0*\n"
},
"note": {
"type": "string",
"description": "Contains manually entered notes by the user about the DagRun.\n\n*New in version 2.5.0*\n"
},
"run_type": {
"type": "string",
"enum": [
"backfill",
"manual",
"scheduled",
"dataset_triggered"
]
},
"start_date": {
"type": "string",
"format": "date-time",
"description": "The start time. The time when DAG run was actually created.\n\n*Changed in version 2.1.3*: Field becomes nullable.\n"
},
"state": {
"type": "string",
"description": "DAG State.\n\n*Changed in version 2.1.3*: 'queued' is added as a possible value.\n",
"enum": [
"queued",
"running",
"success",
"failed"
]
}
}
}