Server REST API version seems to default to 2.3 and does not let me create connections on a Workbook

[ramdesh]

Describe the bug
I have Tableau version 2020.3 installed which has REST API version 3.9. I am using TSC to automate uploading Workbooks to environments, and want to create a ConnectionItem object to go with the workbook. However, I get the error

/tableauserverclient/server/endpoint/endpoint.py:175: UserWarning: 'connections' not available in 2.3, it will be ignored. Added in 2.8
  warnings.warn(error)

and the request fails with a 500 Internal Server Error.

Versions
Details of your environment, including:

• Tableau version: 2020.3
• Python version: 3.8
• TSC library version: 0.15.0

To Reproduce
Here's my entire code:

import tableauserverclient as TSC
import os
import logging.config
import glob

USERNAME = ""
PASSWORD = ""
SERVER_URL = ""
PROJECT_NAME = ""
DB_USER = ""
DB_PWD = ""
DB_URL = ""
DB_PORT = ""

LOG_CONFIG = {
    "version": 1,
    "disable_existing_loggers": False,
    "formatters": {
        "simple": {
            "format": "[%(asctime)s] [%(levelname)s] [%(name)s] "
            "[%(module)s:%(lineno)d] %(message)s"
        },
    },
    "handlers": {
        "console": {
            "class": "logging.StreamHandler",
            "level": "DEBUG",
            "formatter": "simple",
            "stream": "ext://sys.stdout",
        }
    },
    "loggers": {
        "outcomes_reporting_deploy": {
            "level": os.getenv("LOG_LEVEL", "INFO"),
            "handlers": ["console"],
        }
    },
}
logging.config.dictConfig(LOG_CONFIG)
logger = logging.getLogger("outcomes_reporting_deploy")


tableau_auth = TSC.TableauAuth(USERNAME, PASSWORD)
server = TSC.Server(SERVER_URL)
server.version = "3.9"

with server.auth.sign_in(tableau_auth):
    logger.info("Signed in to Tableau server.")
    all_project_items, pagination_item = server.projects.get()
    all_projects = [{project.name: project.id} for project in all_project_items]
    if PROJECT_NAME and any(PROJECT_NAME in project for project in all_projects):
        wb_item = TSC.WorkbookItem(project_id=[project[PROJECT_NAME] for project in all_projects
                                               if PROJECT_NAME in project][0])
        workbooks_to_be_deployed = glob.glob('./*.twb*')
        if workbooks_to_be_deployed:
            connection_item = TSC.ConnectionItem()
            connection_item.server_address = DB_URL
            connection_item.server_port = DB_PORT
            connection_item.username = DB_USER
            connection_item.password = DB_PWD
            for workbook in workbooks_to_be_deployed:
                logger.info(f"Uploading workbook {workbook}")
                server.workbooks.publish(
                    wb_item,
                    workbook,
                    mode=TSC.Server.PublishMode.Overwrite,
                    # connection_credentials=TSC.ConnectionCredentials(
                    #     name=DB_USER,
                    #     password=DB_PWD,
                    #     embed=True
                    # ),
                    connections=[connection_item]
                )

        else:
            logger.info("No workbook(s) found to deploy. Exiting the process..")
    else:
        logger.error("No Project Name passed or unable to find a given project on the server")

**Results**

/tableauserverclient/server/endpoint/endpoint.py:175: UserWarning: 'connections' not available in 2.3, it will be ignored. Added in 2.8
warnings.warn(error)

Error status code: 500
b'

Internal Server Error

The server encountered an error and cannot complete your request. Contact your server administrator.'

**NOTE:** Be careful not to post user names, passwords, auth tokens or any other private or sensitive information.

[jacalata]

Strange, I ran your code and it worked for me. What do you get if you insert this right after logger.info("Signed in to Tableau Server:")

        s_info = server.server_info.get()
        print("\nServer info:")
        print("\tProduct version: {0}".format(s_info.product_version))
        print("\tREST API version: {0}".format(s_info.rest_api_version))
        print("\tBuild number: {0}".format(s_info.build_number))

[ramdesh]

Hi, this line actually made it work (I didn't have it earlier):

server.version = "3.9"

and also, instead of

connection_item.username = DB_USER
connection_item.password = DB_PWD

which was giving 500 Internal Server errors, I used

connection.connection_credentials = TSC.ConnectionCredentials(name=DB_USER, password=DB_PWD, embed=True)

However, now the code runs but nothing gets uploaded to the Tableau Server. What I'm trying to do is get a different db connection URL in there. If I don't use the connection param and use the connection_credentials param instead (the part that is commented out), it works, but I can't set a new URL for the db using that code.

[bcantoni]

Related to the question of raising the REST API version level, we have some proposals for making that more clear in PR #859

[ramdesh]

Closing, as setting version explicitly worked.