diff --git a/.gitignore b/.gitignore
index d7496406b..e7dc31618 100644
--- a/.gitignore
+++ b/.gitignore
@@ -144,6 +144,6 @@ $RECYCLE.BIN/
*.lnk
# Documentation
-docs/_site/
-docs/.jekyll-metadata
-docs/Gemfile.lock
+_site/
+.jekyll-metadata
+Gemfile.lock
diff --git a/_includes/docs_menu.html b/_includes/docs_menu.html
index 2f5ab1b04..5693ee67e 100644
--- a/_includes/docs_menu.html
+++ b/_includes/docs_menu.html
@@ -11,7 +11,7 @@
Versions
- Page through Results
+ Page Through Results
Populate Connections and Views
@@ -53,7 +53,7 @@
Requests
- Schedules
+ Schedules
Server
diff --git a/_includes/header.html b/_includes/header.html
index a42240f87..b8ad08f65 100644
--- a/_includes/header.html
+++ b/_includes/header.html
@@ -15,7 +15,7 @@
diff --git a/docs/api-ref.md b/docs/api-ref.md
index 51e4b4e26..628221247 100644
--- a/docs/api-ref.md
+++ b/docs/api-ref.md
@@ -15,7 +15,7 @@ The Tableau Server Client (TSC) is a Python library for the Tableau Server REST
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.
|:--- |
-| **Note:** Some methods and features provided in the REST API might not be currently available in the TSC library (and in some cases, the opposite is true). 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](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#API_Reference0){:target="_blank"}.|
+| **Note:** Some methods and features provided in the REST API might not be currently available in the TSC library (and in some cases, the opposite is true). 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](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm).|
@@ -90,7 +90,7 @@ Signs you in to Tableau Server.
The method signs into Tableau Server or Tableau Online and manages the authentication token. You call this method from the server object you create. For information about the server object, see [Server](#server). The authentication token keeps you signed in for 240 minutes, or until you call the `auth.sign_out` method. Before you use this method, you first need to create the sign-in request (`auth_req`) object by creating an instance of the `TableauAuth`. To call this method, create a server object for your server. For more information, see [Sign in and Out](sign-in-out).
-REST API: [Sign In](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#sign_in){:target="_blank"}
+REST API: [Sign In](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#sign_in)
**Parameters**
@@ -131,7 +131,7 @@ Signs you out of the current session.
The `sign_out()` method takes care of invalidating the authentication token. For more information, see [Sign in and Out](sign-in-out).
-REST API: [Sign Out](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#ign_out){:target="_blank"}
+REST API: [Sign Out](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#sign_out)
**Example**
@@ -210,7 +210,7 @@ Attribute | Description
`password` | The password used for the connection.
`server_address` | The server address for the connection.
`server_port` | The port used by the server.
-`ouath` | (Boolean) Specifies whether OAuth is used for the data source of workbook connection. For more information, see [OAuth Connections](https://onlinehelp.tableau.com/current/server/en-us/protected_auth.htm?Highlight=oauth%20connections){:target="_blank"}.
+`ouath` | (Boolean) Specifies whether OAuth is used for the data source of workbook connection. For more information, see [OAuth Connections](https://help.tableau.com/current/server/en-us/protected_auth.htm).
Source file: models/connection_credentials.py
@@ -302,7 +302,7 @@ Error | Description
`Datasource ID undefined` | Raises an exception if a valid `datasource_id` is not provided.
-REST API: [Delete Datasource](https://onlinehelp.tableau.com/v0.0/api/rest_api/en-us/REST/rest_api_ref.htm#delete_data_source){:target="_blank"}
+REST API: [Delete Datasource](https://help.tableau.com/v0.0/api/rest_api/en-us/REST/rest_api_ref.htm#delete_data_source)
@@ -316,7 +316,7 @@ datasources.download(datasource_id, filepath=None, include_extract=True, no_extr
```
Downloads the specified data source in `.tdsx` or `.hyper` format.
-REST API: [Download Datasource](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#download_data_source){:target="_blank"}
+REST API: [Download Datasource](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#download_data_source)
**Parameters**
@@ -361,7 +361,7 @@ Returns all the data sources for the site.
To get the connection information for each data source, you must first populate the `DatasourceItem` with connection information using the [populate_connections(*datasource_item*)](#populate-connections-datasource) method. For more information, see [Populate Connections and Views](populate-connections-views#populate-connections-for-data-sources)
-REST API: [Query Datasources](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_data_sources){:target="_blank"}
+REST API: [Query Datasources](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_data_sources)
**Parameters**
@@ -404,7 +404,7 @@ datasources.get_by_id(datasource_id)
Returns the specified data source item.
-REST API: [Query Datasource](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_data_source){:target="_blank"}
+REST API: [Query Datasource](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_data_source)
**Parameters**
@@ -451,7 +451,7 @@ Populates the connections for the specified data source.
This method retrieves the connection information for the specified data source. The REST API is designed to return only the information you ask for explicitly. When you query for all the data sources, the connection information is not included. Use this method to retrieve the connections. The method adds the list of data connections to the data source item (`datasource_item.connections`). This is a list of `ConnectionItem` objects.
-REST API: [Query Datasource Connections](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_data_source_connections){:target="_blank"}
+REST API: [Query Datasource Connections](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_data_source_connections)
**Parameters**
@@ -513,7 +513,7 @@ Publishes a data source to a server, or appends data to an existing data source.
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.
-REST API: [Publish Datasource](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#publish_data_source){:target="_blank"}
+REST API: [Publish Datasource](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#publish_data_source)
**Parameters**
@@ -574,7 +574,7 @@ datasource.refresh(datasource_item)
Refreshes the data of the specified extract.
-REST API: [Update Data Source Now](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_datasources.htm#update_data_source_now){:target="_blank"}
+REST API: [Update Data Source Now](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_datasources.htm#update_data_source_now)
**Parameters**
@@ -621,7 +621,7 @@ datasource.update(datasource_item)
Updates the owner or project of the specified data source. Data source name cannot be updated.
-REST API: [Update Datasource](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_data_source){:target="_blank"}
+REST API: [Update Datasource](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_data_source)
**Parameters**
@@ -673,7 +673,7 @@ datasource.update_connection(datasource_item, connection_item)
Updates the server address, port, username, or password for the specified data source connection.
-REST API: [Update Datasource Connection](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_data_source_connection){:target="_blank"}
+REST API: [Update Datasource Connection](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_data_source_connection)
**Parameters**
@@ -801,7 +801,7 @@ groups.add_user(group_item, user_id):
Adds a user to the specified group.
-REST API [Add User to Group](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#add_user_to_group){:target="_blank"}
+REST API [Add User to Group](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#add_user_to_group)
**Parameters**
@@ -848,7 +848,7 @@ create(group_item)
Creates a new group in Tableau Server.
-REST API: [Create Group](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#create_group){:target="_blank"}
+REST API: [Create Group](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#create_group)
**Parameters**
@@ -898,7 +898,7 @@ groups.delete(group_id)
Deletes the group on the site.
-REST API: [Delete Group](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#remove_user_from_site){:target="_blank"}
+REST API: [Delete Group](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#remove_user_from_site)
**Parameters**
@@ -943,7 +943,7 @@ Returns information about the groups on the site.
To get information about the users in a group, you must first populate the `GroupItem` with user information using the [groups.populate_users](api-ref#groupspopulate_users) method.
-REST API: [Get Users on Site](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#get_users_on_site){:target="_blank"}
+REST API: [Get Users on Site](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#get_users_on_site)
**Parameters**
@@ -988,7 +988,7 @@ groups.populate_users(group_item, req_options=None)
Populates the `group_item` with the list of users.
-REST API: [Get Users in Group](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#get_users_in_group){:target="_blank"}
+REST API: [Get Users in Group](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#get_users_in_group)
**Parameters**
@@ -1049,7 +1049,7 @@ Removes a user from a group.
-REST API: [Remove User from Group](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#remove_user_to_group){:target="_blank"}
+REST API: [Remove User from Group](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#remove_user_to_group)
**Parameters**
@@ -1122,7 +1122,7 @@ Source file: models/job_item.py
Name | Description
:--- | :---
`id` | The `id` of the job.
-`type` | The type of task. The types correspond to the job type categories listed for the [Query Job](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_job){:target="_blank"} REST API.
+`type` | The type of task. The types correspond to the job type categories listed for the [Query Job](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_job) REST API.
`created_at` | The time the job was created.
`started_at` | The time the job started.
`completed_at` | The time the job finished.
@@ -1151,7 +1151,7 @@ jobs.get(job_id)
Gets information about the specified job.
-REST API: [Query Job](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_job){:target="_blank"}
+REST API: [Query Job](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_job)
**Parameters**
@@ -1238,7 +1238,7 @@ Name | Description
`name` | Name of the project.
`description` | The description of the project.
`id` | The project id.
-`parent_id` | The id of the parent project. Use this option to create project hierarchies. For information about managing projects, project hierarchies, and permissions, see [Use Projects to Manage Content Access](https://onlinehelp.tableau.com/current/server/en-us/projects.htm){:target="_blank"}.
+`parent_id` | The id of the parent project. Use this option to create project hierarchies. For information about managing projects, project hierarchies, and permissions, see [Use Projects to Manage Content Access](https://help.tableau.com/current/server/en-us/projects.htm).
@@ -1247,7 +1247,7 @@ Source file: models/project_item.py
#### ProjectItem.ContentPermissions
-The `ProjectItem` class has a sub-class that defines the permissions for the project (`ProjectItem.ContentPermissions`). The options are `LockedToProject` and `ManagedByOwner`. For information on these content permissions, see [Lock Content Permissions to the Project](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#create_project){:target="_blank"}.
+The `ProjectItem` class has a sub-class that defines the permissions for the project (`ProjectItem.ContentPermissions`). The options are `LockedToProject` and `ManagedByOwner`. For information on these content permissions, see [Lock Content Permissions to the Project](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#create_project).
Name | Description
:--- | :---
@@ -1303,7 +1303,7 @@ Creates a project on the specified site.
To create a project, you first create a new instance of a `ProjectItem` and pass it to the create method. To specify the site to create the new project, create a `TableauAuth` instance using the content URL for the site (`site_id`), and sign in to that site. See the [TableauAuth class](#tableauauth-class).
-REST API: [Create Project](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#create_project){:target="_blank"}
+REST API: [Create Project](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#create_project)
**Parameters**
@@ -1348,7 +1348,7 @@ Return a list of project items for a site.
To specify the site, create a `TableauAuth` instance using the content URL for the site (`site_id`), and sign in to that site. See the [TableauAuth class](#tableauauth-class).
-REST API: [Query Projects](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_projects){:target="_blank"}
+REST API: [Query Projects](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_projects)
**Parameters**
@@ -1389,7 +1389,7 @@ Modify the project settings.
You can use this method to update the project name, the project description, or the project permissions. To specify the site, create a `TableauAuth` instance using the content URL for the site (`site_id`), and sign in to that site. See the [TableauAuth class](#tableauauth-class).
-REST API: [Update Project](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_project){:target="_blank"}
+REST API: [Update Project](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_project)
**Parameters**
@@ -1451,7 +1451,7 @@ Deletes a project by ID.
To specify the site, create a `TableauAuth` instance using the content URL for the site (`site_id`), and sign in to that site. See the [TableauAuth class](#tableauauth-class).
-REST API: [Delete Project](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#delete_project){:target="_blank"}
+REST API: [Delete Project](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#delete_project)
**Parameters**
@@ -1534,7 +1534,7 @@ Name | Description
#### RequestOptions.Field class
-The `RequestOptions.Field` class corresponds to the fields used in filter expressions in the Tableau REST API. For more information, see [Filtering and Sorting](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_filtering_and_sorting.htm){:target="_blank"} in the Tableau REST API.
+The `RequestOptions.Field` class corresponds to the fields used in filter expressions in the Tableau REST API. For more information, see [Filtering and Sorting](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_filtering_and_sorting.htm) in the Tableau REST API.
**Attributes**
@@ -1762,7 +1762,7 @@ schedule.create(schedule_item)
Creates a new schedule for an extract refresh or a subscription.
-REST API: [Create Schedule](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#create_schedule){:target="_blank"}
+REST API: [Create Schedule](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#create_schedule)
@@ -1811,7 +1811,7 @@ schedule.delete(schedule_id)
Deletes an existing schedule for an extract refresh or a subscription.
-REST API: [Delete Schedule](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#delete_schedule){:target="_blank"}
+REST API: [Delete Schedule](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#delete_schedule)
@@ -1842,7 +1842,7 @@ schedule.get([req_options=None])
Returns all schedule items from the server.
-REST API: [Query Schedules](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_schedules){:target="_blank"}
+REST API: [Query Schedules](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_schedules)
@@ -1948,7 +1948,7 @@ The `Server` class contains the attributes that represent the server on Tableau
Attribute | Description
:--- | :---
`server_address` | Specifies the address of the Tableau Server or Tableau Online (for example, `https://MY-SERVER/`).
-`version` | Specifies the version of the REST API to use (for example, `'2.5'`). When you use the TSC library to call methods that access Tableau Server, the `version` is passed to the endpoint as part of the URI (`https://MY-SERVER/api/2.5/`). Each release of Tableau Server supports specific versions of the REST API. New versions of the REST API are released with Tableau Server. By default, the value of `version` is set to `'2.3'`, which corresponds to Tableau Server 10.0. You can view or set this value. You might need to set this to a different value, for example, if you want to access features that are supported by the server and a later version of the REST API. For more information, see [REST API Versions](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm){:target="_blank"}
+`version` | Specifies the version of the REST API to use (for example, `'2.5'`). When you use the TSC library to call methods that access Tableau Server, the `version` is passed to the endpoint as part of the URI (`https://MY-SERVER/api/2.5/`). Each release of Tableau Server supports specific versions of the REST API. New versions of the REST API are released with Tableau Server. By default, the value of `version` is set to `'2.3'`, which corresponds to Tableau Server 10.0. You can view or set this value. You might need to set this to a different value, for example, if you want to access features that are supported by the server and a later version of the REST API. For more information, see [REST API Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm).
@@ -2070,7 +2070,7 @@ Retrieve the build and version information for the server.
This method makes an unauthenticated call, so no sign in or authentication token is required.
-REST API: [Server Info](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#server_info){:target="_blank"}
+REST API: [Server Info](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#server_info)
**Parameters**
None
@@ -2178,7 +2178,7 @@ Creates a new site on the server for the specified site item object.
Tableau Server only.
-REST API: [Create Site](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#create_site){:target="_blank"}
+REST API: [Create Site](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#create_site)
@@ -2223,7 +2223,7 @@ sites.get()
Queries all the sites on the server.
-REST API: [Query Sites](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_sites){:target="_blank"}
+REST API: [Query Sites](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_sites)
**Parameters**
@@ -2266,7 +2266,7 @@ sites.get_by_id(site_id)
Queries the site with the given ID.
-REST API: [Query Site](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_site){:target="_blank"}
+REST API: [Query Site](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_site)
**Parameters**
@@ -2312,7 +2312,7 @@ sites.get_by_name(site_name)
Queries the site with the specified name.
-REST API: [Query Site](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_site){:target="_blank"}
+REST API: [Query Site](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_site)
**Parameters**
@@ -2363,7 +2363,7 @@ Modifies the settings for site.
The site item object must include the site ID and overrides all other settings.
-REST API: [Update Site](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_site){:target="_blank"}
+REST API: [Update Site](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_site)
**Parameters**
@@ -2416,7 +2416,7 @@ Sites.delete(site_id)
Deletes the specified site.
-REST API: [Delete Site](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#Delete_Site27){:target="_name"}
+REST API: [Delete Site](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#delete_site)
**Parameters**
@@ -2553,7 +2553,7 @@ When a user is subscribed to the content, Tableau Server sends the content to th
To create a new subscription you need to first create a new `subscription_item` (from `SubscriptionItem` class).
-REST API: [Create Subscription](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#create_subscription){:target="_blank"}
+REST API: [Create Subscription](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#create_subscription)
**Parameters**
@@ -2612,7 +2612,7 @@ subscriptions.delete(subscription_id)
Deletes the specified subscription from the site.
-REST API: [Delete Subscription](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#delete_subscription){:target="_blank"}
+REST API: [Delete Subscription](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#delete_subscription)
**Parameters**
@@ -2657,7 +2657,7 @@ subscription.get(req_options=None)
Returns information about the subscriptions on the specified site.
-REST API: [Query Subscriptions](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_subscriptions){:target="_blank"}
+REST API: [Query Subscriptions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_subscriptions)
**Parameters**
@@ -2682,7 +2682,7 @@ subscription.get_by_id(subscription_id)
Returns information about the specified subscription.
-REST API: [Query Subscription](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_subscription){:target="_blank"}
+REST API: [Query Subscription](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_subscription)
**Parameters**
@@ -2790,7 +2790,7 @@ Adds the user to the site.
To add a new user to the site you need to first create a new `user_item` (from `UserItem` class). When you create a new user, you specify the name of the user and their site role. For Tableau Online, you also specify the `auth_setting` attribute in your request. When you add user to Tableau Online, the name of the user must be the email address that is used to sign in to Tableau Online. After you add a user, Tableau Online sends the user an email invitation. The user can click the link in the invitation to sign in and update their full name and password.
-REST API: [Add User to Site](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#add_user_to_site){:target="_blank"}
+REST API: [Add User to Site](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#add_user_to_site)
**Parameters**
@@ -2833,7 +2833,7 @@ Returns information about the users on the specified site.
To get information about the workbooks a user owns or has view permission for, you must first populate the `UserItem` with workbook information using the [populate_workbooks(*user_item*)](#populate-workbooks-user) method.
-REST API: [Get Users on Site](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#get_users_on_site){:target="_blank"}
+REST API: [Get Users on Site](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#get_users_on_site)
**Parameters**
@@ -2873,7 +2873,7 @@ users.get_by_id(user_id)
Returns information about the specified user.
-REST API: [Query User On Site](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_user_on_site){:target="_blank"}
+REST API: [Query User On Site](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_user_on_site)
**Parameters**
@@ -2932,7 +2932,7 @@ Returns information about the workbooks that the specified user owns and has Rea
This method retrieves the workbook information for the specified user. The REST API is designed to return only the information you ask for explicitly. When you query for all the users, the workbook information for each user is not included. Use this method to retrieve information about the workbooks that the user owns or has Read (view) permissions. The method adds the list of workbooks to the user item object (`user_item.workbooks`).
-REST API: [Query Datasource Connections](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_data_source_connections){:target="_blank"}
+REST API: [Query Datasource Connections](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_data_source_connections)
**Parameters**
@@ -2989,7 +2989,7 @@ users.remove(user_id)
Removes the specified user from the site.
-REST API: [Remove User from Site](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#remove_user_from_site){:target="_blank"}
+REST API: [Remove User from Site](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#remove_user_from_site)
**Parameters**
@@ -3033,11 +3033,11 @@ users.update(user_item, password=None)
Updates information about the specified user.
-The information you can modify depends upon whether you are using Tableau Server or Tableau Online, and whether you have configured Tableau Server to use local authentication or Active Directory. For more information, see [Update User](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_user){:target="_blank"}.
+The information you can modify depends upon whether you are using Tableau Server or Tableau Online, and whether you have configured Tableau Server to use local authentication or Active Directory. For more information, see [Update User](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_user).
-REST API: [Update User](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_user){:target="_blank"}
+REST API: [Update User](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_user)
**Parameters**
@@ -3154,7 +3154,7 @@ views.get(req_options=None, usage=False)
Returns the list of views items for a site.
-REST API: [Query Views for Site](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_views_for_site){:target="_blank"}
+REST API: [Query Views for Site](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_views_for_site)
**Version**
@@ -3209,7 +3209,7 @@ Populates a preview image for the specified view.
This method gets the preview image (thumbnail) for the specified view item. The method uses the `id` and `workbook_id` fields to query the preview image. The method populates the `preview_image` for the view.
-REST API: [Query View Preview Image](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_view_with_preview){:target="_blank"}
+REST API: [Query View Preview Image](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_view_with_preview)
**Version**
@@ -3258,7 +3258,7 @@ Populates the image of the specified view.
This method uses the `id` field to query the image, and populates the image content as the `image` field.
-REST API: [Query View Image](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_view_image){:target="_blank"}
+REST API: [Query View Image](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_view_image)
**Version**
@@ -3305,7 +3305,7 @@ Populates the CSV data of the specified view.
This method uses the `id` field to query the CSV data, and populates the data as the `csv` field.
-REST API: [Query View Data](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_view_data){:target="_blank"}
+REST API: [Query View Data](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_view_data)
**Version**
@@ -3353,7 +3353,7 @@ Populates the PDF content of the specified view.
This method populates a PDF with image(s) of the view you specify.
-REST API: [Query View PDF](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_view_pdf){:target="_blank"}
+REST API: [Query View PDF](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_view_pdf)
**Version**
@@ -3484,7 +3484,7 @@ Queries the server and returns information about the workbooks the site.
-REST API: [Query Workbooks for Site](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_workbooks_for_site){:target="_blank"}
+REST API: [Query Workbooks for Site](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_workbooks_for_site)
**Parameters**
@@ -3529,7 +3529,7 @@ workbooks.get_by_id(workbook_id)
Returns information about the specified workbook on the site.
-REST API: [Query Workbook](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_workbook){:target="_blank"}
+REST API: [Query Workbook](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_workbook)
**Parameters**
@@ -3580,7 +3580,7 @@ unless you package the data and workbook in a .twbx file, or publish the data so
For workbooks that are larger than 64 MB, the publish method automatically takes care of chunking the file in parts for uploading. Using this method is considerably more convenient than calling the publish REST APIs directly.
-REST API: [Publish Workbook](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#publish_workbook){:target="_blank"}, [Initiate File Upload](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#initiate_file_upload){:target="_blank"}, [Append to File Upload](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#append_to_file_upload){:target="_blank"}
+REST API: [Publish Workbook](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#publish_workbook), [Initiate File Upload](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#initiate_file_upload), [Append to File Upload](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#append_to_file_upload)
@@ -3604,7 +3604,7 @@ Error | Description
`Workbooks cannot be appended.` | The `mode` must be set to `Overwrite` or `CreateNew`.
`Only .twb or twbx files can be published as workbooks.` | Raises an error if the type of file specified is not supported.
-See the REST API [Publish Workbook](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#publish_workbook){:target="_blank"} for additional error codes.
+See the REST API [Publish Workbook](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#publish_workbook) for additional error codes.
**Returns**
@@ -3638,7 +3638,7 @@ workbooks.refresh(workbook_item)
Refreshes the extract of an existing workbook.
-REST API: [Update Workbook Now](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_workbooksviews.htm#update_workbook_now){:target="_blank"}
+REST API: [Update Workbook Now](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_workbooksviews.htm#update_workbook_now)
**Parameters**
@@ -3684,7 +3684,7 @@ workbooks.update(workbook_item)
Modifies an existing workbook. Use this method to change the owner or the project that the workbook belongs to, or to change whether the workbook shows views in tabs. The workbook item must include the workbook ID and overrides the existing settings.
-REST API: [Update Workbooks](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_workbook){:target="_blank"}
+REST API: [Update Workbooks](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_workbook)
**Parameters**
@@ -3742,7 +3742,7 @@ Deletes a workbook with the specified ID.
To specify the site, create a `TableauAuth` instance using the content URL for the site (`site_id`), and sign in to that site. See the [TableauAuth class](#tableauauth-class).
-REST API: [Delete Workbook](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#Delete_Workbook31){:target="_blank"}
+REST API: [Delete Workbook](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#delete_workbook1)
**Parameters**
@@ -3786,7 +3786,7 @@ workbooks.download(workbook_id, filepath=None, no_extract=False)
Downloads a workbook to the specified directory (optional).
-REST API: [Download Workbook](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#download_workbook){:target="_blank"}
+REST API: [Download Workbook](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#download_workbook)
**Parameters**
@@ -3837,7 +3837,7 @@ You must first call this method to populate views before you can iterate through
This method retrieves the view information for the specified workbook. The REST API is designed to return only the information you ask for explicitly. When you query for all the data sources, the view information is not included. Use this method to retrieve the views. The method adds the list of views to the workbook item (`workbook_item.views`). This is a list of `ViewItem`.
-REST API: [Query Views for Workbook](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_views_for_workbook){:target="_blank"}
+REST API: [Query Views for Workbook](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_views_for_workbook)
**Parameters**
@@ -3900,7 +3900,7 @@ connections.
This method retrieves the data source connection information for the specified workbook. The REST API is designed to return only the information you ask for explicitly. When you query all the workbooks, the data source connection information is not included. Use this method to retrieve the connection information for any data sources used by the workbook. The method adds the list of data connections to the workbook item (`workbook_item.connections`). This is a list of `ConnectionItem`.
-REST API: [Query Workbook Connections](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_workbook_connections){:target="_blank"}
+REST API: [Query Workbook Connections](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_workbook_connections)
**Parameters**
@@ -3962,7 +3962,7 @@ This method gets the preview image (thumbnail) for the specified workbook item.
The method uses the `view.id` and `workbook.id` to identify the preview image. The method populates the `workbook_item.preview_image`.
-REST API: [Query View Preview Image](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_workbook_preview_image){:target="_blank"}
+REST API: [Query View Preview Image](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_workbook_preview_image)
**Parameters**
@@ -4018,7 +4018,7 @@ Updates a workbook connection information (server address, server port, user nam
The workbook connections must be populated before the strings can be updated. See [workbooks.populate_connections](#workbooks.populate_connections)
-REST API: [Update Workbook Connection](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_workbook_connection){:target="_blank"}
+REST API: [Update Workbook Connection](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_workbook_connection)
**Parameters**
@@ -4064,7 +4064,7 @@ Populates the PDF content of the specified workbook.
This method populates a PDF with image(s) of the workbook view(s) you specify.
-REST API: [Download Workbook PDF](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_workbooksviews.htm#download_workbook_pdf){:target="_blank"}
+REST API: [Download Workbook PDF](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_workbooksviews.htm#download_workbook_pdf)
**Version**
diff --git a/docs/dev-guide.md b/docs/dev-guide.md
index 385222054..d3f402a77 100644
--- a/docs/dev-guide.md
+++ b/docs/dev-guide.md
@@ -12,12 +12,11 @@ This topic describes how to contribute to the Tableau Server Client (Python) pro
## Submit your first patch
-
This section will get you started with the basic workflow, describing how to create your own fork of the repository and how to open a pull request (PR) to add your contributions to the **development** branch.
### Get the source code and set up your branch
-1. Make sure you have [signed the CLA](http://tableau.github.io/#contributor-license-agreement-cla)
+1. Make sure you have [signed the CLA](https://tableau.github.io/contributing.html)
1. Fork the repository.
@@ -40,9 +39,11 @@ This section will get you started with the basic workflow, describing how to cre
It is recommended to use the format issue#-type-description (e.g. 13-fix-connection-bug) like so:
```shell
- git checkout -b 13-feature-new-stuff
+ git checkout -b 13-feature-new-stuff development
```
+ For documentation changes, see the documentation section below.
+
### Code and commit
Here's a quick checklist to follow when coding to ensure a good pull request (PR):
@@ -65,21 +66,20 @@ This section will get you started with the basic workflow, describing how to cre
Our documentation is written in markdown and built with Jekyll on GitHub Pages. All of the documentation source files can be found in `/docs` folder in the **gh-pages** branch. The docs are hosted on the following URL: [https://tableau.github.io/server-client-python](https://tableau.github.io/server-client-python)
- If you are just making documentation updates (adding new docs, fixing typos, improving wording) the easiest method is to use the built-in `Edit this file` feature right in GitHub (click the pencil icon). If you are viewing one of the pages on [https://tableau.github.io/server-client-python](https://tableau.github.io/server-client-python), clicking the **Edit this page** link at the top of the page will take you to the same place.
+ If you are just making documentation updates (adding new docs, fixing typos, improving wording) the easiest method is to use the built-in `Edit this file` feature right in GitHub (click the pencil icon). If you are viewing one of the pages on [https://tableau.github.io/server-client-python](https://tableau.github.io/server-client-python), clicking the **Edit this page** link at the top of the page will take you to the same place.
### Commit changes to your fork and open a PR
-1. Make a PR as described [here](https://help.github.com/articles/creating-a-pull-request-from-a-fork/) against the **development** branch for code changes, or against **gh-pages** for documentation updates.
+1. Make a PR as described [here](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork) against the **development** branch for code changes, or against **gh-pages** for documentation updates.
1. Wait for a review and address any feedback.
While we try and stay on top of all issues and PRs it might take a few days for someone to respond. Politely pinging
the PR after a few days with no response is OK, we'll try and respond with a timeline as soon as we are able.
-1. That's it! When the PR has received {:height="5%" width="5%"} (:rocket:'s) from members of the core team they will merge the PR
+1. That's it! When the PR has received {:height="5%" width="5%"} (:rocket:'s) from members of the core team they will merge the PR.
---
-
## Add new features
1. Create an endpoint class for the new feature, following the structure of the other endpoints. Each endpoint usually
diff --git a/docs/filter-sort.md b/docs/filter-sort.md
index f63e32f19..a7a0d458d 100644
--- a/docs/filter-sort.md
+++ b/docs/filter-sort.md
@@ -8,7 +8,6 @@ then pass the object to your endpoint as a parameter.
* TOC
{:toc}
-
## Available endpoints and fields
You can use the TSC library to filter and sort the following endpoints:
@@ -30,11 +29,11 @@ fields:
* UpdatedAt
**Important**: Not all of the fields are available for all endpoints. For more information, see the [REST
-API help](http://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_concepts_filtering_and_sorting.htm).
+API help](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_filtering_and_sorting.htm).
## Filtering
-To filter on a field, you need to specify the following criteria:
+To filter on a field, you need to specify the field name, an operator criteria and a value criteria.
### Operator criteria
@@ -68,7 +67,7 @@ print(matching_workbooks[0].owner_id)
## Sorting
-To sort on a field, you need to specify the direction in which you want to sort.
+To sort on a field, you need to specify the field name and the direction criteria for the sort order.
### Direction criteria
@@ -87,4 +86,3 @@ matching_workbooks, pagination_item = server.workbooks.get(req_option)
for wb in matching_workbooks:
print(wb.name)
```
-
diff --git a/docs/index.md b/docs/index.md
index aec722ade..4687be3be 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -83,6 +83,7 @@ with server.auth.sign_in(tableau_auth):
print("\nThere are {} datasources on site: ".format(pagination_item.total_available))
print([datasource.name for datasource in all_datasources])
```
+
> `SERVER_URL` is the URL of your Tableau server without subpaths. For local Tableau servers, an example would be: `https://www.MY_SERVER.com`. For Tableau Online, an example would be: `https://10ax.online.tableau.com/`.
->`SITENAME` is the subpath of your full site URL (also called `contentURL` in the REST API). `MYSITE` would be the site name of `https://10ax.online.tableau.com/MYSITE`. This parameter can be omitted when signing in to the Default site of a on premise Tableau server.
+> `SITENAME` is the subpath of your full site URL (also called `contentURL` in the REST API). `MYSITE` would be the site name of `https://10ax.online.tableau.com/MYSITE`. This parameter can be omitted when signing in to the Default site of a on premise Tableau server.
diff --git a/docs/page-through-results.md b/docs/page-through-results.md
index b01a1455b..284915cee 100644
--- a/docs/page-through-results.md
+++ b/docs/page-through-results.md
@@ -1,11 +1,11 @@
---
-title: Page through Results
+title: Page Through Results
layout: docs
---
Many of the calls that you make with the TSC library query for resources (like workbooks or data sources) on Tableau
-Server. Because the number of resources on Tableau Server can be very large, Tableau Server only returns the first 100
-resources by default. To get all of the resources on Tableau Server, you need to page through the results.
+Server. Because the number of resources can be very large, Tableau Server only returns the first 100
+resources by default. To get all of the resources, you need to page through the results.
* TOC
{:toc}
@@ -30,7 +30,7 @@ Server REST API when it runs out of resources--it does not make a call for each
### Set pagination options
-You can set pagination options in the request options and then pass the request options to the `Pager` function as a
+You can set pagination options in a `RequestOptions` object and then pass it to the `Pager` function as a
second optional parameter.
For example, to set the page size to 1000 use the following code:
diff --git a/docs/populate-connections-views.md b/docs/populate-connections-views.md
index 63e3fe8f4..71128c94d 100644
--- a/docs/populate-connections-views.md
+++ b/docs/populate-connections-views.md
@@ -8,7 +8,7 @@ views or connections that make up the workbook. Similarly, when you get a data s
information about the connections that make up the data source. This is a result of the design of the Tableau Server
REST API, which optimizes the size of responses by only returning what you ask for explicitly.
-As a result, if you want to get views and connections, you need to run the `populate_views` and `populate_connections`
+As a result, if you want to get views and connections, you need to call the `populate_views` and `populate_connections`
functions.
* TOC
diff --git a/docs/samples.md b/docs/samples.md
index eede1cb04..b9e9aae3d 100644
--- a/docs/samples.md
+++ b/docs/samples.md
@@ -32,47 +32,32 @@ publish.
The following list describes the samples available in the repository:
-* `create_group.py` Create a user group.
-
+* `add_default_permission.py` Adds workbook default permissions for a given project.
+* `create_group.py` Creates a user group.
* `create_project.py` Creates a project in a site.
-
-* `create_schedules.py` Create schedules for extract refreshes and subscriptions.
-
-* `download_view_image.py` Downloads an image of a specified view.
-
+* `create_schedules.py` Creates schedules for extract refreshes and subscriptions.
+* `download_view_image.py` Downloads an image of a specified view.
* `explore_datasource.py` Queries datasources, selects a datasource, populates connections for the datasource, then updates the datasource.
-
+* `explore_webhooks.py` Explores webhook functions supported by the Server API.
* `explore_workbook.py` Queries workbooks, selects a workbook, populates the connections and views for a workbook, then updates the workbook.
-
-* `export.py` Exports a view as an image, pdf, or csv.
-
-* `export_wb.py` Exports a pdf containing all views in a workbook.
-
-* `filter_sort_groups.py` Demonstrates selecting user groups as filters.
-
-* `initialize_server.py` Sets up an existing server instance with site, workbooks and datasources.
-
-* `kill_all_jobs.py` Kills all running jobs.
-
-* `list.py` Lists all datasources or workbooks of a site.
-
-* `move_workbook_projects.py` Updates the properties of a workbook to move the workbook from one project to another.
-
+* `export.py` Exports a view as an image, PDF, or CSV.
+* `export_wb.py` Exports a PDF containing all views in a workbook.
+* `filter_sort_groups.py` Demonstrates filtering and sorting user groups.
+* `filter_sort_projects.py` Demonstrates filtering and sorting projects.
+* `initialize_server.py` Sets up an existing server instance with site, workbooks and datasources.
+* `kill_all_jobs.py` Kills all running jobs.
+* `list.py` Lists all datasources or workbooks of a site.
+* `login.py` Demonstrates logging in to the server with either username/password or personal access token.
+* `move_workbook_projects.py` Moves a workbook from one project to another.
* `move_workbook_sites.py` Downloads a workbook, stores it in-memory, and uploads it to another site.
-
-* `pagination_sample.py` Use the Pager generator to iterate over all the items on the server.
-
-* `publish_workbook.py` Publishes a Tableau workbook.
-
+* `pagination_sample.py` Uses the Pager generator to iterate over all the items on the server.
+* `publish_datasource.py` Publishes a datasource to a server.
+* `publish_workbook.py` Publishes a workbook to a server.
+* `query_permissions.py` Queries permissions of a given resource.
* `refresh.py` Refreshes a datasource or workbook.
-
* `refresh_tasks.py` Lists and runs configured tasks on a server.
+* `set_http_options.py` Demonstrates HTTP options for the server and specifically for downloading workbooks.
+* `set_refresh_schedule.py` Sets the schedule to refresh a workbook or datasource.
+* `update_connection.py` Updates and embeds connection credentials of a datasource.
-* `set_http_options.py` Sets HTTP options for the server and specifically for downloading workbooks.
-
-* `set_refresh_schedule.py` Sets the schedule to refresh a datasource or workbook.
-
-* `update_connection.py` Updates and embeds connection credentials of a datasource.
-
-**Note**: For all of the samples, ensure that your Tableau Server user account has permission to access the resources.
-
+**Note**: For all of the samples, ensure that your Tableau Server user account has permission to access the resources. Also keep in mind that some example operations (like create group) are not allowed on Tableau Online.
diff --git a/docs/sign-in-out.md b/docs/sign-in-out.md
index a664a2cf4..d1bdc197f 100644
--- a/docs/sign-in-out.md
+++ b/docs/sign-in-out.md
@@ -3,12 +3,12 @@ title: Sign In and Out
layout: docs
---
-To sign in and out of Tableau Server, call the server's `.auth.signin` method in a`with` block.
+To sign in and out of Tableau Server, call the server's `.auth.signin` method in a `with` block.
```py
import tableauserverclient as TSC
-tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD', `SITENAME`)
+tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD', 'SITENAME')
# or for a personal access token
# tableau_auth = TSC.PersonalAccessTokenAuth('TOKEN_NAME', 'TOKEN_VALUE', 'SITENAME')
server = TSC.Server('https://SERVER_URL')
@@ -19,25 +19,25 @@ with server.auth.sign_in(tableau_auth):
`SERVER_URL` is the URL of your Tableau server without subpaths. For local Tableau servers, an example would be: `https://www.MY_SERVER.com`. For Tableau Online, an example would be: `https://10ax.online.tableau.com/`.
-`SITENAME` is the subpath of your full site URL (also called `contentURL` in the REST API). `MYSITE` would be the site name of `https://10ax.online.tableau.com/MYSITE`. This parameter can be omitted when signing in to the Default site of an in premise Tableau server.
+`SITENAME` is the subpath of your full site URL (also called `contentURL` in the REST API). `MYSITE` would be the site name of `https://10ax.online.tableau.com/MYSITE`. This parameter can be omitted when signing in to the Default site of an on-premise Tableau server.
-'TOKEN_NAME' and 'TOKEN_VALUE' are your Personal Access Token values, generated in your Account Settings.
+`TOKEN_NAME` and `TOKEN_VALUE` are your [Personal Access Token](https://help.tableau.com/current/server/en-us/security_personal_access_tokens.htm) values, generated in your Account Settings.
-Optionally, you can override the version of Tableau API you are authorizing against by adding `server.version = ''` before the `auth.signin` call.
+Optionally, you can override the version of Tableau API you are authorizing against by adding `server.version = ''` before the `auth.signin` call.
The TSC library signs you out of Tableau Server when you exit out of the `with` block.
- Note: When you sign in, the TSC library manages the authenticated session for you, however the validity of the underlying
+ **Note:** When you sign in, the TSC library manages the authenticated session for you, however the validity of the underlying
credentials token is limited by the maximum session length set on your Tableau Server (2 hours by default).
-An alternative to using a `with` block is to call the `Auth.sign_in` and `Auth.sign_out` functions explicitly.
+An alternative to using a `with` block is to call the `Auth.sign_in` and `Auth.sign_out` functions explicitly:
```py
import tableauserverclient as TSC
-tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD') # with no site name, this will try to log the user into the Default site
+tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD') # with no site name, this will use the Default site
server = TSC.Server('http://SERVER_URL')
server.auth.sign_in(tableau_auth)
diff --git a/docs/versions.md b/docs/versions.md
index aeab32836..70076aa6e 100644
--- a/docs/versions.md
+++ b/docs/versions.md
@@ -25,26 +25,33 @@ For example, the code might display version `2.3`.
## Use the REST API version supported by the server
-To always use the latest version of the REST API that is supported by the instance of Tableau Server you are connecting to, set the version using the `use_server_version()` method. You can do this when you create the server instance by specifying `use_server_version=True` as one of the arguments.
+There are two options for always using the the latest version of the REST API that is supported by the instance of Tableau Server you are connecting to.
+
+The first method is to specify `use_server_version=True` as one of the arguments, for example:
```py
import tableauserverclient as TSC
server = TSC.Server('http://SERVER_URL', use_server_version=True)
+```
+
+The second method is to create the server object first, then call the `use_server_version()` method on it. There are some situations where this method is needed. For instance, if you want to disable certificate checking, you have to do that after you create the server object, but before you make calls to the server (use_server_version makes a call to the server).
+```py
+import tableauserverclient as TSC
+server = TSC.Server('http://SERVER_URL')
+server.use_server_version()
```
## Use a specific version of the REST API
-To use another version of the REST API, set the version like so:
+To use a specific version of the REST API, set the version like so:
```py
import tableauserverclient as TSC
server = TSC.Server('http://SERVER_URL')
-
-
server.version = '2.6'
```
@@ -55,17 +62,18 @@ The current version of TSC only supports the following REST API and Tableau Serv
|REST API version|Tableau Server version|
|---|---|
-|2.3|10.0|
-|2.4|10.1|
-|2.5|10.2|
-|2.6|10.3|
-|2.7|10.4|
-|2.8|10.5|
-|3.0|2018.1|
-|3.1|2018.2|
-|3.2|2018.3|
-|3.3|2019.1|
-|3.4|2019.2|
-|3.5|2019.3|
-|3.6|2019.4|
+|3.8|2020.2|
|3.7|2020.1|
+|3.6|2019.4|
+|3.5|2019.3|
+|3.4|2019.2|
+|3.3|2019.1|
+|3.2|2018.3|
+|3.1|2018.2|
+|3.0|2018.1|
+|2.8|10.5|
+|2.7|10.4|
+|2.6|10.3|
+|2.5|10.2|
+|2.4|10.1|
+|2.3|10.0|