server-client-python
server-client-python copied to clipboard
tableau
Add Workbook Item Description
Summary
Provide a setter for the workbook item Description Field
Request Type
Support a REST API
The API: PUT /api/api-version/sites/site-id/workbooks/workbook-id supports a description field. the Schema definition for WorkbookType contains an element xs:attribute name="description" type="xs:string"
The Python API currently does not support this element. It could be added by modifying:
- tableauserverclient/models/workbook_item.py -- adding a setter for description
- tableauserverclient/server/request_factory.py:
update class WorkbookRequest : _generate_xml : in the same method as other elements, add a description :
if workbook_item.description: workbook_element.attrib['description'] = workbook_item.description
add same code to procedure update_req.
This change allows a workbook description to be added at time of upload, preventing manual intervention after report promotions, migrations, or other automated processes.
The current REST API Workbooks Methods documentation does not include a description field in any publish or update methods, only in responses
That's correct: the description field is not settable through the API currently. I don't think there's a real reason for that, so I'll prod the team that owns that area.
Has the setter for description been added already? Could need it for a current project.
Has the status of this changed? The REST API currently allows workbook description to be set/changed in PUT.
