Help Desk

Submit a ticket My Tickets
Welcome
Login

Tableau Command Reference

BizApp for Tableau connectivity

Connections

Tableau

Tableau Connection

Inputs

Input Type Detail Notes
Username TextField The Username of the user.
Password TextField The password for the user.
Tableau URL TextField The URL of the Tableau instance to connect with.
Site Content URL Name TextField The Site Content URL name within your instance to connect to. The content URL name typically is the same as the name but with no spaces. (This case-sensitive)
Version DropdownField The API version that your instance uses. Tableau version(s) associated is in ()

Commands

Add User to Group

Adds a user to the specified group.

Inputs

Input Type Detail Notes
Site Content URL Name (Optional) TextField The site to use when running the command. (If empty this defaults to the Site configured in the connection)
Group ID TextField The ID of the group to add the user to.
User ID TextField The ID (not name) of the user to add.

Outputs

Output Output Type Notes
User Json
User ID String
User Name String
User Site Role String

Exit Codes

Code Type Detail
0 Success Success
1 Error Invalid Inputs
2 Error Could not authenticate with Tableau
214 Error The group name in the request body doesn't correspond to an existing group.
240 Warning The specified user is already a member of the group.

Add User to Site

Adds a user to Tableau Server and assigns the user to the specified site in the Connection.

Inputs

