8000 ready for review.... · d45/server-client-python@9e2e795 · GitHub
[go: up one dir, main page]
Skip to content

Commit 9e2e795

Browse files
d45d45
committed
ready for review....
1 parent 45310dc commit 9e2e795

File tree

1 file changed

+75
-19
lines changed

1 file changed

+75
-19
lines changed

‎docs/docs/api-ref.md

Lines changed: 75 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,32 @@ title: API reference
33
layout: docs
44
---
55

6-
<div class="alert alert-info">
6+
<!---<div class="alert alert-info">
77
<b>Important:</b> More coming soon! This section is under active construction and might not reflect all the available functionality of the TSC library.
88
Until this reference is completed, we have noted the source files in the TSC library where you can get more information for individual endpoints.
9-
</div>
9+
</div> -->
10+
11+
12+
13+
The Tableau Server Client (TSC) is a Python library for the Tableau Server REST API. Using the TSC library, you can manage and change many of the Tableau Server and Tableau Online resources programmatically. You can use this library to create your own custom applications.
14+
15+
The TSC API reference is organized by resource. The TSC library is modeled after the REST API. The methods, for example, `workbooks.get()`, correspond to the endpoints for resources, such as [workbooks](#workbooks), [users](#users), [views](#views), and [data sources](#data-sources). The model classes (for example, the [WorkbookItem class](#workbookitem-class) have attributes that represent the fields (`name`, `id`, `owner_id`) that are in the REST API request and response packages, or payloads.
16+
17+
|:--- |
18+
| **Note:** Some methods and features provided in the REST API might not be currently available in the TSC library. In addition, the same limitations apply to the TSC library that apply to the REST API with respect to resources on Tableau Server and Tableau Online. For more information, see the [Tableau Server REST API Reference](http://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#API_Reference%3FTocPath%3DAPI%2520Reference%7C_____0){:target="_blank"}.|
19+
20+
1021

1122
* TOC
1223
{:toc }
1324
<!-- {:toc ::options toc_levels="1,2"} -->
1425

1526
<!-- {::toc_levels(1,2,3)} -->
1627

28+
<br>
29+
<br>
30+
31+
1732
## Authentication
1833

1934
You can use the TSC library to manage authentication, so you can sign in and sign out of Tableau Server and Tableau Online. The authentication resources for Tableau Server are defined in the `TableauAuth` class and they correspond to the authentication attributes you can access using the Tableau Server REST API.
@@ -269,7 +284,9 @@ Name | Description
269284

270285
**Exceptions**
271286

272-
`Datasource ID undefined` : Raises an exception if a valid `datasource_id` is not provided.
287+
Error | Description
288+
:--- | : ---
289+
`Datasource ID undefined` | Raises an exception if a valid `datasource_id` is not provided.
273290

274291

275292
REST API: [Delete Datasource](http://onlinehelp.tableau.com/v0.0/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Delete_Datasource%3FTocPath%3DAPI%2520Reference%7C_____19){:target="_blank"}
@@ -549,7 +566,9 @@ REST API: [Update Datasource](http://onlinehelp.tableau.com/current/api/rest_api
549566

550567
**Parameters**
551568

552-
`datasource_item` : The `datasource_item` specifies the data source to update.
569+
Name | Description
570+
:--- | : ---
571+
`datasource_item` | The `datasource_item` specifies the data source to update.
553572

554573

555574

@@ -1174,6 +1193,8 @@ Name | Description
11741193

11751194
**Exceptions**
11761195

1196+
Error | Description
1197+
:--- | : ---
11771198
`Project item missing ID.` | Raises an exception if the project item does not have an ID. The project ID is sent to the server as part of the URI.
11781199

11791200

@@ -1229,6 +1250,9 @@ Name | Description
12291250
:--- | :---
12301251
`project_id` | The ID of the project to delete.
12311252

1253+
1254+
1255+
12321256
**Exceptions**
12331257

12341258
Error | Description
@@ -1653,6 +1677,8 @@ Name | Description
16531677

16541678
**Exceptions**
16551679

1680+
Error | Description
1681+
:--- | : ---
16561682
`Site ID undefined.` | Raises an error if an id is not specified.
16571683

16581684

@@ -1789,17 +1815,20 @@ REST API: [Delete Site](https://onlinehelp.tableau.com/current/api/rest_api/en-u
17891815

17901816
**Parameters**
17911817

1792-
57AE 1818+
Name | Description
1819+
:--- | : ---
17931820
`site_id` | The id of the site that you want to delete.
17941821

1795-
1822+
17961823

17971824
**Exceptions**
17981825

17991826
Error | Description
18001827
:--- | :---
18011828
`Site ID Undefined.` | The site id must be present and must match the id of the site you are deleting.
18021829

1830+
1831+
18031832
**Example**
18041833

18051834
```py
@@ -1939,7 +1968,9 @@ REST API: [Add User to Site](http://onlinehelp.tableau.com/current/api/rest_api/
19391968

19401969
**Parameters**
19411970

1942-
`user_item` : You can pass the method a request object that contains additional parameters to filter the request. For example, if you were searching for a specific user, you could specify the name of the user or the user's id.
1971+
Name | Description
1972+
:--- | : ---
1973+
`user_item` | You can pass the method a request object that contains additional parameters to filter the request. For example, if you were searching for a specific user, you could specify the name of the user or the user's id.
19431974

19441975

19451976
**Returns**
@@ -1980,7 +2011,9 @@ REST API: [Get Uers on Site](http://onlinehelp.tableau.com/current/api/rest_api/
19802011

19812012
**Parameters**
19822013

1983-
``req_option` : (Optional) You can pass the method a request object that contains additional parameters to filter the request. For example, if you were searching for a specific user, you could specify the name of the user or the user's id.
2014+
Name | Description
2015+
:--- | : ---
2016+
`req_option` | (Optional) You can pass the method a request object that contains additional parameters to filter the request. For example, if you were searching for a specific user, you could specify the name of the user or the user's id.
19842017

19852018

19862019
**Returns**
@@ -2018,12 +2051,16 @@ REST API: [Query User On Site](http://onlinehelp.tableau.com/current/api/rest_ap
20182051

20192052
**Parameters**
20202053

2021-
`user_id` : The `user_id` specifies the user to query.
2054+
Name | Description
2055+
:--- | : ---
2056+
`user_id` | The `user_id` specifies the user to query.
20222057

20232058

20242059
**Exceptions**
20252060

2026-
`User ID undefined.` : Raises an exception if a valid `user_id` is not provided.
2061+
Error | Description
2062+
:--- | : ---
2063+
`User ID undefined.` | Raises an exception if a valid `user_id` is not provided.
20272064

20282065

20292066
**Returns**
@@ -2072,14 +2109,18 @@ REST API: [Query Datasource Connections](http://onlinehelp.tableau.com/current/
20722109

20732110
**Parameters**
20742111

2075-
`user_item` : The `user_item` specifies the user to populate with workbook information.
2112+
Name | Description
2113+
:--- | : ---
2114+
`user_item` | The `user_item` specifies the user to populate with workbook information.
20762115

20772116

20782117

20792118

20802119
**Exceptions**
20812120

2082-
`User item missing ID.` : Raises an errror if the `user_item` is unspecified.
2121+
Error | Description
2122+
:--- | : ---
2123+
`User item missing ID.` | Raises an errror if the `user_item` is unspecified.
20832124

20842125

20852126
**Returns**
@@ -2126,12 +2167,16 @@ REST API: [Remove User from Site](http://onlinehelp.tableau.com/current/api/rest
21262167

21272168
**Parameters**
21282169

2129-
`user_id` : The identifier (`id`) for the the user that you want to remove from the server.
2170+
Name | Description
2171+
:--- | : ---
2172+
`user_id` | The identifier (`id`) for the the user that you want to remove from the server.
21302173

21312174

21322175
**Exceptions**
21332176

2134-
`User ID undefined` : Raises an exception if a valid `user_id` is not provided.
2177+
Error | Description
2178+
:--- | : ---
2179+
`User ID undefined` | Raises an exception if a valid `user_id` is not provided.
21352180

21362181

21372182
**Example**
@@ -2169,15 +2214,18 @@ REST API: [Update User](http://onlinehelp.tableau.com/current/api/rest_api/en-us
21692214

21702215
**Parameters**
21712216

2172-
`user_item` : The `user_item` specifies the user to update.
2173-
2174-
`password` : (Optional) The new password for the user.
2217+
Name | Description
2218+
:--- | : ---
2219+
`user_item` | The `user_item` specifies the user to update.
2220+
`password` | (Optional) The new password for the user.
21752221

21762222

21772223

21782224
**Exceptions**
21792225

2180-
`User item missing ID.` : Raises an errror if the `user_item` is unspecified.
2226+
Error | Description
2227+
:--- | : ---
2228+
`User item missing ID.` | Raises an errror if the `user_item` is unspecified.
21812229

21822230

21832231
**Returns**
@@ -2326,6 +2374,7 @@ REST API: [Query View Preview Image](http://onlinehelp.tableau.com/current/api/r
23262374
Name | Description
23272375
:--- | :---
23282376
`view_item` | The view item specifies the the `view.id` and `workbook.id` that identifies the preview image.
2377+
23292378

23302379
**Exceptions**
23312380

@@ -2493,7 +2542,9 @@ Name | Description
24932542

24942543
**Exceptions**
24952544

2496-
`Workbook ID undefined` : Raises an exception if a `workbook_id` is not provided.
2545+
Error | Description
2546+
:--- | : ---
2547+
`Workbook ID undefined` | Raises an exception if a `workbook_id` is not provided.
24972548

24982549

24992550
**Returns**
@@ -2656,6 +2707,9 @@ Name | Description
26562707
:--- | :---
26572708
`workbook_id` | The ID of the workbook to delete.
26582709

2710+
2711+
2712+
26592713
**Exceptions**
26602714

26612715
Error | Description
@@ -2870,6 +2924,8 @@ Name | Description
28702924
:--- | :---
28712925
`view_item` | The view item specifies the the `view.id` and `workbook.id` that identifies the preview image.
28722926

2927+
2928+
28732929
**Exceptions**
28742930

28752931
Error | Description

0 commit comments

Comments
 (0)
0