You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Documents the complete flow_runs endpoint, which was entirely absent
from the docs, including FlowRunItem class attributes and all methods:
get, get_by_id, cancel, wait_for_job (all API 3.10).
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Copy file name to clipboardExpand all lines: docs/api-ref.md
+202Lines changed: 202 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1210,6 +1210,208 @@ Name | Description
1210
1210
1211
1211
1212
1212
1213
+
<br>
1214
+
<br>
1215
+
1216
+
---
1217
+
1218
+
## Flow Runs
1219
+
1220
+
Using the TSC library, you can query flow runs on a site, get details about a specific flow run, cancel a running flow, or wait for a flow run to complete. Flow runs are created when a flow is triggered to run, either manually or on a schedule.
1221
+
1222
+
The flow run resources for Tableau Server are defined in the `FlowRunItem` class. The class corresponds to the flow run resources you can access using the Tableau Server REST API.
1223
+
1224
+
<br>
1225
+
1226
+
### FlowRunItem class
1227
+
1228
+
The `FlowRunItem` represents the result of a flow run on Tableau Server. Instances of this class are returned by the flow run methods; you do not create them directly.
1229
+
1230
+
**Attributes**
1231
+
1232
+
Name | Description
1233
+
:--- | :---
1234
+
`id` | The identifier for the flow run.
1235
+
`flow_id` | The identifier of the flow that was run.
1236
+
`status` | The current status of the flow run. Possible values include `Success`, `Failed`, and `Cancelled`.
1237
+
`started_at` | The date and time when the flow run started.
1238
+
`completed_at` | The date and time when the flow run completed. Is `None` if the run is still in progress.
1239
+
`progress` | The progress percentage of the flow run.
1240
+
`background_job_id` | The identifier of the background job associated with the flow run.
1241
+
1242
+
Source file: models/flow_run_item.py
1243
+
1244
+
<br>
1245
+
<br>
1246
+
1247
+
### Flow Runs methods
1248
+
1249
+
The Tableau Server Client provides several methods for interacting with flow run resources. These methods correspond to endpoints in the Tableau Server REST API.
Waits for the specified flow run to complete and returns the finished `FlowRunItem`. This method polls the server repeatedly using exponential backoff until the run completes, then raises an exception if it failed or was cancelled.
1380
+
1381
+
**Parameters**
1382
+
1383
+
Name | Description
1384
+
:--- | :---
1385
+
`flow_run_id` | The identifier (`id`) for the flow run to wait for. Can be the id string or a `FlowRunItem` object.
1386
+
`timeout` | (Optional) The maximum number of seconds to wait before raising a timeout error. If not specified, waits indefinitely.
1387
+
1388
+
**Exceptions**
1389
+
1390
+
Error | Description
1391
+
:--- | :---
1392
+
`FlowRunFailedException` | Raised if the flow run completes with a `Failed` status.
1393
+
`FlowRunCancelledException` | Raised if the flow run completes with a `Cancelled` status.
1394
+
1395
+
**Returns**
1396
+
1397
+
Returns the completed `FlowRunItem` if the run succeeded.
1398
+
1399
+
**Version**
1400
+
1401
+
Version 3.10 and later. See [REST API versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm).
0 commit comments