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
Copy file name to clipboardExpand all lines: docs/api-ref.md
+209Lines changed: 209 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -2883,6 +2883,215 @@ The `SubscriptionItem`. See [SubscriptionItem class](#subscriptionitem-class)
2883
2883
<br>
2884
2884
<br>
2885
2885
2886
+
---
2887
+
2888
+
## Tasks
2889
+
2890
+
Using the TSC library, you can get information about all the tasks on a site and you can remove tasks. To create new tasks see [Schedules](#schedules).
2891
+
2892
+
The task resources for Tableau Server are defined in the `TaskItem` class. The class corresponds to the task resources you can access using the Tableau Server REST API. The task methods are based upon the endpoints for tasks in the REST API and operate on the `TaskItem` class.
The Tableau Server Client provides several methods for interacting with task resources, or endpoints. These methods correspond to endpoints in the Tableau Server REST API.
2932
+
2933
+
Source file: server/endpoint/tasks_endpoint.py
2934
+
<br>
2935
+
<br>
2936
+
2937
+
#### tasks.get
2938
+
2939
+
```py
2940
+
tasks.get(req_options=None)
2941
+
```
2942
+
2943
+
Returns information about the tasks on the specified site.
2944
+
2945
+
REST API: [Get Extract Refresh Tasks on Site](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#get_extract_refresh_tasks){:target="_blank"}
2946
+
2947
+
2948
+
**Parameters**
2949
+
2950
+
Name | Description
2951
+
:--- | : ---
2952
+
`req_option` | (Optional) You can pass the method a request object that contains additional parameters to filter the request.
2953
+
2954
+
2955
+
**Returns**
2956
+
2957
+
Returns a list of `TaskItem` objects and a `PaginationItem` object. Use these values to iterate through the results.
0 commit comments