Skip to content

Be more clear that always using the latest REST API version is recommended #859

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bcantoni merged 2 commits into from
Aug 24, 2021
Merged

Be more clear that always using the latest REST API version is recommended #859

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3270c20
Be more clear that always using the latest REST API version is recomm…
bcantoni Jul 1, 2021
a73a851
Add 2021.2 REST API version now that it is being released
bcantoni Aug 24, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/api-ref.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3202,6 +3202,7 @@ The possible user roles for the `site_role` attribute are the following:
* `ReadOnly`
* `Viewer`

Note: If any operations related to a user's `site_role` cause a 400 error response (for example: `Invalid site role: 'Explorer' is malformed or is not a supported user role in this version of Tableau`), ensure you are [using the latest REST API version for your server](versions#use-the-rest-api-version-supported-by-the-server).

**Example**

Expand Down
7 changes: 5 additions & 2 deletions docs/versions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,13 @@ server = TSC.Server('http://SERVER_URL')
print(server.version)
```

For example, the code might display version `2.3`.
For example, the code might display version `3.10`.

## Use the REST API version supported by the server

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. This could be necessary in cases where you're using an API feature that is only supported in a newer REST API version.
It's recommended to always use the latest REST API version supported by the server. This helps ensure you'll get the latest behaviors as documented here and in the Tableau REST API documentation.

There are two options for always using the the latest version 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:

Expand Down Expand Up @@ -64,6 +66,7 @@ The current version of TSC only supports the following REST API and Tableau Serv

|REST API version|Tableau Server version|
|---|---|
|3.12|2021.2|
|3.11|2021.1|
|3.10|2020.4|
|3.9|2020.3|
Expand Down