Input Type Detail Notes
Site Content URL Name (Optional) TextField The site to use when running the command. (If empty this defaults to the Site configured in the connection)
User Name TextField The name of the user. If the server uses local authentication, this can be any name. If you are using Active Directory authentication, or if you are using Tableau Online, there are specific requirements for the name. Tableau Server If Tableau Server uses Active Directory authentication, this must be the name of an existing user in Active Directory. If the user name is not unique across domains, you must include the domain as part of the user name (for example, example\Adam or adam@example.com).
Role DropdownField The site role to assign to the user. You can assign the following roles: Creator, Explorer, ExplorerCanPublish, ReadOnly, SiteAdministratorExplorer, SiteAdministratorCreator, Unlicensed, or Viewer.
Authentication Type DropdownField Optional) The new authentication type for the user. You can assign the following values for this attribute: SAML (the user signs in using SAML) or ServerDefault (the user signs in using the authentication method that's set for the server). These values appear in the Authentication tab on the Settings page in Tableau Online the SAML attribute value corresponds to Single sign-on, and the ServerDefault value corresponds to TableauID.

Outputs

Output Output Type Notes
User Json
User ID String
User Name String
User Site Role String

Exit Codes

Code Type Detail
0 Success Success
1 Error Invalid Inputs
2 Error Could not authenticate with Tableau
204 Error The server is configured to use Active Directory for authentication, and the username specified in the request body doesn't match an existing user in Active Directory.
229 Error The specified user already exists on the site.
234 Error The Tableau Server API doesn't allow adding a user with the guest role to a site.

Build Hyper Extract

Build a Hyper Extract from a CSV file.

Inputs

Input Type Detail Notes
Source CSV file FileField The file used to build the data in the Hyper file.
File format DropdownField The format of the CSV file.
Column Types TextField The Tableau column type for each column in the CSV file. Options are: (INTEGER, DOUBLE, BOOLEAN, DATE, DATETIME, DURATION, CHAR_STRING, UNICODE_STRING, SPATIAL)

Outputs

Output Output Type Notes
Hyper file File
Hyper file size Integer
Records processed Integer

Exit Codes

Code Type Detail
0 Success Success
1 Error Invalid inputs.
2 Error Failed to authenticate with Tableau
4 Error General error while creating the Extract
5 Error Could not find the CSV input file
6 Error The CSV is not properly formatted, or you may have specified the wrong format for the file.
11 Error The number of column types does not match the number of header columns in the CSV
12 Error One of the column types specified is not a valid type

Build TDE Extract

Build a TDE file from a CSV file.

Inputs

Input Type Detail Notes
Source CSV file FileField The file used to build the data in the TDE file.
File format DropdownField The format of the CSV file.
Column Types TextField The Tableau column type for each column in the CSV file. Options are: (INTEGER, DOUBLE, BOOLEAN, DATE, DATETIME, DURATION, CHAR_STRING, UNICODE_STRING, SPATIAL)

Outputs

Output Output Type Notes
TDE file File
TDE file size Integer
Records processed Integer

Exit Codes

Code Type Detail
0 Success Success
1 Error Invalid inputs.
2 Error Failed to authenticate with Tableau
4 Error General error while creating the TDE file
5 Error Could not find the CSV input file
6 Error The CSV is not properly formatted, or you may have specified the wrong format for the file.
11 Error The number of column types does not match the number of header columns in the CSV
12 Error One of the column types specified is not a valid type

Bulk Delete Default Permissions

Using a CSV file as datasource, bulk delete default permissions for Workbooks or Datasources for users or groups

Inputs

Input Type Detail Notes
Site Content URL Name (Optional) TextField The site to use when running the command. (If empty this defaults to the Site configured in the connection)
Source data FileField The source data for the bulk update. This must be an RFC-4180 compliant file that is comma separated.
User or Group DropdownField Specify if the source data is a list of Users or Groups
Resource type DropdownField The type of resource of which to set default permissions (Workbook or Datasource)
Project ID TextField The ID of the Project to update

Outputs

None

Exit Codes

Code Type Detail
0 Success Success
1 Success Invalid Inputs
2 Success Could not authenticate with Tableau
137 Error A user attempted to add permissions to a data source, but the caller doesn't have permission to set permissions on the data source.
204 Error The user specified in the request body doesn't correspond to an existing user.
214 Error The group specified in the request body doesn't correspond to an existing group.
215 Error A capability specified in the request body doesn't correspond to a defined capability. This can apply to either an invalid capability name or to a capability other than Allow or Deny for any mode value.

Bulk Delete Permissions

Using a CSV file as datasource, bulk delete permissions for a Datasource, Workbook or Project for multiple users or groups

Inputs

Input Type Detail Notes
Site Content URL Name (Optional) TextField The site to use when running the command. (If empty this defaults to the Site configured in the connection)
Source data FileField The source data for the bulk update. This must be an RFC-4180 compliant file that is comma separated.
User or Group DropdownField Specify if the source data is a list of Users or Groups
Resource type DropdownField The type of resource of which to set default permissions (Workbook, Datasource, or Project)
Resource ID TextField The ID of the Datasource, Workbook, or Project

Outputs

None

Exit Codes

Code Type Detail
0 Success Success
1 Success Invalid Inputs
2 Success Could not authenticate with Tableau
137 Error A user attempted to add permissions to a data source, but the caller doesn't have permission to set permissions on the data source.
204 Error The user specified in the request body doesn't correspond to an existing user.
214 Error The group specified in the request body doesn't correspond to an existing group.
215 Error A capability specified in the request body doesn't correspond to a defined capability. This can apply to either an invalid capability name or to a capability other than Allow or Deny for any mode value.
206 Error The specified data source doesn't correspond to an existing data source.
207 Error The project ID doesn't correspond to an existing project.
208 Error The workbook ID doesn't correspond to an existing workbook.

Bulk Update Default Permissions

Using a CSV file as datasource, bulk update default permissions for Workbooks or Datasources for users or groups

Inputs

Input Type Detail Notes
Site Content URL Name (Optional) TextField The site to use when running the command. (If empty this defaults to the Site configured in the connection)
Source data FileField The source data for the bulk update. This must be an RFC-4180 compliant file that is comma separated.
User or Group DropdownField Specify if the source data is a list of Users or Groups
Resource type DropdownField The type of resource of which to set default permissions (Workbook or Datasource)
Project ID TextField The ID of the Project to update

Outputs

Output Output Type Notes
Permissions Json

Exit Codes

Code Type Detail
0 Success Success
1 Success Invalid Inputs
2 Success Could not authenticate with Tableau
137 Error A user attempted to add permissions to a data source, but the caller doesn't have permission to set permissions on the data source.
204 Error The user specified in the request body doesn't correspond to an existing user.
214 Error The group specified in the request body doesn't correspond to an existing group.
215 Error A capability specified in the request body doesn't correspond to a defined capability. This can apply to either an invalid capability name or to a capability other than Allow or Deny for any mode value.

Bulk Update Permissions

Using a CSV file as datasource, bulk update permissions for a Datasource, Workbook or Project for multiple users or groups

Inputs

Input Type Detail Notes
Site Content URL Name (Optional) TextField The site to use when running the command. (If empty this defaults to the Site configured in the connection)
Source data FileField The source data for the bulk update. This must be an RFC-4180 compliant file that is comma separated.
User or Group DropdownField Specify if the source data is a list of Users or Groups
Resource type DropdownField The type of resource of which to set default permissions (Workbook, Datasource, or Project)
Resource ID TextField The ID of the Datasource, Workbook, or Project

Outputs

Output Output Type Notes
Permissions Json

Exit Codes

Code Type Detail
0 Success Success
1 Success Invalid Inputs
2 Success Could not authenticate with Tableau
137 Error A user attempted to add permissions to a data source, but the caller doesn't have permission to set permissions on the data source.
204 Error The user specified in the request body doesn't correspond to an existing user.
214 Error The group specified in the request body doesn't correspond to an existing group.
215 Error A capability specified in the request body doesn't correspond to a defined capability. This can apply to either an invalid capability name or to a capability other than Allow or Deny for any mode value.
206 Error The specified data source doesn't correspond to an existing data source.
207 Error The project ID doesn't correspond to an existing project.
208 Error The workbook ID doesn't correspond to an existing workbook.

Create Group

Create a Group in Tableau.

Inputs

Input Type Detail Notes
Site Content URL Name (Optional) TextField The site to use when running the command. (If empty this defaults to the Site configured in the connection)
Group Name TextField The name of the new Group

Outputs

Output Output Type Notes
Group Json
Group ID String

Exit Codes

Code Type Detail
0 Success Success
1 Error Invalid Inputs
2 Error Could not authenticate with Tableau
238 Warning A group with the specified name exists.

Create Project

Create a Project in Tableau.

Inputs

Input Type Detail Notes
Site Content URL Name (Optional) TextField The site to use when running the command. (If empty this defaults to the Site configured in the connection)
Project Name TextField The name of the Project.
Description TextField (Optional) A description for the project.
Parent Project ID TextField (Optional) The identifier of the parent project. Use this option to create project hierarchies.
Admin Mode DropdownField (Optional) Specify LockedToProject to lock permissions so that users cannot overwrite the default permissions set for the project, or specify ManagedByOwner to allow users to manage permissions for content that they own.
With Samples BooleanField (Optional) A Boolean value that specifies whether to publish the sample workbooks provided by Tableau to the project. When the publish-value is not specified in the request, or the publishSamples parameter is missing, no samples will be published. To publish the sample workbooks, set publishSamples parameter to true.

Outputs

Output Output Type Notes
Project Json
Project ID String

Exit Codes

Code Type Detail
0 Success Success
1 Error Invalid Inputs
2 Error Could not authenticate with Tableau
141 Error The samples could not be published because there is not enough storage space remaining on the server to accommodate the samples.
235 Error The project name in the request already belongs to the specified site. For the purpose of uniqueness checks, project names are case-insensitive.

Create Site

Create a Site in Tableau.

Inputs

Input Type Detail Notes
Site Name TextField The name of the site.
Content URL TextField The site URL. This value can contain only characters that are valid in a URL.
Admin Mode DropdownField (Optional) Specify ContentAndUsers to allow site administrators to use the server interface and tabcmd commands to add and remove users. (Specifying this option does not give site administrators permissions to manage users using the REST API.) Specify ContentOnly to prevent site administrators from adding or removing users. (Server administrators can always add or remove users.)
Enable Subscriptions BooleanField (Optional) Specify true to prevent users from being able to subscribe to workbooks on the specified site. The default is false.

Outputs

Output Output Type Notes
Site Json
Site ID String

Exit Codes

Code Type Detail
0 Success Success
1 Error Invalid Inputs
2 Error Could not authenticate with Tableau
50 Error The storage quota value was not a positive number.
50 Error The user quota value was not a positive number.
63 Error The user provided an administrator mode that is not ContentOnly or ContentAndUsers.
230 Error The site name in the request already belongs to an existing site.
231 Error The content URI in the request already belongs to an existing site.

Delete Datasource

Delete a Datasource from a Tableau site

Inputs

Input Type Detail Notes
Site Content URL Name (Optional) TextField The site to use when running the command. (If empty this defaults to the Site configured in the connection)
Datasource ID TextField The ID of the Datasource to delete

Outputs

None

Exit Codes

Code Type Detail
0 Success Success
1 Error Invalid inputs
2 Error Failed to authenticate with Tableau
213 Warning The Datasource was not found

Delete Group

Delete a group from a Tableau site

Inputs

Input Type Detail Notes
Site Content URL Name (Optional) TextField The site to use when running the command. (If empty this defaults to the Site configured in the connection)
Group ID TextField The ID of the group to delete

Outputs

None

Exit Codes

Code Type Detail
0 Success Success
1 Error Invalid inputs
2 Error Failed to authenticate with Tableau
214 Warning The group was not found

Delete Project

Delete a Project from a Tableau site

Inputs

Input Type Detail Notes
Site Content URL Name (Optional) TextField The site to use when running the command. (If empty this defaults to the Site configured in the connection)
Project ID TextField The ID of the Project to delete

Outputs

None

Exit Codes

Code Type Detail
0 Success Success
1 Error Invalid inputs
2 Error Failed to authenticate with Tableau
207 Warning The Project was not found

Delete Workbook

Delete a Workbook from a Tableau site

Inputs

Input Type Detail Notes
Site Content URL Name (Optional) TextField The site to use when running the command. (If empty this defaults to the Site configured in the connection)
Workbook ID TextField The ID of the Workbook to delete

Outputs

None

Exit Codes

Code Type Detail
0 Success Success
1 Error Invalid inputs
2 Error Failed to authenticate with Tableau
208 Warning The Workbook was not found

Download Datasource

Download a Datasource from Tableau

Inputs

Input Type Detail Notes
Site Content URL Name (Optional) TextField The site to use when running the command. (If empty this defaults to the Site configured in the connection)
Datasource ID TextField The ID of the Datasource.
Include Extract BooleanField Whether or not to include the Datasource's extract in the downloaded file.

Outputs

Output Output Type Notes
Datasource file File
File size Integer

Exit Codes

Code Type Detail
0 Success Success
1 Error Invalid inputs.
2 Error Failed to authenticate with Tableau
206 Error Could not find the specified Datasource

Download View Data

Returns a specified view rendered as data in comma-separated-value (CSV) format.

Inputs

Input Type Detail Notes
Site Content URL Name (Optional) TextField The site to use when running the command. (If empty this defaults to the Site configured in the connection)
View ID TextField The ID of the view to render as data.

Outputs

Output Output Type Notes
View Data File
File size Integer

Exit Codes

Code Type Detail
0 Success Success
1 Error Invalid inputs.
2 Error Failed to authenticate with Tableau
165 Error A non-administrator user attempted to query workbook views, but the caller doesn't have Read permission.

Download View Image

Returns an image of the specified view in a .png format.

Inputs

Input Type Detail Notes
Site Content URL Name (Optional) TextField The site to use when running the command. (If empty this defaults to the Site configured in the connection)
View ID TextField The ID of the view to render as data.

Outputs

Output Output Type Notes
View Image File
File size Integer

Exit Codes

Code Type Detail
0 Success Success
1 Error Invalid inputs.
2 Error Failed to authenticate with Tableau
201 Error The endpoint has been disabled on the server. To enable the endpoint, a server administrator must use tabadmin to configure the sheet_image.enabled setting. For more information, see tabadmin set options in the Tableau Server help.

Download View PDF

Returns a specified view rendered as a .pdf file.

Inputs

Input Type Detail Notes
Site Content URL Name (Optional) TextField The site to use when running the command. (If empty this defaults to the Site configured in the connection)
View ID TextField The ID of the view to render as a PDF.

Outputs

Output Output Type Notes
View PDF File
File size Integer

Exit Codes

Code Type Detail
0 Success Success
1 Error Invalid inputs.
2 Error Failed to authenticate with Tableau
165 Error A non-administrator user attempted to query workbook views, but the caller doesn't have Read permission.

Download Workbook

Download a Workbook from Tableau

Inputs

Input Type Detail Notes
Site Content URL Name (Optional) TextField The site to use when running the command. (If empty this defaults to the Site configured in the connection)
Workbook ID TextField The ID of the Workbook.
Include Extract BooleanField Whether or not to include the Workbook's extract in the downloaded file.

Outputs

Output Output Type Notes
Workbook file File
File size Integer

Exit Codes

Code Type Detail
0 Success Success
1 Error Invalid inputs.
2 Error Failed to authenticate with Tableau
208 Error Could not find the specified Workbook

Get Datasource

Get details of a Datasource

Inputs

Input Type Detail Notes
Site Content URL Name (Optional) TextField The site to use when running the command. (If empty this defaults to the Site configured in the connection)
Datasource ID TextField The ID of the Datasource

Outputs

Output Output Type Notes
Datasource Json
Datasource ID String
Datasource Name String

Exit Codes

Code Type Detail
0 Success Success
1 Error Invalid inputs
2 Error Failed to authenticate with Tableau
206 Error The data source ID in the URI doesn't correspond to an existing data source.

Get Datasource Connections

Get a list of the connections associated to a Datasource

Inputs

Input Type Detail Notes
Site Content URL Name (Optional) TextField The site to use when running the command. (If empty this defaults to the Site configured in the connection)
Datasource ID TextField The ID of the Datasource

Outputs

Output Output Type Notes
Connection list Json
Connection IDs Array
Connection Names Array

Exit Codes

Code Type Detail
0 Success Success
1 Error Invalid inputs
2 Error Failed to authenticate with Tableau
213 Error The data source ID in the URI doesn't correspond to an existing data source.

Get Datasources

Get a list of datasources the user has access to.

Inputs

Input Type Detail Notes
Site Content URL Name (Optional) TextField The site to use when running the command. (If empty this defaults to the Site configured in the connection)

Outputs

Output Output Type Notes
Datasources File
Datasource List (Deprecated) Json
Datasource Names (Deprecated) Array
Datasource IDs (Deprecated) Array

Exit Codes

Code Type Detail
0 Success Success
1 Error Invalid inputs.
2 Error Failed to authenticate with Tableau
10 Warning No datasources were found.
56 Error The page number parameter is not an integer, is less than one, or is greater than the final page number for data sources at the requested page size.
57 Error The page size parameter is not an integer, or is less than one.
147 Error The specified page size is larger than the maximum page size.

Get Groups

Get a list of Groups the user has access to.

Inputs

Input Type Detail Notes
Site Content URL Name (Optional) TextField The site to use when running the command. (If empty this defaults to the Site configured in the connection)

Outputs

Output Output Type Notes
Groups File
Group List (Deprecated) Json
Group Names (Deprecated) Array
Group IDs (Deprecated) Array

Exit Codes

Code Type Detail
0 Success Success
1 Error Invalid inputs.
2 Error Failed to authenticate with Tableau
10 Warning No Groups were found.
400006 Error The page number parameter is not an integer, is less than one, or is greater than the final page number for data sources at the requested page size.
400007 Error The page size parameter is not an integer, or is less than one.
403014 Error The specified page size is larger than the maximum page size.

Get Projects

Get a list of projects the user has access to.

Inputs

Input Type Detail Notes
Site Content URL Name (Optional) TextField The site to use when running the command. (If empty this defaults to the Site configured in the connection)

Outputs

Output Output Type Notes
Projects File
Project List (Deprecated) Json
Project Names (Deprecated) Array
Project IDs (Deprecated) Array

Exit Codes

Code Type Detail
0 Success Success
1 Error Invalid inputs.
2 Error Failed to authenticate with Tableau
10 Warning No projects were found.
56 Error The page number parameter is not an integer, is less than one, or is greater than the final page number for data sources at the requested page size.
57 Error The page size parameter is not an integer, or is less than one.
147 Error The specified page size is larger than the maximum page size.

Get Server Info

Get information about your Tableau server

Inputs

None

Outputs

Output Output Type Notes
REST API Version String
Product Build String

Exit Codes

Code Type Detail
0 Success Success
1 Error Invalid inputs
2 Error Failed to authenticate with Tableau

Get Site Info

Get a list of the users that are in a Group

Inputs

Input Type Detail Notes
Site Content URL Name (Optional) TextField The site to use when running the command. (If empty this defaults to the Site configured in the connection)
Site ID TextField The ID of the Site
Site Name TextField The name of the Site (This will be used if Site ID is not set)
Content URL TextField The content-url of the Site (This will be used if ID and Name are not set)

Outputs

Output Output Type Notes
Site Json
Site ID String
Site Name String

Exit Codes

Code Type Detail
0 Success Success
1 Error Invalid inputs
2 Error Failed to authenticate with Tableau
202 Error The specified site doesn't correspond to an existing site.

Get Sites

Get a list of sites the user has access to.

Inputs

None

Outputs

Output Output Type Notes
Sites File
Site List (Deprecated) Json
Site Names (Deprecated) Array
Site IDs (Deprecated) Array

Exit Codes

Code Type Detail
0 Success Success
1 Error Invalid inputs.
2 Error Failed to authenticate with Tableau
10 Warning No sites were found.
56 Error The page number parameter is not an integer, is less than one, or is greater than the final page number for data sources at the requested page size.
57 Error The page size parameter is not an integer, or is less than one.
147 Error The specified page size is larger than the maximum page size.

Get User

Get user information in a site.

Inputs

Input Type Detail Notes
Site Content URL Name (Optional) TextField The site to use when running the command. (If empty this defaults to the Site configured in the connection)
User ID TextField The ID of the User

Outputs

Output Output Type Notes
User Json
User ID String
User Name String

Exit Codes

Code Type Detail
0 Success Success
1 Error Invalid inputs
2 Error Failed to authenticate with Tableau
204 Error The user ID in the URI doesn't correspond to an existing user.

Get Users in Group

Get a list of the users that are in a Group

Inputs

Input Type Detail Notes
Site Content URL Name (Optional) TextField The site to use when running the command. (If empty this defaults to the Site configured in the connection)
Group ID TextField The ID of the Group

Outputs

Output Output Type Notes
User list Json
User IDs Array
User Names Array

Exit Codes

Code Type Detail
0 Success Success
1 Error Invalid inputs
2 Error Failed to authenticate with Tableau
56 Error The page number parameter is not an integer, is less than one, or is greater than the final page number for data sources at the requested page size.
57 Error The page size parameter is not an integer, or is less than one.
147 Error The specified page size is larger than the maximum page size.
214 Error The group ID in the URI doesn't correspond to an existing group.

Get Users in Site

Get a list of the users that are in an entire Site

Inputs

Input Type Detail Notes
Site Content URL Name (Optional) TextField The site to use when running the command. (If empty this defaults to the Site configured in the connection)

Outputs

Output Output Type Notes
User list Json
User IDs Array
User Names Array

Exit Codes

Code Type Detail
0 Success Success
1 Error Invalid inputs
2 Error Failed to authenticate with Tableau
56 Error The page number parameter is not an integer, is less than one, or is greater than the final page number for data sources at the requested page size.
57 Error The page size parameter is not an integer, or is less than one.
147 Error The specified page size is larger than the maximum page size.

Get Views by Site

Returns all the views for the specified workbook, optionally including usage statistics.

Inputs

Input Type Detail Notes
Site Content URL Name (Optional) TextField The site to use when running the command. (If empty this defaults to the Site configured in the connection)
Include usage BooleanField true to return usage statistics. The default is false.

Outputs

Output Output Type Notes
Views File
View List (Deprecated) Json
View Names (Deprecated) Array
View IDs (Deprecated) Array

Exit Codes

Code Type Detail
0 Success Success
1 Error Invalid inputs.
2 Error Failed to authenticate with Tableau
137 Error A non-administrator user attempted to query workbook views, but the caller doesn't have Read permission.

Get Views by Workbook

Returns all the views for the specified workbook, optionally including usage statistics.

Inputs

Input Type Detail Notes
Site Content URL Name (Optional) TextField The site to use when running the command. (If empty this defaults to the Site configured in the connection)
Workbook ID TextField The ID of the workbook to get the views for.
Include usage BooleanField true to return usage statistics. The default is false.

Outputs

Output Output Type Notes
Views File
View List (Deprecated) Json
View Names (Deprecated) Array
View IDs (Deprecated) Array

Exit Codes

Code Type Detail
0 Success Success
1 Error Invalid inputs.
2 Error Failed to authenticate with Tableau
137 Error A non-administrator user attempted to query workbook views, but the caller doesn't have Read permission.
208 Error The workbook ID in the URI doesn't correspond to an existing workbook.

Get Workbook

Get details of a Workbook

Inputs

Input Type Detail Notes
Site Content URL Name (Optional) TextField The site to use when running the command. (If empty this defaults to the Site configured in the connection)
Workbook ID TextField The ID of the Workbook

Outputs

Output Output Type Notes
Workbook Json
Workbook ID String
Workbook Name String
Project ID String

Exit Codes

Code Type Detail
0 Success Success
1 Error Invalid inputs
2 Error Failed to authenticate with Tableau
208 Error The workbook ID in the URI doesn't correspond to an existing workbook.

Get Workbooks

Get a list of workbooks the user has access to.

Inputs

Input Type Detail Notes
Site Content URL Name (Optional) TextField The site to use when running the command. (If empty this defaults to the Site configured in the connection)

Outputs

Output Output Type Notes
Workbooks File
Workbooks (Deprecated) Json
Workbook Names (Deprecated) Array
Workbook IDs (Deprecated) Array
Workbook Project IDs (Deprecated) Array

Exit Codes

Code Type Detail
0 Success Success
1 Error Invalid inputs.
2 Error Failed to authenticate with Tableau
10 Warning No workbooks were found.
56 Error The page number parameter is not an integer, is less than one, or is greater than the final page number for data sources at the requested page size.
57 Error The page size parameter is not an integer, or is less than one.
147 Error The specified page size is larger than the maximum page size.

Publish Datasource

Publish a Datasource file to your Tableau Server

Inputs

Input Type Detail Notes
Site Content URL Name (Optional) TextField The site to use when running the command. (If empty this defaults to the Site configured in the connection)
Datasource FileField The Datasource to publish
Datasource Type DropdownField The type of Datasource (hyper, tds, tdsx, or tde)
Datasource Name TextField The name of the Datasource on the Tableau Server
Project ID TextField The ID of the Project to publish this Datasource to.
Overwrite BooleanField Overwrite an existing Datasource with the same name if it exists.

Outputs

Output Output Type Notes
Datasource ID String
Datasource Name String
Project ID String

Exit Codes

Code Type Detail
0 Success Success
1 Error Invalid inputs
2 Error Failed to authenticate with Tableau
149 Error A non-administrator user attempted to initiate a file upload, but the caller doesn't have publishing rights on the site.
140 Error A non-administrator user attempted to initiate a file upload, but the caller doesn't have publishing rights on the site.
149 Error The file could not be uploaded for some other reason than those specified earlier.
5 Error The Datasource file was not found.

Publish Workbook

Publish a Workbook file to your Tableau Server

Inputs

Input Type Detail Notes
Site Content URL Name (Optional) TextField The site to use when running the command. (If empty this defaults to the Site configured in the connection)
Workbook FileField The Workbook to publish
Workbook Type DropdownField The type of Workbook (twbx or twb)
Workbook Name TextField The name of the Workbook on the Tableau Server
Project ID TextField The ID of the Project to publish this Datasource to.
Overwrite BooleanField Overwrite an existing Datasource with the same name if it exists.

Outputs

Output Output Type Notes
Workbook ID String
Workbook Name String
Project ID String

Exit Codes

Code Type Detail
0 Success Success
1 Error Invalid inputs
2 Error Failed to authenticate with Tableau
149 Error A non-administrator user attempted to initiate a file upload, but the caller doesn't have publishing rights on the site.
140 Error A non-administrator user attempted to initiate a file upload, but the caller doesn't have publishing rights on the site.
149 Error The file could not be uploaded for some other reason than those specified earlier.
5 Error The Workbook file was not found.

Remove Datasource Permissions

Remove a permission for a Group or User on a Datasource

Inputs

Input Type Detail Notes
Site Content URL Name (Optional) TextField The site to use when running the command. (If empty this defaults to the Site configured in the connection)
Datasource ID TextField The ID of the Datasource to update
ID Type (Group or User) DropdownField Choose to update permissions associated to a Group or User
ID TextField The ID of the Group or User to update permissions on
Capability Name DropdownField The name of the capability to add
Mode DropdownField Allow or Deny the capability

Outputs

None

Exit Codes

Code Type Detail
0 Success Success
1 Success Invalid Inputs
2 Success Could not authenticate with Tableau
137 Error A user attempted to add permissions to a data source, but the caller doesn't have permission to set permissions on the data source.
204 Error The user specified in the request body doesn't correspond to an existing user.
206 Error The specified data source doesn't correspond to an existing data source.
214 Error The group specified in the request body doesn't correspond to an existing group.
215 Error The capability is not assigned to the specified user or group with the specified mode (Allow or Deny).

Remove Default Datasource Permissions

Remove a default permission for Datasources for a Project

Inputs

Input Type Detail Notes
Site Content URL Name (Optional) TextField The site to use when running the command. (If empty this defaults to the Site configured in the connection)
Project ID TextField The ID of the Project to update
ID Type (Group or User) DropdownField Choose to update default permissions associated to a Group or User
ID TextField The ID of the Group or User to update permissions on
Capability Name DropdownField The name of the capability to add
Mode DropdownField Allow or Deny the capability

Outputs

None

Exit Codes

Code Type Detail
0 Success Success
1 Success Invalid Inputs
2 Success Could not authenticate with Tableau
137 Error A user attempted to add permissions to a data source, but the caller doesn't have permission to set permissions on the data source.
204 Error The user specified in the request body doesn't correspond to an existing user.
206 Error The specified data source doesn't correspond to an existing data source.
214 Error The group specified in the request body doesn't correspond to an existing group.
215 Error The capability is not assigned to the specified user or group with the specified mode (Allow or Deny).

Remove Default Workbook Permissions

Remove a default permission for Workbooks for a Project

Inputs

Input Type Detail Notes
Site Content URL Name (Optional) TextField The site to use when running the command. (If empty this defaults to the Site configured in the connection)
Project ID TextField The ID of the Project to update
ID Type (Group or User) DropdownField Choose to update default permissions associated to a Group or User
ID TextField The ID of the Group or User to update permissions on
Capability Name DropdownField The name of the capability to add
Mode DropdownField Allow or Deny the capability

Outputs

None

Exit Codes

Code Type Detail
0 Success Success
1 Success Invalid Inputs
2 Success Could not authenticate with Tableau
137 Error A user attempted to add permissions to a data source, but the caller doesn't have permission to set permissions on the data source.
204 Error The user specified in the request body doesn't correspond to an existing user.
214 Error The group specified in the request body doesn't correspond to an existing group.
215 Error The capability is not assigned to the specified user or group with the specified mode (Allow or Deny).

Remove Project Permission

Remove a permission for a Group or User on a Project

Inputs

Input Type Detail Notes
Site Content URL Name (Optional) TextField The site to use when running the command. (If empty this defaults to the Site configured in the connection)
Project ID TextField The ID of the Project to update
ID Type (Group or User) DropdownField Choose to update permissions associated to a Group or User
ID TextField The ID of the Group or User to update permissions on
Capability Name DropdownField The name of the capability to add
Mode DropdownField Allow or Deny the capability

Outputs

None

Exit Codes

Code Type Detail
0 Success Success
1 Success Invalid Inputs
2 Success Could not authenticate with Tableau
137 Error A user attempted to add permissions to a project, but the caller doesn't have permission to set permissions on the project.
204 Error The user specified in the request body doesn't correspond to an existing user.
207 Error The project ID doesn't correspond to an existing project.
214 Error The group specified in the request body doesn't correspond to an existing group.
215 Error The capability is not assigned to the specified user or group with the specified mode (Allow or Deny).

Remove User from Group

Removes a user from the specified group.

Inputs

Input Type Detail Notes
Site Content URL Name (Optional) TextField The site to use when running the command. (If empty this defaults to the Site configured in the connection)
Group ID TextField The ID of the group to remove the user from.
User Id TextField The ID of the user to remove.

Outputs

None

Exit Codes

Code Type Detail
0 Success Success
1 Error Invalid inputs
2 Error Failed to authenticate with Tableau
82 Error A problem arose that prevented the user from being removed from the site.
204 Error The user name in the URI doesn't correspond to an existing user.
214 Error The group name in the URI doesn't correspond to an existing group.
224 Warning The user is not a member of the group specified.

Remove User from Site

Removes a user from the specified site. If a user still owns content (assets) on Tableau Server, the user cannot be deleted unless the ownership is reassigned first. If a user is removed from all sites that the user is a member of, the user is deleted.

Inputs

Input Type Detail Notes
Site Content URL Name (Optional) TextField The site to use when running the command. (If empty this defaults to the Site configured in the connection)
User ID TextField The ID of the user to remove.

Outputs

None

Exit Codes

Code Type Detail
0 Success Success
1 Error Invalid inputs
2 Error Failed to authenticate with Tableau
50 Error Some other problem arose that prevented the user from being removed from the site.
204 Error The user ID in the URI doesn't correspond to an existing user.
232 Error The specified user still owns content on Tableau Server and cannot be deleted.

Remove Workbook Permissions

Remove the permissions for a User or Group on a Workbook

Inputs

Input Type Detail Notes
Site Content URL Name (Optional) TextField The site to use when running the command. (If empty this defaults to the Site configured in the connection)
Workbook ID TextField The ID of the Workbook to update
ID Type (Group or User) DropdownField Choose to update default permissions associated to a Group or User
ID TextField The ID of the Group or User to update permissions on
Capability Name DropdownField The name of the capability to add
Mode DropdownField Allow or Deny the capability

Outputs

None

Exit Codes

Code Type Detail
0 Success Success
1 Success Invalid Inputs
2 Success Could not authenticate with Tableau
137 Error A user attempted to add permissions to a workbook, but the caller doesn't have permission to set permissions on the workbook.
204 Error The user specified in the request body doesn't correspond to an existing user.
214 Error The group specified in the request body doesn't correspond to an existing group.
215 Error The capability is not assigned to the specified user or group with the specified mode (Allow or Deny).
208 Error The workbook ID doesn't correspond to an existing workbook.

Show Datasource Permissions

Show all permissions assigned to a Datasource

Inputs

Input Type Detail Notes
Site Content URL Name (Optional) TextField The site to use when running the command. (If empty this defaults to the Site configured in the connection)
Datasource ID TextField The ID of the Datasource to update

Outputs

Output Output Type Notes
Permissions File
Permission list (Deprecated) Json

Exit Codes

Code Type Detail
0 Success Success
1 Success Invalid Inputs
2 Success Could not authenticate with Tableau
206 Error The specified data source doesn't correspond to an existing data source.

Show Default Permissions

Show all default permissions assigned to Datasources or Workbooks

Inputs

Input Type Detail Notes
Site Content URL Name (Optional) TextField The site to use when running the command. (If empty this defaults to the Site configured in the connection)
Project ID TextField The ID of the Project
Resource Type DropdownField The resource type (Workbook or Datasource) of which to show permissions

Outputs

Output Output Type Notes
Permissions File
Permissions (Deprecated) Json

Exit Codes

Code Type Detail
0 Success Success
1 Success Invalid Inputs
2 Success Could not authenticate with Tableau
207 Error The specified Project ID doesn't correspond to an existing Project.

Show Project Permissions

Show all permissions assigned to a Project

Inputs

Input Type Detail Notes
Site Content URL Name (Optional) TextField The site to use when running the command. (If empty this defaults to the Site configured in the connection)
Project ID TextField The ID of the Project

Outputs

Output Output Type Notes
Permissions File
Permission list (Deprecated) Json

Exit Codes

Code Type Detail
0 Success Success
1 Success Invalid Inputs
2 Success Could not authenticate with Tableau
207 Error The specified Project ID doesn't correspond to an existing Project

Show Workbook Permissions

Show all permissions assigned to a Workbook

Inputs

Input Type Detail Notes
Site Content URL Name (Optional) TextField The site to use when running the command. (If empty this defaults to the Site configured in the connection)
Workbook ID TextField The ID of the Workbook

Outputs

Output Output Type Notes
Permissions File
Permission list (Deprecated) Json

Exit Codes

Code Type Detail
0 Success Success
1 Success Invalid Inputs
2 Success Could not authenticate with Tableau
208 Error The specified Workbook ID doesn't correspond to an existing Project

Update Datasource

Update the Project, Owner, or Certification of a Datasource

Inputs

Input Type Detail Notes
Site Content URL Name (Optional) TextField The site to use when running the command. (If empty this defaults to the Site configured in the connection)
Datasource ID TextField The ID of the Datasource to update
Project ID TextField (Optional) The ID of a project to add the data source to.
Owner ID TextField (Optional) The ID of a user to assign the data source to as owner.
Certified BooleanField (Optional) A Boolean value that indicates whether the data source is certified.
Certification Note TextField (Optional) A note that provides more information on the certification of the data source, if applicable.

Outputs

Output Output Type Notes
Updated Datasource Json
Datasource ID String

Exit Codes

Code Type Detail
0 Success Success
1 Success Invalid Inputs
2 Success Could not authenticate with Tableau
160 Error A non-administrator user tried to change the owner for the data source.
163 Error A non-administrator user tried to change the project for the data source, but the caller doesn't have Write permission for the project.
165 Error A non-administrator user tried to update a data source, but the caller doesn't have Write permission.
204 Error The owner ID in the request body doesn't correspond to an existing owner.
206 Error The data source ID in the URI doesn't correspond to an existing data source.
207 Error The project ID in the request body doesn't correspond to an existing project.
244 Error The data source name in the request already belongs to the specified site. For the purpose of uniqueness checks, data source names are case-insensitive.

Update Datasource Permissions

Update a permission for a Group or User on a Datasource

Inputs

Input Type Detail Notes
Site Content URL Name (Optional) TextField The site to use when running the command. (If empty this defaults to the Site configured in the connection)
Datasource ID TextField The ID of the Datasource to update
ID Type (Group or User) DropdownField Choose to update permissions associated to a Group or User
ID TextField The ID of the Group or User to update permissions on
Capability Name DropdownField The name of the capability to add
Mode DropdownField Allow or Deny the capability

Outputs

Output Output Type Notes
Permissions Json

Exit Codes

Code Type Detail
0 Success Success
1 Success Invalid Inputs
2 Success Could not authenticate with Tableau
137 Error A user attempted to add permissions to a data source, but the caller doesn't have permission to set permissions on the data source.
204 Error The user specified in the request body doesn't correspond to an existing user.
206 Error The specified data source doesn't correspond to an existing data source.
214 Error The group specified in the request body doesn't correspond to an existing group.
215 Error A capability specified in the request body doesn't correspond to a defined capability. This can apply to either an invalid capability name or to a capability other than Allow or Deny for any mode value.

Update Default Datasource Permissions

Update the default permissions for Datasources for a Project

Inputs

Input Type Detail Notes
Site Content URL Name (Optional) TextField The site to use when running the command. (If empty this defaults to the Site configured in the connection)
Project ID TextField The ID of the Project to update
ID Type (Group or User) DropdownField Choose to update default permissions associated to a Group or User
ID TextField The ID of the Group or User to update permissions on
Capability Name DropdownField The name of the capability to add
Mode DropdownField Allow or Deny the capability

Outputs

Output Output Type Notes
Permissions Json

Exit Codes

Code Type Detail
0 Success Success
1 Success Invalid Inputs
2 Success Could not authenticate with Tableau
137 Error A user attempted to add permissions to a data source, but the caller doesn't have permission to set permissions on the data source.
204 Error The user specified in the request body doesn't correspond to an existing user.
206 Error The specified data source doesn't correspond to an existing data source.
214 Error The group specified in the request body doesn't correspond to an existing group.
215 Error A capability specified in the request body doesn't correspond to a defined capability. This can apply to either an invalid capability name or to a capability other than Allow or Deny for any mode value.

Update Default Workbook Permissions

Update the default permissions for Workbooks for a Project

Inputs

Input Type Detail Notes
Site Content URL Name (Optional) TextField The site to use when running the command. (If empty this defaults to the Site configured in the connection)
Project ID TextField The ID of the Project to update
ID Type (Group or User) DropdownField Choose to update default permissions associated to a Group or User
ID TextField The ID of the Group or User to update permissions on
Capability Name DropdownField The name of the capability to add
Mode DropdownField Allow or Deny the capability

Outputs

Output Output Type Notes
Permissions Json

Exit Codes

Code Type Detail
0 Success Success
1 Success Invalid Inputs
2 Success Could not authenticate with Tableau
137 Error A user attempted to add permissions to a data source, but the caller doesn't have permission to set permissions on the data source.
204 Error The user specified in the request body doesn't correspond to an existing user.
214 Error The group specified in the request body doesn't correspond to an existing group.
215 Error A capability specified in the request body doesn't correspond to a defined capability. This can apply to either an invalid capability name or to a capability other than Allow or Deny for any mode value.

Update Group

Update the name of a Group

Inputs

Input Type Detail Notes
Site Content URL Name (Optional) TextField The site to use when running the command. (If empty this defaults to the Site configured in the connection)
Group ID TextField The ID of the Group to update
Name TextField (Optional) The new name for the project.

Outputs

Output Output Type Notes
Updated Group Json
Group ID String

Exit Codes

Code Type Detail
0 Success Success
1 Success Invalid Inputs
2 Success Could not authenticate with Tableau
214 Error The group ID in the URI doesn't correspond to an existing site.
238 Error The group name in the request is already in use in the specified site. For the purpose of uniqueness checks, group names are case-insensitive.
207 Error The project ID in the URI doesn't correspond to an existing project.
235 Error The project name in the request already belongs to the specified site. For the purpose of uniqueness checks, project names are case-insensitive.

Update Hyper Extract

Add additional data to a Hyper extract from a CSV file.

Inputs

Input Type Detail Notes
Tableau Extract FileField The Extract file to update with new data.
Source CSV file FileField The file used to build the data in the Hyper file.
File format DropdownField The format of the CSV file.
Column Types TextField The Tableau column type for each column in the CSV file. Options are: (INTEGER, DOUBLE, BOOLEAN, DATE, DATETIME, DURATION, CHAR_STRING, UNICODE_STRING, SPATIAL)

Outputs

Output Output Type Notes
Extract file File
Extract size (bytes) Integer
Records processed Integer

Exit Codes

Code Type Detail
0 Success Success
1 Error Invalid inputs.
2 Error Failed to authenticate with Tableau
4 Error General error while creating the Hyper extract
5 Error Could not find the CSV input file
6 Error The CSV is not properly formatted, or you may have specified the wrong format for the file.
11 Error The number of column types does not match the number of header columns in the CSV
12 Error One of the column types specified is not a valid type

Update Project

Update the Parent Project, Name, Permissions, or Description of a Project

Inputs

Input Type Detail Notes
Site Content URL Name (Optional) TextField The site to use when running the command. (If empty this defaults to the Site configured in the connection)
Project ID TextField The ID of the Datasource to update
Parent Project ID TextField (Optional) The identifier of the parent project. Use this option to create project hierarchies.
Name TextField (Optional) The new name for the project.
Content Permissions DropdownField (Optional) The new permissions setting for the project. Specify LockedToProject to lock permissions so that users cannot overwrite the default permissions set for the project, or specify ManagedByOwner to allow users to manage permissions for content that they own.
Description TextField (Optional) The new description for the project.

Outputs

Output Output Type Notes
Updated Project Json
Project ID String

Exit Codes

Code Type Detail
0 Success Success
1 Success Invalid Inputs
2 Success Could not authenticate with Tableau
138 Error Attempt to rename the default project, which cannot be renamed.
141 Error The samples could not be published because there is not enough storage space remaining on the server to accommodate the samples.
207 Error The project ID in the URI doesn't correspond to an existing project.
235 Error The project name in the request already belongs to the specified site. For the purpose of uniqueness checks, project names are case-insensitive.

Update Project Permissions

Update a permission for a Group or User on a Project

Inputs

Input Type Detail Notes
Site Content URL Name (Optional) TextField The site to use when running the command. (If empty this defaults to the Site configured in the connection)
Project ID TextField The ID of the Project to update
ID Type (Group or User) DropdownField Choose to update permissions associated to a Group or User
ID TextField The ID of the Group or User to update permissions on
Capability Name DropdownField The name of the capability to add
Mode DropdownField Allow or Deny the capability

Outputs

Output Output Type Notes
Permissions Json

Exit Codes

Code Type Detail
0 Success Success
1 Success Invalid Inputs
2 Success Could not authenticate with Tableau
137 Error A user attempted to add permissions to a project, but the caller doesn't have permission to set permissions on the project.
204 Error The user specified in the request body doesn't correspond to an existing user.
207 Error The project ID doesn't correspond to an existing project.
214 Error The group specified in the request body doesn't correspond to an existing group.
215 Error A capability specified in the request body doesn't correspond to a defined capability. This can apply to either an invalid capability name or to a capability other than Allow or Deny for any mode value.

Update TDE Extract

Add additional data to a TDE file from a CSV file.

Inputs

Input Type Detail Notes
Tableau Extract FileField The Extract file to update with new data.
Source CSV file FileField The file used to build the data in the TDE file.
File format DropdownField The format of the CSV file.
Column Types TextField The Tableau column type for each column in the CSV file. Options are: (INTEGER, DOUBLE, BOOLEAN, DATE, DATETIME, DURATION, CHAR_STRING, UNICODE_STRING, SPATIAL)

Outputs

Output Output Type Notes
Extract file File
Extract size (bytes) Integer
Records processed Integer

Exit Codes

Code Type Detail
0 Success Success
1 Error Invalid inputs.
2 Error Failed to authenticate with Tableau
4 Error General error while creating the TDE file
5 Error Could not find the CSV input file
6 Error The CSV is not properly formatted, or you may have specified the wrong format for the file.
11 Error The number of column types does not match the number of header columns in the CSV
12 Error One of the column types specified is not a valid type

Update Workbook

Update the Project, Owner, or Show tabs setting of a Workbook

Inputs

Input Type Detail Notes
Site Content URL Name (Optional) TextField The site to use when running the command. (If empty this defaults to the Site configured in the connection)
Workbook ID TextField The ID of the Workbook to update
Project ID TextField (Optional) The ID of a project to assign the workbook to.
Owner ID TextField (Optional) The ID of a user to assign the workbook to as owner.
Show tabs BooleanField (Optional) Specify true to have the published workbook show views in tabs; otherwise, false. The default is false.

Outputs

Output Output Type Notes
Updated Workbook Json
Workbook ID String

Exit Codes

Code Type Detail
0 Success Success
1 Success Invalid Inputs
2 Success Could not authenticate with Tableau
160 Error A non-administrator user tried to change the workbook owner.
158 Error A non-administrator user tried to change the workbook project, but the caller doesn't have Write permission for the target project.
160 Error A non-administrator user tried to change the workbook, but the caller doesn't have Write permission for the workbook.
204 Error The owner ID in the request body doesn't correspond to an existing owner.
208 Error The workbook ID in the URI doesn't correspond to an existing workbook.
207 Error The project ID in the request body doesn't correspond to an existing project.
244 Error The data source name in the request already belongs to the specified site. For the purpose of uniqueness checks, data source names are case-insensitive.

Update Workbook Permissions

Update the permissions for a User or Group on a Workbook

Inputs

Input Type Detail Notes
Site Content URL Name (Optional) TextField The site to use when running the command. (If empty this defaults to the Site configured in the connection)
Workbook ID TextField The ID of the Workbook to update
ID Type (Group or User) DropdownField Choose to update default permissions associated to a Group or User
ID TextField The ID of the Group or User to update permissions on
Capability Name DropdownField The name of the capability to add
Mode DropdownField Allow or Deny the capability

Outputs

Output Output Type Notes
Permissions Json

Exit Codes

Code Type Detail
0 Success Success
1 Success Invalid Inputs
2 Success Could not authenticate with Tableau
137 Error A user attempted to add permissions to a workbook, but the caller doesn't have permission to set permissions on the workbook.
204 Error The user specified in the request body doesn't correspond to an existing user.
214 Error The group specified in the request body doesn't correspond to an existing group.
215 Error A capability specified in the request body doesn't correspond to a defined capability. This can apply to either an invalid capability name or to a capability other than Allow or Deny for any mode value.
208 Error The workbook ID doesn't correspond to an existing workbook.
B
Brian is the author of this solution article.

Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.