KNOWLEDGE BASE

Tableau Rest Api Fails To Download Workbooks Containing Colons In The Name


Published: 20 May 2021
Last Modified Date: 20 May 2021

Issue

When performing a Content Migration Tool migration of workbooks or utilizing the Tableau REST API to download workbooks, the download will fail if the workbook name contains a colon ":".

The following error will be presented from the CMT or API response:

CMT Error:

[ERR]: Failed to download workbook. Error downloading workbook WORKBOOK : NAME [Project: Default]
Server: https://TableauServer/
Site: default (Default)
User: tableau
Status Code: InternalServerError
Code: 500000
Summary: Internal Server Error
Detail: The server encountered an error and cannot complete your request. Contact your server administrator. [WORKBOOK : NAME [Project: Default]]
Tableau.PowerTools.Server.Interfaces.TableauServerException: Code: 500000
Summary: Internal Server Error
Detail: The server encountered an error and cannot complete your request. Contact your server administrator.
[ERR]: One or more errors occurred downloading workbooks for migration. Stopping migration.
[ERR]: Migration failed.


API Response:

<error code="500000">
    <summary>Internal Server Error</summary>
    <detail>The server encountered an error and cannot complete your request. Contact your server administrator.</detail>
</error>


Tableau Server Vizportal log:

ERROR com.tableausoftware.api.rest.util.RestApiControllerAdvice - Unhandled exception java.lang.IllegalArgumentException: NTFS ADS separator (':') in file name is forbidden.

Environment

  • Tableau Content Migration Tool
  • Tableau REST API
  • Tableau Server 2020.4.0 - 2020.1.2

Resolution

WORKAROUND

To workaround this issue, rename the workbook to remove the colon so that the API can download the workbook.

Cause

This is a known issue that is being addressed by Tableau development team.
 
Did this article resolve the issue?