tableau
Module tableau
API
Definitions
![](https://bcentral-dev-packageicons.azureedge.net/images/ballerinax_tableau_1.2.0.png)
ballerinax/tableau Ballerina library
Overview
This is a generated connector for Tableau API v3.11 OpenAPI specification. The Tableau API is a collection of endpoints for Tableau which is an excellent data visualization and business intelligence tool used for reporting and analyzing vast volumes of data.
Prerequisites
Before using this connector in your Ballerina application, complete the following:
- Create a Tableau account
- Obtain tokens by following this guide
Clients![](/images/permalink.svg)
tableau: Client![](/images/permalink.svg)
Versions: Tableau Server 2021.1 / Tableau Online March 2022 and later
This documentation describes the growing number OpenAPI endpoints being released alongside more than 150 classic REST endpoints that are currently in wide usage in the Tableau community.
There are some differences users of the classic endpoints will recognize when viewing these new endpoints.
-
Request bodies for these new REST endpoints must be formatted using JSON.
-
Endpoint URIs may contain a hyphen ('-') instead of an API version number, indicating that the resource is versioned separately from the numbered API release. For more information, see REST API and Resource Versions.
Starting in Tableau Server 2022.1 / Tableau Online March 2022, differences between releases will be noted in this reference.To view the previous version of this reference, see Tableau REST API OpenAPI Endpoints (v2021.4).
Constructor![](/images/permalink.svg)
Gets invoked to initialize the connector
.
init (ClientConfiguration clientConfig, string serviceUrl)
- clientConfig ClientConfiguration {} - The configurations to be used when initializing the
connector
- serviceUrl string "https://tableau.example.com/" - URL of the target service
analyticsextensionsserviceGetanalyticsextensionsconnection![](/images/permalink.svg)
function analyticsextensionsserviceGetanalyticsextensionsconnection(string connectionLuid, string? xTableauAuth) returns TableauAnalyticsextensionsV1Connectionitem|error
Get analytics extension details
Parameters
- connectionLuid string -
- xTableauAuth string? (default ()) - The Tableau authentication header. The value is a credentials token from a Tableau server's response to an authentication request. The Content-Type and Accept headers should be the mediatype of the request and response except in cases where you want to explicitly allow other versions of the resource.
Return Type
- TableauAnalyticsextensionsV1Connectionitem|error - Successful.
analyticsextensionsserviceUpdateanalyticsextensionsconnection![](/images/permalink.svg)
function analyticsextensionsserviceUpdateanalyticsextensionsconnection(string connectionLuid, byte[] payload, string? xTableauAuth) returns TableauAnalyticsextensionsV1Connectionitem|error
Update analytics extension connection of site
Parameters
- connectionLuid string -
- payload byte[] -
- xTableauAuth string? (default ()) - The Tableau authentication header. The value is a credentials token from a Tableau server's response to an authentication request. The Content-Type and Accept headers should be the mediatype of the request and response except in cases where you want to explicitly allow other versions of the resource.
Return Type
- TableauAnalyticsextensionsV1Connectionitem|error - Successful.
analyticsextensionsserviceDeleteanalyticsextensionsconnection![](/images/permalink.svg)
function analyticsextensionsserviceDeleteanalyticsextensionsconnection(string connectionLuid, string? xTableauAuth) returns Response|error
Delete analytics extension connection from site
Parameters
- connectionLuid string -
- xTableauAuth string? (default ()) - The Tableau authentication header. The value is a credentials token from a Tableau server's response to an authentication request. The Content-Type and Accept headers should be the mediatype of the request and response except in cases where you want to explicitly allow other versions of the resource.
dashboardextensionssitesettingsserviceGetdashboardextensionssafelistitem![](/images/permalink.svg)
function dashboardextensionssitesettingsserviceGetdashboardextensionssafelistitem(string safeListItemLuid, string? xTableauAuth) returns TableauExtensionsDashboardV1Safelistitem|error
Get allowed dashboard extension on site
Parameters
- safeListItemLuid string -
- xTableauAuth string? (default ()) - The Tableau authentication header. The value is a credentials token from a Tableau server's response to an authentication request. The Content-Type and Accept headers should be the mediatype of the request and response except in cases where you want to explicitly allow other versions of the resource.
Return Type
- TableauExtensionsDashboardV1Safelistitem|error - Successful.
dashboardextensionssitesettingsserviceUpdatedashboardextensionssafelistitem![](/images/permalink.svg)
function dashboardextensionssitesettingsserviceUpdatedashboardextensionssafelistitem(string safeListItemLuid, byte[] payload, string? xTableauAuth) returns TableauExtensionsDashboardV1Safelistitem|error
Update settings for allowed dashboard extension on site
Parameters
- safeListItemLuid string -
- payload byte[] -
- xTableauAuth string? (default ()) - The Tableau authentication header. The value is a credentials token from a Tableau server's response to an authentication request. The Content-Type and Accept headers should be the mediatype of the request and response except in cases where you want to explicitly allow other versions of the resource.
Return Type
- TableauExtensionsDashboardV1Safelistitem|error - Successful.
dashboardextensionssitesettingsserviceDeletedashboardextensionssafelistitem![](/images/permalink.svg)
function dashboardextensionssitesettingsserviceDeletedashboardextensionssafelistitem(string safeListItemLuid, string? xTableauAuth) returns Response|error
Disallow dashboard extension on site
Parameters
- safeListItemLuid string -
- xTableauAuth string? (default ()) - The Tableau authentication header. The value is a credentials token from a Tableau server's response to an authentication request. The Content-Type and Accept headers should be the mediatype of the request and response except in cases where you want to explicitly allow other versions of the resource.
analyticsextensionsserviceGetconnectionoptionsforworkbook![](/images/permalink.svg)
function analyticsextensionsserviceGetconnectionoptionsforworkbook(string workbookLuid, string? xTableauAuth) returns TableauAnalyticsextensionsV1Connectionmetadatalist|error
List analytics extension connections of workbook
Parameters
- workbookLuid string -
- xTableauAuth string? (default ()) - The Tableau authentication header. The value is a credentials token from a Tableau server's response to an authentication request. The Content-Type and Accept headers should be the mediatype of the request and response except in cases where you want to explicitly allow other versions of the resource.
Return Type
- TableauAnalyticsextensionsV1Connectionmetadatalist|error - Successful.
analyticsextensionsserviceGetselectedconnectionforworkbook![](/images/permalink.svg)
function analyticsextensionsserviceGetselectedconnectionforworkbook(string workbookLuid, string? xTableauAuth) returns TableauAnalyticsextensionsV1Connectionmetadatalist|error
Get current analytics extension for workbook
Parameters
- workbookLuid string -
- xTableauAuth string? (default ()) - The Tableau authentication header. The value is a credentials token from a Tableau server's response to an authentication request. The Content-Type and Accept headers should be the mediatype of the request and response except in cases where you want to explicitly allow other versions of the resource.
Return Type
- TableauAnalyticsextensionsV1Connectionmetadatalist|error - Successful.
analyticsextensionsserviceUpdateworkbookwithconnection![](/images/permalink.svg)
function analyticsextensionsserviceUpdateworkbookwithconnection(string workbookLuid, byte[] payload, string? xTableauAuth) returns TableauAnalyticsextensionsV1Connectionmetadatalist|error
Update analytics extension for workbook
Parameters
- workbookLuid string -
- payload byte[] -
- xTableauAuth string? (default ()) - The Tableau authentication header. The value is a credentials token from a Tableau server's response to an authentication request. The Content-Type and Accept headers should be the mediatype of the request and response except in cases where you want to explicitly allow other versions of the resource.
Return Type
- TableauAnalyticsextensionsV1Connectionmetadatalist|error - Successful.
analyticsextensionsserviceDeleteconnectionfromworkbook![](/images/permalink.svg)
function analyticsextensionsserviceDeleteconnectionfromworkbook(string workbookLuid, string? xTableauAuth) returns Response|error
Remove current analytics extension connection for workbook
Parameters
- workbookLuid string -
- xTableauAuth string? (default ()) - The Tableau authentication header. The value is a credentials token from a Tableau server's response to an authentication request. The Content-Type and Accept headers should be the mediatype of the request and response except in cases where you want to explicitly allow other versions of the resource.
analyticsextensionsserviceGetanalyticsextensionssitesettings![](/images/permalink.svg)
function analyticsextensionsserviceGetanalyticsextensionssitesettings(string? xTableauAuth) returns TableauAnalyticsextensionsV1Connectionmetadatalist|error
Get enabled state of analytics extensions on site
Parameters
- xTableauAuth string? (default ()) - The Tableau authentication header. The value is a credentials token from a Tableau server's response to an authentication request. The Content-Type and Accept headers should be the mediatype of the request and response except in cases where you want to explicitly allow other versions of the resource.
Return Type
- TableauAnalyticsextensionsV1Connectionmetadatalist|error - Successful.
analyticsextensionsserviceUpdateanalyticsextensionssitesettings![](/images/permalink.svg)
function analyticsextensionsserviceUpdateanalyticsextensionssitesettings(byte[] payload, string? xTableauAuth) returns TableauAnalyticsextensionsV1Connectionmetadatalist|error
Update enabled state of analytics extensions on site
Parameters
- payload byte[] -
- xTableauAuth string? (default ()) - The Tableau authentication header. The value is a credentials token from a Tableau server's response to an authentication request. The Content-Type and Accept headers should be the mediatype of the request and response except in cases where you want to explicitly allow other versions of the resource.
Return Type
- TableauAnalyticsextensionsV1Connectionmetadatalist|error - Successful.
dashboardextensionssitesettingsserviceGetdashboardextensionssitesettings![](/images/permalink.svg)
function dashboardextensionssitesettingsserviceGetdashboardextensionssitesettings(string? xTableauAuth) returns TableauAnalyticsextensionsV1Connectionmetadatalist|error
List dashboard extension settings of site
Parameters
- xTableauAuth string? (default ()) - The Tableau authentication header. The value is a credentials token from a Tableau server's response to an authentication request. The Content-Type and Accept headers should be the mediatype of the request and response except in cases where you want to explicitly allow other versions of the resource.
Return Type
- TableauAnalyticsextensionsV1Connectionmetadatalist|error - Successful.
dashboardextensionssitesettingsserviceUpdatedashboardextensionssitesettings![](/images/permalink.svg)
function dashboardextensionssitesettingsserviceUpdatedashboardextensionssitesettings(byte[] payload, string? xTableauAuth) returns Response|error
Update dashboard extension settings of site
Parameters
- payload byte[] -
- xTableauAuth string? (default ()) - The Tableau authentication header. The value is a credentials token from a Tableau server's response to an authentication request. The Content-Type and Accept headers should be the mediatype of the request and response except in cases where you want to explicitly allow other versions of the resource.
dashboardextensionsserversettingsserviceGetdashboardextensionsblocklistitems![](/images/permalink.svg)
function dashboardextensionsserversettingsserviceGetdashboardextensionsblocklistitems(string? xTableauAuth) returns TableauAnalyticsextensionsV1Connectionmetadatalist|error
List blocked dashboard extensions on server
Parameters
- xTableauAuth string? (default ()) - The Tableau authentication header. The value is a credentials token from a Tableau server's response to an authentication request. The Content-Type and Accept headers should be the mediatype of the request and response except in cases where you want to explicitly allow other versions of the resource.
Return Type
- TableauAnalyticsextensionsV1Connectionmetadatalist|error - Successful.
dashboardextensionsserversettingsserviceCreatedashboardextensionsblocklistitem![](/images/permalink.svg)
function dashboardextensionsserversettingsserviceCreatedashboardextensionsblocklistitem(byte[] payload, string? xTableauAuth) returns TableauAnalyticsextensionsV1Connectionmetadatalist|error
Block dashboard extension on server
Parameters
- payload byte[] -
- xTableauAuth string? (default ()) - The Tableau authentication header. The value is a credentials token from a Tableau server's response to an authentication request. The Content-Type and Accept headers should be the mediatype of the request and response except in cases where you want to explicitly allow other versions of the resource.
Return Type
- TableauAnalyticsextensionsV1Connectionmetadatalist|error - Successful.
dashboardextensionssitesettingsserviceGetdashboardextensionssafelistitems![](/images/permalink.svg)
function dashboardextensionssitesettingsserviceGetdashboardextensionssafelistitems(string? xTableauAuth) returns TableauAnalyticsextensionsV1Connectionmetadatalist|error
Lists allowed dashboard extensions on site
Parameters
- xTableauAuth string? (default ()) - The Tableau authentication header. The value is a credentials token from a Tableau server's response to an authentication request. The Content-Type and Accept headers should be the mediatype of the request and response except in cases where you want to explicitly allow other versions of the resource.
Return Type
- TableauAnalyticsextensionsV1Connectionmetadatalist|error - Successful.
dashboardextensionssitesettingsserviceCreatedashboardextensionssafelistitem![](/images/permalink.svg)
function dashboardextensionssitesettingsserviceCreatedashboardextensionssafelistitem(byte[] payload, string? xTableauAuth) returns TableauAnalyticsextensionsV1Connectionmetadatalist|error
Allow dashboard extension on site
Parameters
- payload byte[] -
- xTableauAuth string? (default ()) - The Tableau authentication header. The value is a credentials token from a Tableau server's response to an authentication request. The Content-Type and Accept headers should be the mediatype of the request and response except in cases where you want to explicitly allow other versions of the resource.
Return Type
- TableauAnalyticsextensionsV1Connectionmetadatalist|error - Successful.
analyticsextensionsserviceGetanalyticsextensionsconnections![](/images/permalink.svg)
function analyticsextensionsserviceGetanalyticsextensionsconnections(string? xTableauAuth) returns TableauAnalyticsextensionsV1Connectionmetadatalist|error
List analytics extension connections on site
Parameters
- xTableauAuth string? (default ()) - The Tableau authentication header. The value is a credentials token from a Tableau server's response to an authentication request. The Content-Type and Accept headers should be the mediatype of the request and response except in cases where you want to explicitly allow other versions of the resource.
Return Type
- TableauAnalyticsextensionsV1Connectionmetadatalist|error - Successful.
analyticsextensionsserviceAddanalyticsextensionsconnection![](/images/permalink.svg)
function analyticsextensionsserviceAddanalyticsextensionsconnection(byte[] payload, string? xTableauAuth) returns TableauAnalyticsextensionsV1Connectionmetadatalist|error
Add analytics extension connection to site
Parameters
- payload byte[] -
- xTableauAuth string? (default ()) - The Tableau authentication header. The value is a credentials token from a Tableau server's response to an authentication request. The Content-Type and Accept headers should be the mediatype of the request and response except in cases where you want to explicitly allow other versions of the resource.
Return Type
- TableauAnalyticsextensionsV1Connectionmetadatalist|error - Successful.
analyticsextensionsserviceGetanalyticsextensionsserversettings![](/images/permalink.svg)
function analyticsextensionsserviceGetanalyticsextensionsserversettings(string? xTableauAuth) returns TableauAnalyticsextensionsV1Connectionmetadatalist|error
Get enabled state of analytics extensions on server
Parameters
- xTableauAuth string? (default ()) - The Tableau authentication header. The value is a credentials token from a Tableau server's response to an authentication request. The Content-Type and Accept headers should be the mediatype of the request and response except in cases where you want to explicitly allow other versions of the resource.
Return Type
- TableauAnalyticsextensionsV1Connectionmetadatalist|error - Successful.
analyticsextensionsserviceUpdateanalyticsextensionsserversettings![](/images/permalink.svg)
function analyticsextensionsserviceUpdateanalyticsextensionsserversettings(byte[] payload, string? xTableauAuth) returns TableauAnalyticsextensionsV1Connectionmetadatalist|error
Enable or disable analytics extensions on server
Parameters
- payload byte[] -
- xTableauAuth string? (default ()) - The Tableau authentication header. The value is a credentials token from a Tableau server's response to an authentication request. The Content-Type and Accept headers should be the mediatype of the request and response except in cases where you want to explicitly allow other versions of the resource.
Return Type
- TableauAnalyticsextensionsV1Connectionmetadatalist|error - Successful.
dashboardextensionsserversettingsserviceGetdashboardextensionsblocklistitem![](/images/permalink.svg)
function dashboardextensionsserversettingsserviceGetdashboardextensionsblocklistitem(string blockListItemLuid, string? xTableauAuth) returns TableauAnalyticsextensionsV1Connectionmetadatalist|error
Get blocked dashboard extension on server
Parameters
- blockListItemLuid string -
- xTableauAuth string? (default ()) - The Tableau authentication header. The value is a credentials token from a Tableau server's response to an authentication request. The Content-Type and Accept headers should be the mediatype of the request and response except in cases where you want to explicitly allow other versions of the resource.
Return Type
- TableauAnalyticsextensionsV1Connectionmetadatalist|error - Successful.
dashboardextensionsserversettingsserviceDeletedashboardextensionsblocklistitem![](/images/permalink.svg)
function dashboardextensionsserversettingsserviceDeletedashboardextensionsblocklistitem(string blockListItemLuid, string? xTableauAuth) returns TableauAnalyticsextensionsV1Connectionmetadatalist|error
Unblock dashboard extension on server
Parameters
- blockListItemLuid string -
- xTableauAuth string? (default ()) - The Tableau authentication header. The value is a credentials token from a Tableau server's response to an authentication request. The Content-Type and Accept headers should be the mediatype of the request and response except in cases where you want to explicitly allow other versions of the resource.
Return Type
- TableauAnalyticsextensionsV1Connectionmetadatalist|error - Successful.
dashboardextensionsserversettingsserviceGetdashboardextensionsserversettings![](/images/permalink.svg)
function dashboardextensionsserversettingsserviceGetdashboardextensionsserversettings(string? xTableauAuth) returns TableauAnalyticsextensionsV1Connectionmetadatalist|error
List settings for dashboard extensions on server
Parameters
- xTableauAuth string? (default ()) - The Tableau authentication header. The value is a credentials token from a Tableau server's response to an authentication request. The Content-Type and Accept headers should be the mediatype of the request and response except in cases where you want to explicitly allow other versions of the resource.
Return Type
- TableauAnalyticsextensionsV1Connectionmetadatalist|error - Successful.
dashboardextensionsserversettingsserviceUpdatedashboardextensionsserversettings![](/images/permalink.svg)
function dashboardextensionsserversettingsserviceUpdatedashboardextensionsserversettings(byte[] payload, string? xTableauAuth) returns TableauAnalyticsextensionsV1Connectionmetadatalist|error
Update dashboard extensions settings of server
Parameters
- payload byte[] -
- xTableauAuth string? (default ()) - The Tableau authentication header. The value is a credentials token from a Tableau server's response to an authentication request. The Content-Type and Accept headers should be the mediatype of the request and response except in cases where you want to explicitly allow other versions of the resource.
Return Type
- TableauAnalyticsextensionsV1Connectionmetadatalist|error - Successful.
Records![](/images/permalink.svg)
tableau: TableauAnalyticsextensionsV1Connectionbrief![](/images/permalink.svg)
Fields
- connection_name string? - Required. The title of the connection.
- connection_type string? - Required. The kind of service responding to analytics extension requests. The value can be: TABPY, for a Tableau TabPy server; GENERIC_API for your custom service that complies with the Analytics Extensions API spec; or RSERVE, for an Rserve service; or EINSTEIN_DISCOVERY for your instance of Einstein Discovery.
tableau: TableauAnalyticsextensionsV1Connectionitem![](/images/permalink.svg)
Fields
- connection_luid string? -
- host string? - Required. The location of an external service (TabPy, Rserve, EINSTEIN_DISCOVERY, Generic API, or other) that responds to your analytics extension requests. The case sensitive value must be a URI, IPv4 or IPv6 address that is a maximum of 255 Unicode characters.
Starting in Tableau 2022.1 / Online April 2022, a host address can include path information (
www.example.com/path
), where previous versions supported only the root domain name (www.example.com
).
- port int? - Required. Integer between 1 and 65535.
- is_auth_enabled boolean? - For Tableau Online: The value is always true. For on premise Tableau servers: Optional. Set to true if authentication is enabled on the external service. If true, username and password are required. Default is false.
- username string? - For Tableau Online: A username is always required.
- password string? - For Tableau Online: A password is always required.
- is_ssl_enabled boolean? - For Tableau Online: The value is always true. For on premise Tableau servers: Optional. Set to true if authentication is enabled on the external service. If true, username and password are required. Default is false.
- connection_brief TableauAnalyticsextensionsV1Connectionbrief? -
tableau: TableauAnalyticsextensionsV1Connectionlist![](/images/permalink.svg)
Fields
- connectionList TableauAnalyticsextensionsV1Connectionitem[]? -
tableau: TableauAnalyticsextensionsV1Connectionmapping![](/images/permalink.svg)
Fields
- workbook_luid string? -
- connection_luid string? -
tableau: TableauAnalyticsextensionsV1Connectionmetadata![](/images/permalink.svg)
Fields
- connection_luid string? -
- connection_brief TableauAnalyticsextensionsV1Connectionbrief? -
tableau: TableauAnalyticsextensionsV1Connectionmetadatalist![](/images/permalink.svg)
Fields
- connectionMetadataList TableauAnalyticsextensionsV1Connectionmetadata[]? -
tableau: TableauAnalyticsextensionsV1Serversettings![](/images/permalink.svg)
Fields
- enabled boolean? -
tableau: TableauAnalyticsextensionsV1Sitesettings![](/images/permalink.svg)
Fields
- enabled boolean? -
tableau: TableauError![](/images/permalink.svg)
Fields
- httpErrorCode string? -
- message string? -
tableau: TableauExtensionsDashboardV1Blocklistitem![](/images/permalink.svg)
A dashboard extension that is blocked from running on a server.
Fields
- url string? - Location of the dashboard extension to be blocked from a site.
- block_list_item_luid string? -
tableau: TableauExtensionsDashboardV1Blocklistitems![](/images/permalink.svg)
List of dashboard extensions blocked from running on a server.
Fields
- block_list_items TableauExtensionsDashboardV1Blocklistitem[]? -
tableau: TableauExtensionsDashboardV1Safelistitem![](/images/permalink.svg)
A dashboard extension that is allowed to run on a site.
Fields
- safe_list_item_luid string? -
- url string? - Location (URL) of the dashboard extension to be allowed on a site.
- allow_full_data boolean? - When true, the extension has access to underlying data of a workbook. This setting is only effective when the extension is on the site safe list. Default is false.
- prompt_needed boolean? - When true, the user will be prompted to grant an extension access to the underlying data of a workbook. This setting is only effective when the extension is on the site safe list. Default is false.
tableau: TableauExtensionsDashboardV1Safelistitems![](/images/permalink.svg)
List of dashboard extensions allowed to run on a site.
Fields
- safe_list_items TableauExtensionsDashboardV1Safelistitem[]? -
tableau: TableauExtensionsDashboardV1Serversettings![](/images/permalink.svg)
Extension settings of a Tableau server.
Fields
- block_list_items TableauExtensionsDashboardV1Blocklistitem[]? -
- extensions_enabled boolean? - Specifies whether sandboxed extensions are allowed to run on the site.
tableau: TableauExtensionsDashboardV1Sitesettings![](/images/permalink.svg)
Dashboard extension settings of a site.
Fields
- extensions_enabled boolean? - Specifies whether extensions are allowed to run on the site.
- allow_sandboxed boolean? - Specifies whether sandboxed extensions are allowed to run on the site.
- safe_list_items TableauExtensionsDashboardV1Safelistitem[]? -
Import
import ballerinax/tableau;
Metadata
Released date: over 1 year ago
Version: 1.2.0
License: Apache-2.0
Compatibility
Platform: any
Ballerina version: 2201.2.1
GraalVM compatible: Yes
Pull count
Total: 0
Current verison: 0
Weekly downloads
Keywords
Business Intelligence/Visualization
Cost/Freemium
Contributors
Dependencies