In this blog, we will be focusing on one such specific requirement that most Tableau users and clients look for i. Tableau realizing this has an extremely useful built-in feature for users to download their visualizations.
For instance, the download feature at times leaves users bewildered as to how exactly they need to go about to download a PDF. At times the necessary steps you need to follow are not fully understood by all business intelligence users. Tableau Workbook : Downloads a workbook you can open with Tableau Desktop. You have the option of downloading the workbook to different versions of Tableau or keeping the workbook in its current version.
For example, if the workbook needs to be opened in Tableau Desktop Note: Downloading extremely large amounts of data can affect server performance and might not complete successfully. If you encounter these issues, try exporting the data directly from the underlying data source.
Tableau Desktop and Web Authoring Help. Download Views and Workbooks Version: Or, click the download button wherever it appears on the page. Select a download format: Note: The download formats available to you depend on permissions granted by Tableau content owners and site administrators.
When downloading from a dashboard, first click the specific sheet with data you want. For dashboards, all sheets will be listed, including hidden sheets. To prevent multiple PDF requests from overloading the server, the shortest interval you can set is one minute. The value can be Portrait or Landscape. If this parameter is not present the page orientation will default to Portrait. To download a. The user needs Read and ExportImage permissions for a view in a workbook in order for that view to appear in the.
The response is a file that contains the workbook, whose data is no older than 60 minutes, saved as a pdf. Downloads a PowerPoint.
If you make multiple requests for a. A non-administrator user attempted to download a. The response is a file that contains the workbook, whose data is no older than 60 minutes, saved as a. Note: This method is available only if version history is enabled for the specified site. To determine what versions are available, call Get Workbook Revisions.
Note that the current revision of a workbook cannot be accessed by this call; use Download Workbook instead. Tableau Server users who are site administrators can download workbook revisions on the site that they are administrators for. Users who are not server administrators or site administrators can download workbook revisions if they have all of the following:.
For Tableau Server users who are not server administrators or site administrators, the method returns only the views that the user owns or has Read permissions for either explicitly or implicitly. Modifying the name display name of a view will not impact the view-url-name path element of the view's URL. Gets a list of views that are recommended for a user.
Using machine learning, the server will match preferences between similar users and recommend content that is most popular and recently viewed. When a recommended view is selected and not marked as hidden, it appears on the server Home and Recommendations pages.
Returns a list of the features that would be impacted, and the severity of the impact, when a workbook is exported as a downgraded version for instance, exporting a v Tableau Server users who are site administrators can get downgrade information for workbooks on the site that they are administrators for.
Users who are not server administrators or site administrators can get downgrade information for workbooks they have permissions to. HTTP status error Code Condition Details Unknown downgrade error The workbook cannot be exported to a downgraded version due to an unknown error. To get a specific version of the workbook from revision history, use the Download Workbook Revision method.
The minimum is 1. The maximum is The default is For more information, see Paginating Results. The default is 1. Tableau Server users who are site administrators can get workbook revisions on the site that they are administrators for.
Users who are not server administrators or site administrators can get workbook revisions if they have all of the following:. HTTP status error Code Condition Details Invalid page number 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.
Hides a view from being recommended by the server by adding it to a list of views that are dismissed for a user. If hidden, a view will not be displayed on the server Home or Recommendation pages.
Permissions This method can only be called by server administrators and site administrators. Publishes a workbook on the specified site. This method is used in two ways. You can call it to publish a workbook in a single request. To do that, you include the content of the workbook file in the body of the request. The maximum size of a file that can be published in a single request is 64 MB. If you want to avoid having the publishing process time out, you can use the asJob parameter to make workbook publication asynchronous.
Alternatively, you can publish a workbook in multiple parts. To do that, you initiate a file upload by calling Initiate File Upload , send portions of the file to the server using Append to File Upload , and then commit the upload by calling Publish Workbook. In this case, Publish Workbook doesn't contain the file to publish. Hiding views in a published workbook To exclude certain sheets also known as views when you publish a workbook, configure them in the request as hidden.
You cannot publish a workbook if all sheets are hidden. Extracts with multiple table options If an extract was stored using the multiple tables option, you can't append data to it. Workbooks that rely on external local resources When you publish a workbook from your local computer to the server, the publish process will fail if the workbook relies on resources such as an Excel file or other data file that are on your local computer but are not available on the server.
Unlike the publish process that is used in Tableau Desktop, the REST API publish process cannot automatically include extracts or other resources that the workbook uses. If you are publishing a workbook that gets its data from a source on your computer, save the workbook as a packaged workbook.
The default is false. If overwrite-flag is set to true but the workbook doesn't already exist, the operation succeeds. If a workbook is very large, the process might time out before it finishes. If you set this value to true , the process runs asynchronously, and a job will start to perform the publishing process and return the job ID. You can check the status of the import job by calling Query Job.
Default value is false. Publishing will succeed but unchecked connection issues may result in a non-functioning workbook. If you encounter this issue, follow Keep Data Fresh guidelines Link opens in a new window. If this value is not included, the server assumes that the body of the request contains the file to be published. This value is required if you are calling Publish Workbook in order to commit a file that was previously uploaded using Append to File Upload.
The value is not used if you upload a file in the body of the request. If the element is included but is not required for example, if the data source uses OAuth , the server ignores the element and its attributes. Note: Even if credentials are embedded in a workbook, you must still provide credentials when connecting to a data source that requires credentials, unless that data source uses OAuth.
Tableau Server users who are not server administrators or site administrators can publish a workbook only if the workbook belongs to a project that they have permissions to publish to.
This is disallowed for all projects including the default project. This can be due to missing or invalid connection credentials or because the referenced data source is not available on the server. Content of publish-workbook. Note : After you create a resource, the server updates its search index. If you make a query immediately to see a new resource, the query results might not be up to date. You can include multiple field expressions in a request. Optional get-usage-information true to return usage statistics.
Tableau Server users who are not server administrators or site administrators can query workbook views only if they have Read view permission for the views either explicitly or implicitly. CSV data is provided in the response body, rather than as a download. If the request is for a dashboard, only data for the the dashboard's first view is returned.
If you make multiple requests for a view's data, subsequent calls return a cached version of the data. This means that the returned data might not include the latest changes to the view.
To decrease the amount of time that an data is cached, use the maxAge parameter. For Tableau Online, concurrent requests to endpoints that start long-running jobs, including this one, are limited to 20 at a time.
A HTML reponse means that a request exceeded the limit and should be retried at a later time. This method includes the ability to filter a view using fields in the underlying workbook data. To prevent multiple view data requests from overloading the server, the shortest interval you can set is one minute.
To learn more, see Filter query views. This limit applies to long-running jobs such as exports and downloads for view data, images,. Example response: The returned view data will be no more than 60 minutes old.
If you make multiple requests for an image, subsequent calls return a cached version of the image. This means that the returned image might not include the latest changes to the view. To decrease the amount of time that an image is cached, use the maxAge parameter. For more information, see tsm configuration set options in the Tableau Server help.
Image width and actual pixel density are determined by the display context of the image. Aspect ratio is always preserved. Set the value to high to ensure maximum pixel density. To prevent multiple image requests from overloading the server, the shortest interval you can set is one minute.
HTTP status error Code Condition Details Read forbidden A non-administrator user attempted to query a view preview image, but the caller doesn't have Read permission. For more information, see tsm configuration set Options in the Tableau Server help.
This means that the returned PDF might not include the latest changes to the view. To decrease the amount of time that an PDF is cached, use the maxAge parameter. The response is a file that contains the view, whose data is no older than 60 minutes, saved as a pdf. Tableau Server users who are not server administrators or site administrators can query a workbook only if they have Read view permission for the workbook either explicitly or implicitly. HTTP status error Code Condition Details Read forbidden A non-administrator user attempted to query the workbook, but the caller doesn't have Read permission.
If the user is not an administrator, the method returns just the workbooks that the user has permissions to view. You can filter on predefined fields such as name , tags , and createdAt.
You can include multiple filter expressions. For more information, see Filtering and Sorting. If you do not specify a sort expression, the sort order of the information that's returned is undefined. Tableau Server users who are not server administrators or site administrators can get workbooks that they have Read view permissions for either explicitly or implicitly. For more information, see Data Acceleration. HTTP status error Code Condition Details Invalid page number The page number is not an integer, is less than one, or is greater than the final page number for users at the requested page size.
The following example includes a filter to return the workbooks that were updated on 1 May at AM or later and specifies that the results should be sorted by the workbook name. Returns the workbooks that the specified user owns in addition to those that the user has Read view permissions for. All users can call this method, but the results of the call depend on the user's permissions.
Server and site administrators see all workbooks for the specified user.
0コメント