diff --git a/docs/api-ref.md b/docs/api-ref.md index 98941cd96..dbbd33ebe 100644 --- a/docs/api-ref.md +++ b/docs/api-ref.md @@ -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** diff --git a/docs/versions.md b/docs/versions.md index 2ed8a8b3e..8351820fe 100644 --- a/docs/versions.md +++ b/docs/versions.md @@ -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: @@ -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|