Skip to content

Add ability to rename workbook using the 'update workbook' endpoint #284

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
shinchris merged 2 commits into from
Apr 10, 2018
Merged

Add ability to rename workbook using the 'update workbook' endpoint #284

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5e39b89
adding ability to rename workbook using workbooks.update()
Apr 10, 2018
e60f296
updating test
Apr 10, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions tableauserverclient/server/request_factory.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -334,6 +334,8 @@ def _generate_xml(self, workbook_item, connection_credentials=None):
def update_req(self, workbook_item):
xml_request = ET.Element('tsRequest')
workbook_element = ET.SubElement(xml_request, 'workbook')
if workbook_item.name:
workbook_element.attrib['name'] = workbook_item.name
if workbook_item.show_tabs:
workbook_element.attrib['showTabs'] = str(workbook_item.show_tabs).lower()
if workbook_item.project_id:
Expand Down
2 changes: 1 addition & 1 deletion test/assets/workbook_update.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?xml version='1.0' encoding='UTF-8'?>
<tsResponse xmlns="http://tableau.com/api" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://tableau.com/api http://tableau.com/api/ts-api-2.3.xsd">
<workbook id="1f951daf-4061-451a-9df1-69a8062664f2" name="RESTAPISample" contentUrl="RESTAPISample" showTabs="true" size="1" createdAt="2016-08-18T18:25:36Z" updatedAt="2016-08-18T18:29:36Z">
<workbook id="1f951daf-4061-451a-9df1-69a8062664f2" name="renamedWorkbook" contentUrl="RESTAPISample" showTabs="true" size="1" createdAt="2016-08-18T18:25:36Z" updatedAt="2016-08-18T18:29:36Z">
<project id="1d0304cd-3796-429f-b815-7258370b9b74" name="Tableau" />
<owner id="dd2239f6-ddf1-4107-981a-4cf94e415794" />
<tags />
Expand Down
2 changes: 2 additions & 0 deletions test/test_workbook.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,12 +114,14 @@ def test_update(self):
single_workbook = TSC.WorkbookItem('1d0304cd-3796-429f-b815-7258370b9b74', show_tabs=True)
single_workbook._id = '1f951daf-4061-451a-9df1-69a8062664f2'
single_workbook.owner_id = 'dd2239f6-ddf1-4107-981a-4cf94e415794'
single_workbook.name = 'renamedWorkbook'
single_workbook = self.server.workbooks.update(single_workbook)

self.assertEqual('1f951daf-4061-451a-9df1-69a8062664f2', single_workbook.id)
self.assertEqual(True, single_workbook.show_tabs)
self.assertEqual('1d0304cd-3796-429f-b815-7258370b9b74', single_workbook.project_id)
self.assertEqual('dd2239f6-ddf1-4107-981a-4cf94e415794', single_workbook.owner_id)
self.assertEqual('renamedWorkbook', single_workbook.name)

def test_update_missing_id(self):
single_workbook = TSC.WorkbookItem('test')
Expand Down