To interact with Tableau® as part of a chain, add a step that includes a Tableau connection command. For example:
- Automate and connect Tableau with a range of data sources, including Anaplan®, Oracle® HFM, and IBM Cognos® Planning Analytics Cloud (TM1)
- Dynamically refresh reports, both legacy and new, with integrated end-user access management and support for both cloud and on-premise editions of Tableau
To enable these commands, an IT admin first creates a Tableau connector. The connection interacts with on-premise and cloud deployments of these versions of Tableau:
- 8.3
- 9.x
- 10.x
- 2018.x
- 2019.x
- 2020.x
- Tableau Online®
Add user to group
To add a user to a specified group, use an Add User to Group command.
Properties
| Property |
Detail |
| Group ID |
Enter the ID of the group to add the user to |
| User ID |
Enter the ID — not the name — of the user to add |
Outputs
| Output |
Output type |
| 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 |
Couldn't 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
To add a user to Tableau Server and assign them to a specified site, use an Add User to Site command.
Properties
| Property |
Detail |
| Username |
Enter the name of the user. If the Tableau server uses local authentication, you can use any name; if Active Directory (AD) authentication, use the name of an existing user in AD. If the username isn't unique across domains, include the domain, such as domain\Adam or adam@domain.com. |
| Role |
Select the site role to assign to the user: Creator, Explorer, ExplorerCanPublish, ReadOnly, SiteAdministratorExplorer, SiteAdministratorCreator, Unlicensed, or Viewer |
| Authentication type |
Select whether to authenticate the user via Security Assertion Markup Language (SAML) or ServerDefault.
Note: In Tableau Online, these values appear in the Authentication tab on the Settings page—SAML corresponds to Single Sign-on (SSO); ServerDefault to TableauID.
|
Outputs
| Output |
Output type |
| 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 |
Couldn't authenticate with Tableau |
| 204 |
Error |
The server is configured to use Active Directory authentication, and the username specified in the request body doesn't match a user in AD |
| 229 |
Error |
The specified user already exists on the site |
| 234 |
Error |
The Tabeleau Server API doesn't allow adding a user with the guest role to a site |
Build Hyper Extract
To build a Hyper Extract from a comma-separated values (CSV) file, use a Build Hyper Extract command.
Note: To use this command with a GroundRunner, install the Tableau Extract API on its server, and move its dynamic-link library (DLL) files to a folder used by the registry, such as C:\Windows\System32.
Properties
| Property |
Detail |
| Source CSV file |
Enter the file used to build the data in the Hyper file. |
| File format |
Select the format of the CSV file. |
| Column types |
Enter the Tableau column type for each column in the CSV file: INTEGER, DOUBLE, BOOLEAN, DATE, DATETIME, DURATION, CHAR_STRING, UNICODE_STRING, or SPATIAL. |
Outputs
| Output |
Output type |
| Hyper file |
File |
| Hyper file size |
Integer |
| Records processed |
Integer |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid inputs |
| 2 |
Error |
Couldn't authenticate with Tableau |
| 4 |
Error |
General error while creating Extact |
| 5 |
Error |
Couldn't find CSV input file |
| 6 |
Error |
CSV file isn't properly formatted, or the wrong file format is specified |
| 11 |
Error |
The number of column types doesn't match the number of header columns in the CSV |
| 12 |
Error |
Invalid column type |
Build TDE extract
To build a Tableau Desktop (TDE) file from a CSV file, use a Build TDE Extract command.
Note: To use this command with a GroundRunner, install the Tableau Extract API on its server, and move its DLL files to a folder used by the registry, such as C:\Windows\System32.
Properties
| Property |
Detail |
| Source CSV file |
Enter the file used to build the data in the TDE file. |
| File format |
Select the format of the CSV file. |
| Column types |
Enter the Tableau column type for each column in the CSV file: INTEGER, DOUBLE, BOOLEAN, DATE, DATETIME, DURATION, CHAR_STRING, UNICODE_STRING, or SPATIAL. |
Outputs
| Output |
Output type |
| TDE file |
File |
| TDE file size |
Integer |
| Records processed |
Integer |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid inputs |
| 2 |
Error |
Couldn't authenticate with Tableau |
| 4 |
Error |
General error while creating Extact |
| 5 |
Error |
Couldn't find CSV input file |
| 6 |
Error |
CSV file isn't properly formatted, or the wrong file format is specified |
| 11 |
Error |
The number of column types doesn't match the number of header columns in the CSV |
| 12 |
Error |
Invalid column type |
Bulk delete default permissions
To delete the default permissions for users' or groups' Workbooks or Datasources given a CSV file as a datasource, use a Bulk Delete Default Permissions command.
Properties
| Property |
Detail |
| Source data |
Enter the source data for the bulk update, as an RFC-4180-compliant CSV file. |
| User or group |
Select whether the source data is a list of Users or Groups. |
| Resource type |
Select the type of resource to set the default permissions of: Workbook or Datasource. |
| Project ID |
Enter the ID of the project to update. |
Outputs
None
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid inputs |
| 2 |
Error |
Couldn't authenticate with Tableau |
| 137 |
Error |
User attempted to add permissions to a data source, but the caller doesn't have rights to set permissions on the data source |
| 204 |
Error |
User specified in the request body doesn't correspond to an existing user |
| 214 |
Error |
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 a capability other than Allow or Deny for any mode value. |
Bulk delete permissions
To delete the permissions for multiple users' or groups' Datasource, Workbook, or Project given a CSV file as a datasource, use a Bulk Delete Permissions command.
Properties
| Property |
Detail |
| Source data |
Enter the source data for the bulk update, as an RFC-4180-compliant CSV file. |
| User or group |
Select whether the source data is a list of Users or Groups. |
| Resource type |
Select the type of resource to set the default permissions of—Workbook, Datasource, or Project. |
| Project ID |
Enter the ID of the datasource, workbook, or project to update. |
Outputs
None
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid inputs |
| 2 |
Error |
Couldn't authenticate with Tableau |
| 137 |
Error |
User attempted to add permissions to a data source, but the caller doesn't have rights to set permissions on the data source |
| 204 |
Error |
User specified in the request body doesn't correspond to an existing user |
| 206 |
Error |
Datasource ID doesn't correspond to an existing datasource |
| 207 |
Error |
Project ID doesn't correspond to an existing project |
| 208 |
Error |
Workbook ID doesn't correspond to an existing workbook |
| 214 |
Error |
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 a capability other than Allow or Deny for any mode value. |
Bulk update default permissions
To update the default permissions for users' or groups' Workbooks or Datasources given a CSV file as a datasource, use a Bulk Update Default Permissions command.
Properties
| Property |
Detail |
| Source data |
Enter the source data for the bulk update, as an RFC-4180-compliant CSV file. |
| User or group |
Select whether the source data is a list of Users or Groups. |
| Resource type |
Select the type of resource to set the default permissions of: Workbook or Datasource. |
| Project ID |
Enter the ID of the project to update. |
Outputs
None
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid inputs |
| 2 |
Error |
Couldn't authenticate with Tableau |
| 137 |
Error |
User attempted to add permissions to a data source, but the caller doesn't have rights to set permissions on the data source |
| 204 |
Error |
User specified in the request body doesn't correspond to an existing user |
| 214 |
Error |
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 a capability other than Allow or Deny for any mode value. |
Bulk update permissions
To update the permissions for multiple users' or groups' Datasource, Workbook, or Project given a CSV file as a datasource, use a Bulk Update Permissions command.
Properties
| Property |
Detail |
| Source data |
Enter the source data for the bulk update, as an RFC-4180-compliant CSV file. |
| User or group |
Select whether the source data is a list of Users or Groups. |
| Resource type |
Select the type of resource to set the default permissions of—Workbook, Datasource, or Project |
| Project ID |
Enter the ID of the datasource, workbook, or project to update. |
Outputs
None
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid inputs |
| 2 |
Error |
Couldn't authenticate with Tableau |
| 137 |
Error |
User attempted to add permissions to a data source, but the caller doesn't have rights to set permissions on the data source |
| 204 |
Error |
User specified in the request body doesn't correspond to an existing user |
| 206 |
Error |
Datasource ID doesn't correspond to an existing datasource |
| 207 |
Error |
Project ID doesn't correspond to an existing project |
| 208 |
Error |
Workbook ID doesn't correspond to an existing workbook |
| 214 |
Error |
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 a capability other than Allow or Deny for any mode value. |
Create group
To create a group in Tableau, use a Create Group command.
Properties
| Property |
Detail |
| Group name |
Enter the name of the new group. |
Outputs
| Output |
Output type |
| Group |
JSON |
| Group ID |
String |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid inputs |
| 2 |
Error |
Couldn't authenticate with Tableau |
| 238 |
Warning |
A group with the specified name already exists |
Create project
To create a project in Tableau, use a Create Project command.
Properties
| Property |
Detail |
| Project name |
Enter the name of the new project. |
| Description |
Enter a description of the new project (optional). |
| Parent project ID |
To create project hierarchies, enter the identifier of the parent project (optional). |
| Admin mode |
Select the level of permission management for users.
- To lock permissions so users can't overwrite the default permissions set for the project, select LockedToProject.
- To enable users to manage permissions for content they own, select ManagedByOwner.
|
| With samples |
To publish the sample workbooks provided by Tableau to the project, check this box. |
Outputs
| Output |
Output type |
| Project |
JSON |
| Project ID |
String |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid inputs |
| 2 |
Error |
Couldn't authenticate with Tableau |
| 141 |
Error |
Samples couldn't be published because not enough storage space remains on the server |
| 235 |
Error |
The project name in the request already belongs to the specified site. To ensure uniqueness, project names are case-insensitive. |
Create site
To create a site in Tableau, use a Create Site command.
Properties
| Property |
Detail |
| Site name |
Enter the name of the new site. |
| Content URL |
Enter the site's URL, with only characters that are valid in a URL. |
| Admin mode |
Select the level of site access for administrators (optional):
- To enable site administrators to use the server interface and TABCMD commands — but not the REST API — to add and remove users, select ContentAndUsers.
- To prevent site admministrators from adding or removing users, select ContentOnly.
Note: Server administrators can always add or remove users.
|
| Enable subscriptions |
To prevent users from subscribing to workbooks on the site, check this box. |
Outputs
| Output |
Output Type |
| Site |
JSON |
| Site ID |
String |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid inputs |
| 2 |
Error |
Couldn't authenticate with Tableau |
| 50 |
Error |
The storage or user quota value wasn't a positive number |
| 63 |
Error |
The user provided an administrator mode that's 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
To delete a Datasource from a Tableau site, use a Delete Datasource command.
Properties
| Property |
Detail |
| Datasource ID |
Enter the ID of the datasource to delete. |
Outputs
None
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid inputs |
| 2 |
Error |
Couldn't authenticate with Tableau |
| 213 |
Warning |
The datasource wasn't found |
Delete group
To delete a group from a Tableau site, use a Delete Group command.
Properties
| Property |
Detail |
| Group ID |
Enter the ID of the group to delete. |
Outputs
None
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid inputs |
| 2 |
Error |
Couldn't authenticate with Tableau |
| 214 |
Warning |
The group wasn't found |
Delete project
To delete a project from a Tableau site, use a Delete Project command.
Properties
| Property |
Detail |
| Project ID |
Enter the ID of the project to delete. |
Outputs
None
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid inputs |
| 2 |
Error |
Couldn't authenticate with Tableau |
| 207 |
Warning |
The project wasn't found |
Delete workbook
To delete a workbook from a Tableau site, use a Delete Workbook command.
Properties
| Property |
Detail |
| Workbook ID |
Enter the ID of the workbook to delete. |
Outputs
None
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid inputs |
| 2 |
Error |
Couldn't authenticate with Tableau |
| 208 |
Warning |
The workbook wasn't found |
Download datasource
To download a datasource from Tableau, use a Download Datasource command.
Properties
| Property |
Detail |
| Datasource ID |
Enter the ID of the datasource to download. |
| Include extract |
To include the datasource's extract in the downloaded file, check this box. |
Outputs
| Output |
Output type |
| Datasource file |
File |
| File size |
Integer |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid inputs |
| 2 |
Error |
Couldn't authenticate with Tableau |
| 206 |
Error |
The datasource wasn't found |
Download view data
To return a specified view rendered as data in a CSV format, use a Download View Data command.
Properties
| Property |
Detail |
| View ID |
Enter the ID of the view to render as data. |
Outputs
| Output |
Output type |
| File size |
Integer |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid inputs |
| 2 |
Error |
Couldn't 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
To return an image of the specified view rendered in a PNG format, use a Download View Image command.
Properties
| Property |
Detail |
| View ID |
Enter the ID of the view to render as an image. |
Outputs
| Output |
Output type |
| View image |
File |
| File size |
Integer |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid inputs |
| 2 |
Error |
Couldn't 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. |
Download view PDF
To return the specified view rendered in a Portable Document Format (PDF) file, use a Download View PDF command.
Properties
| Property |
Detail |
| View ID |
Enter the ID of the view to render as a PDF. |
Outputs
| Output |
Output type |
| View PDF |
File |
| File size |
Integer |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid inputs |
| 2 |
Error |
Couldn't authenticate with Tableau |
| 165 |
Error |
A non-administrator user attempted to query workbook views, but the caller doesn't have Read permission |
Download workbook
To download a Workbook from Tableau, use a Download Workbook command.
Properties
| Property |
Detail |
| Workbook ID |
Enter the ID of the workbook to download |
| Include extract |
To include the Workbook's extract in the downloaded file, check this box |
Outputs
| Output |
Output type |
| Workbook file |
File |
| File size |
Integer |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid inputs |
| 2 |
Error |
Couldn't authenticate with Tableau |
| 208 |
Error |
Couldn't find the specified workbook |
Get datasource
To retrieve details of a Datasource, use a Get Datasource command.
Properties
| Property |
Detail |
| Datasource ID |
Enter the ID of the datasource to retrieve details about |
Outputs
| Output |
Output type |
| Datasource |
JSON |
| Datasource ID |
String |
| Datasource name |
String |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid inputs |
| 2 |
Error |
Couldn't authenticate with Tableau |
| 206 |
Error |
The datasource ID in the URI doesn't correspond to an existing data source |
Get datasource connections
To retrieve a list of connections associated with a Datasource, use a Get Datasource Connections command.
Properties
| Property |
Detail |
| Datasource ID |
Enter the ID of the datasource to retrieve connections of. |
Outputs
| Output |
Output type |
| Connection list |
JSON |
| Connection IDs |
Array |
| Connection names |
Array |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid inputs |
| 2 |
Error |
Couldn't authenticate with Tableau |
| 213 |
Error |
The datasource ID in the URI doesn't correspond to an existing data source |
Get datasources
To retrieve a list of datasources the connector's integration user can access, use a Get Datasources command.
Properties
None
Outputs
| Output |
Output type |
| Datasource list |
JSON |
| Datasource IDs |
Array |
| Datasource names |
Array |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid inputs |
| 2 |
Error |
Couldn't authenticate with Tableau |
| 10 |
Warning |
No datasources found |
| 56 |
Error |
The page number parameter isn't an integer, is less than 1, or is greater than the final page number for datasources at the requested page size |
| 57 |
Error |
The page number size isn't an integer, or is less than 1 |
| 147 |
Error |
The specified page size is larger than the maximum page size |
Get groups
To retrieves a list of Groups the connector's integration user can access, use a Get Groups command.
Properties
None
Outputs
| Output |
Output type |
| Group list |
JSON |
| Group IDs |
Array |
| Group names |
Array |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid inputs |
| 2 |
Error |
Couldn't authenticate with Tableau |
| 10 |
Warning |
No datasources found |
| 56 |
Error |
The page number parameter isn't an integer, is less than 1, or is greater than the final page number for datasources at the requested page size |
| 57 |
Error |
The page size parameter isn't an integer, or is less than 1 |
| 147 |
Error |
The specified page size is larger than the maximum page size |
Get projects
To retrieve a list of projects the connector's integration user can access, use a Get Projects command.
Properties
None
Outputs
| Output |
Output type |
| Project list |
JSON |
| Project IDs |
Array |
| Project names |
Array |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid inputs |
| 2 |
Error |
Couldn't authenticate with Tableau |
| 10 |
Warning |
No datasources found |
| 56 |
Error |
The page number parameter isn't an integer, is less than 1, or is greater than the final page number for datasources at the requested page size |
| 57 |
Error |
The page size parameter isn't an integer, or is less than 1 |
| 147 |
Error |
The specified page size is larger than the maximum page size |
Get server info
To retrieve the API version and product build of your Tableau server, use a Get Server Info command.
Properties
None
Outputs
| Output |
Output type |
| REST API version |
String |
| Product build |
String |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid inputs |
| 2 |
Error |
Couldn't authenticate with Tableau |
Get site info
To retrieve information about a site, use a Get Site Info command.
Properties
| Property |
Detail |
| Site ID |
Enter the ID of the site to retrieve information about. |
| Site name |
If no Site ID, enter the name of the site to retrieve information about. |
| Content URL |
If no Site ID or Site Name, enter the URL of the site to retrieve information about. |
Outputs
| Output |
Output type |
| Site |
JSON |
| Site ID |
String |
| Site name |
String |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid inputs |
| 2 |
Error |
Couldn't authenticate with Tableau |
| 202 |
Error |
The specified site doesn't correspond to an existing site |
Get sites
To retrieve a list of sites the connector's integration user can access, use a Get Sites command.
Properties
None
Outputs
| Output |
Output type |
| Site list |
JSON |
| Site IDs |
Array |
| Site names |
Array |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid inputs |
| 2 |
Error |
Couldn't authenticate with Tableau |
| 10 |
Warning |
No sites found |
| 56 |
Error |
The page number parameter isn't an integer, is less than 1, or is greater than the final page number for datasources at the requested page size |
| 57 |
Error |
The page size parameter isn't an integer, or is less than 1 |
| 147 |
Error |
The specified page size is larger than the maximum page size |
Get user
To retrieve information about a Tableau user given its ID, use a Get User command.
Properties
| Property |
Detail |
| User ID |
Enter the ID of the user to retrieve information about. |
Outputs
| Output |
Output type |
| User |
JSON |
| User ID |
String |
| Username |
String |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid inputs |
| 2 |
Error |
Couldn't authenticate with Tableau |
| 204 |
Error |
The user ID in the URI doesn't correspond to an existing user |
Get users in group
To retrieve a list of users in a group, use a Get Users in Group command.
Properties
| Property |
Detail |
| Group ID |
Enter the ID of the group to retrieve users of. |
Outputs
| Output |
Output type |
| User list |
JSON |
| User IDs |
Array |
| Usernames |
Array |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid inputs |
| 2 |
Error |
Couldn't authenticate with Tableau |
| 56 |
Error |
The page number parameter isn't an integer, is less than 1, or is greater than the final page number for datasources at the requested page size |
| 57 |
Error |
The page size parameter isn't an integer, or is less than 1 |
| 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
To retrieve a list of users in an entire site, use a Get Users in Site command.
Properties
None
Outputs
| Output |
Output type |
| User list |
JSON |
| User IDs |
Array |
| Usernames |
Array |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid inputs |
| 2 |
Error |
Couldn't authenticate with Tableau |
| 56 |
Error |
The page number parameter isn't an integer, is less than 1, or is greater than the final page number for datasources at the requested page size |
| 57 |
Error |
The page size parameter isn't an integer, or is less than 1 |
| 147 |
Error |
The specified page size is larger than the maximum page size |
Get views by site
To retrieve all views and optional usage statistics for an entire site, use a Get Views by Site command.
Properties
| Property |
Detail |
| Include usage |
To return usage statistics, check this box. |
Outputs
| Output |
Output type |
| View list |
JSON |
| View IDs |
Array |
| View names |
Array |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid inputs |
| 2 |
Error |
Couldn't 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
To return all views and optional usage statistics for the specified workbook, use a Get Views by Workbook command.
Properties
| Property |
Detail |
| Workbook ID |
Enter the ID of the workbook to get views for. |
| Include usage |
To return usage statistics, check this box. |
Outputs
| Output |
Output type |
| View list |
JSON |
| View IDs |
Array |
| View names |
Array |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid inputs |
| 2 |
Error |
Couldn't 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
To retrieve details of a workbook, use a Get Workbook command.
Properties
| Property |
Detail |
| Workbook ID |
Enter the ID of the workbook to get details of. |
Outputs
| Output |
Output type |
| 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 |
Couldn't authenticate with Tableau |
| 208 |
Error |
The workbook ID in the URI doesn't correspond to an existing workbook |
Get workbooks
To retrieve a list of workbooks the connector's integration user can access, use a Get Workbooks command.
Properties
None
Outputs
| Output |
Output type |
| Workbook list |
JSON |
| Workbook IDs |
Array |
| Workbook names |
Array |
| Workbook project ID |
Array |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid inputs |
| 2 |
Error |
Couldn't authenticate with Tableau |
| 10 |
Warning |
No workbooks found |
| 56 |
Error |
The page number parameter isn't an integer, is less than 1, or is greater than the final page number for datasources at the requested page size |
| 57 |
Error |
The page size parameter isn't an integer, or is less than 1 |
| 147 |
Error |
The specified page size is larger than the maximum page size |
Publish datasource
To publish a Datasource file to your Tableau Server, use a Publish Datasource command.
Properties
| Property |
Detail |
| Datasource |
Enter the datasource to publish. |
| Datasource type |
Select the type of datasource to publish—Hyper, TDS, TDSX, or TDE. |
| Datasource name |
Enter the name of datasource on the Tableau Server. |
| Project ID |
Enter the ID of project to publish the datasource to. |
| Overwrite |
To overwrite an existing datasource with the same name if it exists, check this box. |
Outputs
| Output |
Output type |
| Datasource ID |
String |
| Datasource name |
String |
| Project ID |
String |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid inputs |
| 2 |
Error |
Couldn't authenticate with Tableau |
| 5 |
Error |
The datasource file wasn't found |
| 140 |
Error |
A non-administrator user attempted to intiate a file upload, but the caller doesn't have publishing rights on the site |
| 149 |
Error |
The file couldn't be uploaded for some other reason |
Publish workbook
To publish a Workbook file to your Tableau Server, use a Publish Workbook command.
Properties
| Property |
Detail |
| Workbook |
Enter the workbook to publish. |
| Workbook type |
Select whether the workbook type is TWBX or TWB. |
| Workbook name |
Enter the name of workbook on the Tableau Server. |
| Project ID |
Enter the ID of project to publish the workbook to. |
| Overwrite |
To overwrite an existing workbook with the same name if it exists, check this box. |
Outputs
| Output |
Output type |
| Workbook ID |
String |
| Workbook name |
String |
| Project ID |
String |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid inputs |
| 2 |
Error |
Couldn't authenticate with Tableau |
| 5 |
Error |
The workbook file wasn't found |
| 140 |
Error |
A non-administrator user attempted to intiate a file upload, but the caller doesn't have publishing rights on the site |
| 149 |
Error |
The file couldn't be uploaded for some other reason |
Remove datasource permissions
To remove a permission for a Group or User on a Datasource, use a Remove Datasource Permissions command.
Properties
| Property |
Detail |
| Datasource ID |
Enter the ID of the datasource to update. |
| ID Type (User or Group) |
Select whether to update permissions associated with a User or Group. |
| ID |
Enter the ID of user or group to update permissions for. |
| Capability name |
Select the name of the capability to add. |
| Mode |
Select whether to Allow or Deny the capability. |
Outputs
None
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid inputs |
| 2 |
Error |
Couldn't authenticate with Tableau |
| 137 |
Error |
A user attempted to add permissions to a datasource, but the caller doesn't have rights to do so |
| 204 |
Error |
The specified user doesn't correspond to an existing user |
| 206 |
Error |
The specified datasouce doesn't correspond to an existing datasource |
| 214 |
Error |
The specified group doesn't correspond to an existing group |
| 215 |
Error |
The capability isn't assigned to the specified user or group with the specified mode |
Remove default datasource permissions
To remove the default permission for a project's Datasources, use a Remove Default Datasource Permissions command.
Properties
| Property |
Detail |
| Project ID |
Enter the ID of the project to update. |
| ID type (user or group) |
Select whether to update permissions associated with a User or Group. |
| ID |
Enter the ID of user or group to update permissions for. |
| Capability name |
Select the name of the capability to add. |
| Mode |
Select whether to Allow or Deny the capability. |
Outputs
None
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid inputs |
| 2 |
Error |
Couldn't authenticate with Tableau |
| 137 |
Error |
A user attempted to add permissions to a datasource, but the caller doesn't have rights to do so |
| 204 |
Error |
The specified user doesn't correspond to an existing user |
| 206 |
Error |
The specified datasouce doesn't correspond to an existing datasource |
| 214 |
Error |
The specified group doesn't correspond to an existing group |
| 215 |
Error |
The capability isn't assigned to the specified user or group with the specified mode |
Remove default workbook permissions
To remove the default permission for a project's Workbooks, use a Remove Default Workbook Permissions command.
Properties
| Property |
Detail |
| Project ID |
Enter the ID of the project to update. |
| ID type (user or group) |
Select whether to update permissions associated with a User or Group. |
| ID |
Enter the ID of user or group to update permissions for. |
| Capability name |
Select the name of the capability to add. |
| Mode |
Select whether to Allow or Deny the capability. |
Outputs
None
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid inputs |
| 2 |
Error |
Couldn't authenticate with Tableau |
| 137 |
Error |
A user attempted to add permissions to a datasource, but the caller doesn't have rights to do so |
| 204 |
Error |
The specified user doesn't correspond to an existing user |
| 206 |
Error |
The specified datasouce doesn't correspond to an existing datasource |
| 214 |
Error |
The specified group doesn't correspond to an existing group |
| 215 |
Error |
The capability isn't assigned to the specified user or group with the specified mode |
Remove project permission
To remove a permission for a Group or User on a Project, use a Remove Project Permission command.
Properties
| Property |
Detail |
| Project ID |
Enter the ID of the project to update. |
| ID type (user or group) |
Select whether to update permissions associated with a User or Group. |
| ID |
Enter the ID of user or group to update permissions for. |
| Capability name |
Select the name of the capability to add. |
| Mode |
Select whether to Allow or Deny the capability. |
Outputs
None
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid inputs |
| 2 |
Error |
Couldn't authenticate with Tableau |
| 137 |
Error |
A user attempted to add permissions to a datasource, but the caller doesn't have rights to do so |
| 204 |
Error |
The specified user doesn't correspond to an existing user |
| 206 |
Error |
The specified datasouce doesn't correspond to an existing datasource |
| 214 |
Error |
The specified group doesn't correspond to an existing group |
| 215 |
Error |
The capability isn't assigned to the specified user or group with the specified mode |
Remove user From group
To remove a user from the specified group, use a Remove User From Group command.
Properties
| Property |
Detail |
| Group ID |
Enter the ID of the group to remove the user from. |
| User ID |
Enter the ID of the user to remove from the group. |
Outputs
None
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid inputs |
| 2 |
Error |
Couldn't authenticate with Tableau |
| 82 |
Error |
A problem arose that prevented the user from being removed from the site |
| 204 |
Error |
The specified user doesn't correspond to an existing user |
| 214 |
Error |
The specified group doesn't correspond to an existing group |
| 224 |
Warning |
The user isn't a member of the group specified |
Remove user from site
To remove a user from the specified site, use a Remove User From Site command.
Note: If a user still owns content—or assets—on Tableau Server, they can't be deleted unless the ownership is reassigned first. To delete a user, remove them from all sites they're a member of.
Properties
| Property |
Detail |
| User ID |
Enter the ID of the user to remove from the site. |
Outputs
None
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid inputs |
| 2 |
Error |
Couldn't authenticate with Tableau |
| 50 |
Error |
A problem arose that prevented the user from being removed from the site |
| 204 |
Error |
The specified user doesn't correspond to an existing user |
| 232 |
Error |
The username in the URI doesn't correspond to an existing user |
Remove workbook permissions
To remove the permissions for a User or Group on a Workbook, use a Remove Workbook Permissions command.
Properties
| Property |
Detail |
| Workbook ID |
Enter the ID of the workbook to update. |
| ID type (group or user) |
Select whether to update permissions associated with a User or Group. |
| ID |
Enter the ID of the user or group to update permissions on. |
| Capability name |
Select the name of the capability to add. |
| Mode |
Select whether to Allow or Deny the capability. |
Outputs
None
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid inputs |
| 2 |
Error |
Couldn't authenticate with Tableau |
| 137 |
Error |
A user attempted to add permissions to a workbook, but the caller doesn't have rights to do so |
| 204 |
Error |
The specified user doesn't correspond to an existing user |
| 208 |
Error |
The workbook ID doesn't correspond to an existing workbook |
| 214 |
Error |
The specified group doesn't correspond to an existing group |
| 215 |
Error |
The capability isn't assigned to the specified group or user with the specified mode |
Show datasource permissions
To view all permissions assigned to a Datasource, use a Show Datasource Permissions command.
Properties
| Property |
Detail |
| Datasource ID |
Enter the ID of the datasource to update. |
Outputs
None
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid inputs |
| 2 |
Error |
Couldn't authenticate with Tableau |
| 206 |
Error |
The specified datasource doesn't correspond to an existing datasource |
Show default permissions
To view the default permissions assigned to a project's Datasources or Workbooks, use a Show Default Permissions command.
Properties
| Property |
Detail |
| Project ID |
Enter the ID of the project to update. |
| Resource type |
Select whether to show permissions for a Workbook or Datasource. |
Outputs
None
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid inputs |
| 2 |
Error |
Couldn't authenticate with Tableau |
| 207 |
Error |
The project ID doesn't correspond to an existing project |
Show project permissions
To view all permissions assigned to a Project, use a Show Project Permissions command.
Properties
| Property |
Detail |
| Project ID |
Enter the ID of the project to show permissions of. |
Outputs
None
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid inputs |
| 2 |
Error |
Couldn't authenticate with Tableau |
| 207 |
Error |
The project ID doesn't correspond to an existing project |
Show workbook permissions
To view all permissions assigned to a Workbook, use a Show Workbook Permissions command.
Properties
| Property |
Detail |
| Workbook ID |
Enter the ID of the workbook to show permissions of. |
Outputs
None
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid inputs |
| 2 |
Error |
Couldn't authenticate with Tableau |
| 208 |
Error |
The workbook ID doesn't correspond to an existing workbook |
Update datasource
To update the Project, Owner, or Certification of a Datasource, use an Update Datasource command.
Properties
| Property |
Detail |
| Datasource ID |
Enter the ID of the datasource to update. |
| Project ID |
To update the project, enter the ID of the project to add the datasource to (optional). |
| Object ID |
To update the owner, enter the ID of the user to assign ownership of the datasource to (optional). |
| Certified |
If the datasource is certified, check this box (optional). |
| Certification note |
Enter any additional information about the datasource's certification, if applicable (optional). |
Outputs
| Output |
Output type |
| Updated datasource |
JSON |
| Datasource name |
String |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid inputs |
| 2 |
Error |
Couldn't authenticate with Tableau |
| 160 |
Error |
A non-administrator user tried to change the owner of the datasource |
| 163 |
Error |
A non-administrator user tried to change the project for the datasource, but the caller doesn't have Write permission for the project |
| 165 |
Error |
A non-administrator user tried to update the datasource, but the caller doesn't have Write permission |
| 204 |
Error |
The Owner ID doesn't correspond to an existing user |
| 206 |
Error |
The Datasource ID doesn't correspond to an existing datasource |
| 207 |
Error |
The Project ID doesn't correspond to an existing project |
| 244 |
Error |
The datasource name in the request already belongs to the specified site. To ensure uniqueness, datasource names are case-insensitive. |
Update datasource permissions
To update a permission for a Group or User on a Datasource, use an Update Datasource Permissions command.
Properties
| Property |
Detail |
| Datasource ID |
Enter the ID of the datasource to update. |
| ID type (group or user) |
Select whether to update permissions for a User or Group. |
| ID |
Enter the ID of the group or use to update permissions of. |
| Capability name |
Select the name of the capability to add. |
| Mode |
Select whether to Allow or Deny the capability. |
Outputs
None
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid inputs |
| 2 |
Error |
Couldn't authenticate with Tableau |
| 137 |
Error |
A user attempted to add permissions to a datasource, but the caller doesn't have rights to do so |
| 204 |
Error |
The Owner ID doesn't correspond to an existing user |
| 206 |
Error |
The Datasource ID doesn't correspond to an existing datasource |
| 214 |
Error |
The Group ID doesn't correspond to an existing group |
| 215 |
Error |
A capability specified in the request body doesn't correspond to a defined capability, due to either an invalid capability name or a capability other than Allow or Deny for any mode value |
Update default datasource permissions
To update the default permissions for a project's datasources, use an Update Default Datasource Permissions command.
Properties
| Property |
Detail |
| Project ID |
Enter the ID of the project to update. |
| ID type (group or user) |
Select whether to update permissions for a User or Group. |
| ID |
Enter the ID of the group or use to update permissions of. |
| Capability name |
Select the name of the capability to add. |
| Mode |
Select whether to Allow or Deny the capability. |
Outputs
None
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid inputs |
| 2 |
Error |
Couldn't authenticate with Tableau |
| 137 |
Error |
A user attempted to add permissions to a datasource, but the caller doesn't have rights to do so |
| 204 |
Error |
The Owner ID doesn't correspond to an existing user |
| 206 |
Error |
The Datasource ID doesn't correspond to an existing datasource |
| 214 |
Error |
The Group ID doesn't correspond to an existing group |
| 215 |
Error |
A capability specified in the request body doesn't correspond to a defined capability, due to either an invalid capability name or a capability other than Allow or Deny for any mode value |
Update default workbook permissions
To update the default permissions for a project's workbooks, use an Update Default Workbook Permissions command.
Properties
| Property |
Detail |
| Project ID |
Enter the ID of the project to update. |
| ID type (group or user) |
Select whether to update permissions for a User or Group. |
| ID |
Enter the ID of the group or use to update permissions of. |
| Capability name |
Select the name of the capability to add. |
| Mode |
Select whether to Allow or Deny the capability. |
Outputs
None
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid inputs |
| 2 |
Error |
Couldn't authenticate with Tableau |
| 137 |
Error |
A user attempted to add permissions to a datasource, but the caller doesn't have rights to do so |
| 204 |
Error |
The Owner ID doesn't correspond to an existing user |
| 206 |
Error |
The Datasource ID doesn't correspond to an existing datasource |
| 214 |
Error |
The Group ID doesn't correspond to an existing group |
| 215 |
Error |
A capability specified in the request body doesn't correspond to a defined capability, due to either an invalid capability name or a capability other than Allow or Deny for any mode value |
Update group
To update the name of a group, use an Update Group command.
Properties
| Property |
Detail |
| Group ID |
Enter the ID of the group to update. |
| Name |
Enter the new name for the project (optional). |
Outputs
| Output |
Output type |
| Updated group |
JSON |
| Group ID |
String |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid inputs |
| 2 |
Error |
Couldn't authenticate with Tableau |
| 207 |
Error |
The project ID in the URI doesn't correspond with an existing project |
| 214 |
Error |
The Group ID doesn't correspond to an existing group |
| 235 |
Error |
The project name in the request already belongs to the specified site. To ensure uniqueness, project names are case-insensitive |
| 238 |
Error |
The group name in the request is already used in the specified site. To ensure uniqueness, group names are case-insensitive. |
Update Hyper Extract
To add additional data to a Hyper Extract from a CSV file, use an Update Hyper Extract command.
Properties
| Property |
Detail |
| Tableau extract |
Enter the Extract file to update with new data. |
| Source CSV file |
Enter the file used to build data in the Hyper file. |
| File format |
Select the format of the CSV file. |
| Column types |
Enter the type of each column in Source CSV file: INTEGER, DOUBLE, BOOLEAN, DATE, DATETIME, DURATION, CHAR_STRING, UNICODE_STRING, or SPATIAL. |
Outputs
| Output |
Output type |
| Extract file |
File |
| Extract size (Bytes) |
Integer |
| Records processed |
Integer |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid inputs |
| 2 |
Error |
Couldn't authenticate with Tableau |
| 4 |
Error |
General error while creating the Hyper Extract |
| 5 |
Error |
Couldn't find the CSV input file |
| 6 |
Error |
The CSV isn't properly formatted, or the wrong format for the file is specified |
| 11 |
Error |
The number of the column types doesn't match the number of the header columns in the CSV |
| 12 |
Error |
Invalid column type |
Update project
To update the Parent Project, Name, Permissions, or Description of a Project, use an Update Project command.
Properties
| Property |
Detail |
| Project ID |
Enter the ID of the project to update. |
| Parent project ID |
To create project hierarchies, enter the identifier of the parent project (optional). |
| Name |
Enter the new name of the project (optional). |
| Content permissions |
Select the new permission settings for the project (optional):
- To lock permissions so users can't overwrite the default permissions set for the porject, select LockedToProject.
- To enable users to manage permission on content they own, select ManagedByOwner.
|
| Description |
Enter the new description for the project (optional). |
Outputs
| Output |
Output type |
| Updated Project |
JSON |
| Project ID |
String |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid inputs |
| 2 |
Error |
Couldn't authenticate with Tableau |
| 138 |
Error |
Attempted to rename the default project, which can't be renamed |
| 141 |
Error |
The samples couldn't be published because there isn't enough storage space remaining on the server to accommodate the samples |
| 207 |
Error |
The Project ID doesn't correspond to an existing project |
| 235 |
Error |
The project name in the request already belongs to the specified site. To ensure uniqueness, project names are case-insensitive. |
Update project permissions
To update a permission for a Group or User on a Project, use an Update Project Permissions command.
Properties
| Property |
Detail |
| Project ID |
Enter the ID of the project to update. |
| ID type (group or user) |
Select whether to update permissions for a User or Group. |
| ID |
Enter the ID of the user or group to update permissions of. |
| Capability name |
Select the name of the capability to add. |
| Mode |
Select whether to Allow or Deny the capability. |
Outputs
None
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid inputs |
| 2 |
Error |
Couldn't authenticate with Tableau |
| 137 |
Error |
A user attempted to add permissions to a project, but the caller doesn't have rights to do so |
| 204 |
Error |
The specified user doesn't correspond to an existing user |
| 207 |
Error |
The Project ID doesn't correspond to an existing project |
| 214 |
Error |
The specified group doesn't correspond to an existing group |
| 215 |
Error |
The specified capability doesn't correspond to a defined capability, due to either an invalid capability name or a capability other than Alllow or Deny for any mode value |
Update TDE extract
To add additional data to a TDE file from a CSV file, use an Update TDE Extract command.
Properties
| Property |
Detail |
| Tableau extract |
Enter the Extract file to update with new data. |
| Source CSV file |
Select the file used to build the data in the TDE file. |
| File format |
Select the format of the CSV file. |
| Column types |
Select the type of each column in Source CSV file: INTEGER, DOUBLE, BOOLEAN, DATE, DATETIME, DURATION, CHAR_STRING, UNICODE_STRING, or SPATIAL. |
| Mode |
Select whether to Allow or Deny the capability. |
Outputs
| Output |
Output type |
| Extract file |
File |
| Extract size (bytes) |
Integer |
| Records processed |
Integer |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid inputs |
| 2 |
Error |
Couldn't authenticate with Tableau |
| 4 |
Error |
General error while creating the TDE file |
| 5 |
Error |
Couldn't find the CSV input file |
| 6 |
Error |
TThe CSV isn't properly formatted, or the wrong format for the file is specified |
| 11 |
Error |
The number of column types doesn't match the number of header columns in the CSV |
| 12 |
Error |
One of the column types specified isn't a valid type |
Update workbook
To update the Project, Owner, or Show tabs setting of a Workbook, use an Update Workbook command.
Properties
| Property |
Detail |
| Workbook ID |
Enter the ID of the workbook to update. |
| Project ID |
Enter the ID of the project to assign the workbook to (optional). |
| Owner ID |
Enter the ID of the user to assign the workbook to as Owner (optional). |
| Show tabs |
To have the published workbook show views in tabs, check this box (optional). |
Outputs
| Output |
Output type |
| Updated workbook |
JSON |
| Workbook ID |
String |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid inputs |
| 2 |
Error |
Couldn't authenticate with Tableau |
| 150 |
Error |
A non-administrator tried to change the workbook owner |
| 158 |
Error |
A non-administrator tried to change the workbook project, but the caller doesn't have Write permission for the target project |
| 160 |
Error |
A non-administrator tried to change the workbook, but the caller doesn't have Write permission for the workbook |
| 204 |
Error |
The Owner ID doesn't correspond to an existing user |
| 207 |
Error |
The Project ID doesn't correspond to an existing project |
| 208 |
Error |
The Workbook ID doesn't correspond to an existing workbook |
| 244 |
Error |
The datasource name in the request already belongs to the specified site. To ensure uniqueness, datasource names are case-insensitive. |
Update workbook permissions
To update the permissions for a User or Group on a Workbook, use an Update Workbook Permissions command.
Properties
| Property |
Detail |
| Workbook ID |
Enter the ID of the workbook to update. |
| ID type (group or user) |
Select whether to update permissions associated with a Group or User. |
| ID |
Enter the ID of the group or user to update permissions of. |
| Capability name |
Select the name of the capability to add. |
| Mode |
Select whether to Allow or Deny the capability. |
Outputs
None
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid inputs |
| 2 |
Error |
Couldn't authenticate with Tableau |
| 137 |
Error |
A user attempted to add permissions to a project, but the caller doesn't have rights to do so |
| 204 |
Error |
The Owner ID doesn't correspond to an existing user |
| 207 |
Error |
The Project ID doesn't correspond to an existing project |
| 208 |
Error |
The Workbook ID doesn't correspond to an existing workbook |
| 214 |
Error |
The specified group doesn't correspond to an existing group |
| 215 |
Error |
The specified capability doesn't correspond to a defined capability, due to either an invalid capability name or a capability other than Alllow or Deny for any mode value |