Publish Workbook
POST {{base-path}}/sites/{{site-id}}/workbooks
https://help.tableau.com/current/api/restapi/en-us/REST/restapirefpublishing.htm#publish_workbook
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
overwrite | boolean | (Optional) true to overwrite a workbook that has the same name, or false to fail if the specified workbook already exists. The default is false. If overwrite-flag is set to true but the workbook doesn't already exist, the operation succeeds. | |
skipConnectionCheck | null | (Optional, boolean) If true, then the Tableau server will not check if a non-published connection of a workbook is reachable. 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). Default value is false. | |
uploadSessionId | string | If you are calling this method to commit a file that was uploaded in parts, this value contains the upload session ID that was generated by a call to Initiate File Upload. If this value is not included, the server assumes that the body of the request contains the file to be published. | |
workbookType | string | twb or twbx to indicate whether you have uploaded a workbook file (twb) or a packaged workbook file (twbx). 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. |
Request Body
[{"name"=>"request_payload", "value"=>"<tsRequest>\n <workbook name=\"workbook-name\" showTabs=\"show-tabs-flag\" thumbnailsUserId=\"{{user-id}}\">\n <connections>\n <connection serverAddress=\"server-address\" serverPort=\"port-number\">\n <connectionCredentials name=\"connection-username\" password=\"connection-password\"\n embed=\"embed-flag\" />\n </connection>\n </connections>\n <project id=\"{{project-id}}\"/>\n </workbook>\n</tsRequest>", "datatype"=>"string"}, {"name"=>"tableau_workbook", "value"=>nil, "datatype"=>"null"}]