Skip to content

Commit efd9190

Browse files
authored
[Docs] General updates 2012-03 (#818)
* Add REST API 3.10 for 2020.4 and 3.11 for 2021.1 * Spelling cleanup * Rearrange and simplify user roles list
1 parent a0618d6 commit efd9190

File tree

2 files changed

+27
-9
lines changed

2 files changed

+27
-9
lines changed

docs/api-ref.md

Lines changed: 23 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -256,7 +256,7 @@ The `ConnectionCredentials` class is used for workbook and data source publish r
256256
Attribute | Description
257257
:--- | :---
258258
`name` | The username for the connection.
259-
`embed_password` | (Boolean) Determines whether to embed the passowrd (`True`) for the workbook or data source connection or not (`False`).
259+
`embed_password` | (Boolean) Determines whether to embed the password (`True`) for the workbook or data source connection or not (`False`).
260260
`password` | The password used for the connection.
261261
`server_address` | The server address for the connection.
262262
`server_port` | The port used by the server.
@@ -289,7 +289,7 @@ The `DatasourceItem` represents the data source resources on Tableau Server. Thi
289289

290290
Name | Description
291291
:--- | :---
292-
`ask_data_enablement` | Determines if a data source allows use of Ask Data. The value can be `TSC.DatasourceItem.AskDataEnablement.Enabled`, `TSC.DatasourceItem.AskDataEnablement.Disabled`, or `TSC.DatasourceItem.AskDataEnablement.SiteDefault`. If no setting is specifed, it will default to SiteDefault. See [REST API Publish Datasource](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_datasources.htm#publish_data_source) for more information about ask_data_enablement.
292+
`ask_data_enablement` | Determines if a data source allows use of Ask Data. The value can be `TSC.DatasourceItem.AskDataEnablement.Enabled`, `TSC.DatasourceItem.AskDataEnablement.Disabled`, or `TSC.DatasourceItem.AskDataEnablement.SiteDefault`. If no setting is specified, it will default to SiteDefault. See [REST API Publish Datasource](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_datasources.htm#publish_data_source) for more information about ask_data_enablement.
293293
`connections` | The list of data connections (`ConnectionItem`) for the specified data source. You must first call the `populate_connections` method to access this data. See the [ConnectionItem class](#connectionitem-class).
294294
`content_url` | The name of the data source as it would appear in a URL.
295295
`created_at` | The date and time when the data source was created.
@@ -567,7 +567,7 @@ datasources.publish(datasource_item, file_path, mode, connection_credentials=Non
567567

568568
Publishes a data source to a server, or appends data to an existing data source.
569569

570-
This method checks the size of the data source and automatically determines whether the publish the data source in multiple parts or in one opeation.
570+
This method checks the size of the data source and automatically determines whether the publish the data source in multiple parts or in one operation.
571571

572572
REST API: [Publish Datasource](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#publish_data_source)
573573

@@ -1271,7 +1271,7 @@ job = server.groups.update(group, as_job=True)
12711271

12721272
Using the TSC library, you can get information about an asynchronous process (or *job*) on the server. These jobs can be created when Tableau runs certain tasks that could be long running, such as importing or synchronizing users from Active Directory, or running an extract refresh. For example, the REST API methods to create or update groups, to run an extract refresh task, or to publish workbooks can take an `asJob` parameter (`asJob-true`) that creates a background process (the *job*) to complete the call. Information about the asynchronous job is returned from the method.
12731273

1274-
If you have the identifer of the job, you can use the TSC library to find out the status of the asynchronous job.
1274+
If you have the identifier of the job, you can use the TSC library to find out the status of the asynchronous job.
12751275

12761276
The job properties are defined in the `JobItem` class. The class corresponds to the properties for jobs you can access using the Tableau Server REST API. The job methods are based upon the endpoints for jobs in the REST API and operate on the `JobItem` class.
12771277

@@ -1875,7 +1875,7 @@ server.views.populate_pdf(view_item, pdf_req_option)
18751875

18761876
Using the TSC library, you can schedule extract refresh or subscription tasks on Tableau Server. You can also get and update information about the scheduled tasks, or delete scheduled tasks.
18771877

1878-
If you have the identifer of the job, you can use the TSC library to find out the status of the asynchronous job.
1878+
If you have the identifier of the job, you can use the TSC library to find out the status of the asynchronous job.
18791879

18801880
The schedule properties are defined in the `ScheduleItem` class. The class corresponds to the properties for schedules you can access in Tableau Server or by using the Tableau Server REST API. The Schedule methods are based upon the endpoints for jobs in the REST API and operate on the `JobItem` class.
18811881

@@ -3127,9 +3127,23 @@ Name | Description
31273127
`email` | The email address of the user.
31283128
`fullname` | The full name of the user.
31293129
`name` | The name of the user. This attribute is required when you are creating a `UserItem` instance.
3130-
`site_role` | The role the user has on the site. This attribute is required with you are creating a `UserItem` instance. The specific roles vary depending upon the version of the REST API. For example, for version 2.8 and earlier, the `site_role` can be one of the following: `Interactor`, `Publisher`, `ServerAdministrator`, `SiteAdministrator`, `Unlicensed`, `UnlicensedWithPublish`, `Viewer`, `ViewerWithPublish`, `Guest`. For REST API 3.0 and later, the `site_role` can be one of the following `Creator`, `Explorer`, `ExplorerCanPublish`, `ReadOnly` *(viewers from previous API versions who do not have v3.0+ viewer permissions)*, `Viewer`, `SiteAdministratorCreator`, `SiteAdministratorExplorer`, `UnlicensedWithPublish`.
3130+
`site_role` | The role the user has on the site. This attribute is required if you are creating a `UserItem` instance. See *User Roles* below for details.
31313131
`groups` | The groups that the user belongs to. You must run the populate_groups method to add the groups to the `UserItem`.
31323132

3133+
**User Roles**
3134+
3135+
The possible user roles for the `site_role` attribute are the following:
3136+
3137+
* `Creator`
3138+
* `Explorer`
3139+
* `ExplorerCanPublish`
3140+
* `ServerAdministrator`
3141+
* `SiteAdministratorExplorer`
3142+
* `SiteAdministratorCreator`
3143+
* `Unlicensed`
3144+
* `ReadOnly`
3145+
* `Viewer`
3146+
31333147

31343148
**Example**
31353149

@@ -3928,7 +3942,7 @@ import tableauserverclient as TSC
39283942
new_workbook = TSC.WorkbookItem('3a8b6148-493c-11e6-a621-6f3499394a39')
39293943

39303944

3931-
````
3945+
```
39323946

39333947
Source file: models/workbook_item.py
39343948

@@ -4066,7 +4080,7 @@ Name | Description
40664080
`workbook_item` | The `workbook_item` specifies the workbook you are publishing. When you are adding a workbook, you need to first create a new instance of a `workbook_item` that includes a `project_id` of an existing project. The name of the workbook will be the name of the file, unless you also specify a name for the new workbook when you create the instance. See [WorkbookItem](#workbookitem-class).
40674081
`file_path` | The path and name of the workbook to publish.
40684082
`mode` | Specifies whether you are publishing a new workbook (`CreateNew`) or overwriting an existing workbook (`Overwrite`). You cannot appending workbooks. You can also use the publish mode attributes, for example: `TSC.Server.PublishMode.Overwrite`.
4069-
`connection_credentials` | (Optional) The credentials (if required) to connect to the workbook's data source. The `ConnectionCredentials` object contains the authentication information for the data source (user name and password, and whether the credentials are embeded or OAuth is used).
4083+
`connection_credentials` | (Optional) The credentials (if required) to connect to the workbook's data source. The `ConnectionCredentials` object contains the authentication information for the data source (user name and password, and whether the credentials are embedded or OAuth is used).
40704084

40714085

40724086

@@ -4293,7 +4307,7 @@ The file path to the downloaded workbook.
42934307
file_path = server.workbooks.download('1a1b1c1d-2e2f-2a2b-3c3d-3e3f4a4b4c4d')
42944308
print("\nDownloaded the file to {0}.".format(file_path))
42954309

4296-
````
4310+
```
42974311

42984312

42994313
<br>

docs/versions.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,8 @@ The current version of TSC only supports the following REST API and Tableau Serv
6464

6565
|REST API version|Tableau Server version|
6666
|---|---|
67+
|3.11|2021.1|
68+
|3.10|2020.4|
6769
|3.9|2020.3|
6870
|3.8|2020.2|
6971
|3.7|2020.1|
@@ -80,3 +82,5 @@ The current version of TSC only supports the following REST API and Tableau Serv
8082
|2.5|10.2|
8183
|2.4|10.1|
8284
|2.3|10.0|
85+
86+
Note that Tableau provides support and security updates for each version of the product for thirty (30) months after release. Review the Supported Versions table on the [Technical Support Programs page](https://www.tableau.com/support/services) for details.

0 commit comments

Comments
 (0)