Skip to content

docs: add Known server-side limitations section to api-ref.md #1842

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

Open
jacalata wants to merge 2 commits into
base: gh-pages
Choose a base branch
from
Open

docs: add Known server-side limitations section to api-ref.md #1842

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
88e00a0
docs: add Known server-side limitations section
jacalata Jul 30, 2026
f37c911
docs: drop internal work-item IDs and per-bullet fix-scope tag
jacalata Jul 30, 2026
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
44 changes: 43 additions & 1 deletion docs/api-ref.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ The Tableau Server Client (TSC) is a Python library for the Tableau Server REST
The TSC API reference is organized by resource. The TSC library is modeled after the REST API. The methods, for example, `workbooks.get()`, correspond to the endpoints for resources, such as [workbooks](#workbooks), [users](#users), [views](#views), and [data sources](#data-sources). The model classes (for example, the [WorkbookItem class](#workbookitem-class) have attributes that represent the fields (`name`, `id`, `owner_id`) that are in the REST API request and response packages, or payloads.

|:--- |
| **Note:** Some methods and features provided in the REST API might not be currently available in the TSC library (and in some cases, the opposite is true). In addition, the same limitations apply to the TSC library that apply to the REST API with respect to resources on Tableau Server and Tableau Cloud. For more information, see the [Tableau Server REST API Reference](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm).|
| **Note:** Some methods and features provided in the REST API might not be currently available in the TSC library (and in some cases, the opposite is true). In addition, the same limitations apply to the TSC library that apply to the REST API with respect to resources on Tableau Server and Tableau Cloud. For more information, see the [Tableau Server REST API Reference](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm). See also [Known server-side limitations](#known-server-side-limitations) below for behaviors that TSC cannot work around because they are constrained by the Tableau Server REST API itself.|



Expand Down Expand Up @@ -10957,3 +10957,45 @@ for wb in finance_workbooks:
<br>
<br>

---

## Known server-side limitations

Some behaviors you may hit while using TSC are not bugs in the TSC library. They are limitations of the Tableau Server REST API itself, and cannot be fixed in TSC alone. This section lists the currently-tracked server-side gaps so you can identify them quickly and follow the appropriate issues.

For the live, maintainer-updated view of these issues, filter open issues in this repository by the [`Server-Side Enhancement`](https://github.com/tableau/server-client-python/labels/Server-Side%20Enhancement) label.

Every item in this list requires a change in Tableau Server / Tableau Cloud before TSC can expose the behavior.

<br>

**View filter query parameters (`vf_`) support exact match only**
: The REST API's `vf_<field>=<value>` mechanism (used by `ImageRequestOptions.vf(...)`, `PDFRequestOptions.vf(...)`, `CSVRequestOptions.vf(...)`, and the `filter=` builder on view endpoints) accepts an exact value only. Operator prefixes (`gt:`, `lt:`, `in:`), wildcards, and range expressions are not supported by the server. Tracked in [#1431](https://github.com/tableau/server-client-python/issues/1431).

<br>

**`vf_` view filter is silently dropped when the server-side view already has an operator-based filter**
: If the underlying view definition includes a filter that uses an operator (for example, a range filter), a client-supplied `vf_` value on that same field can be silently ignored rather than layered on top. There is no error surfaced through the REST API.

<br>

**Daily extract-refresh schedules cannot be created via the REST API on Tableau Cloud**
: Creating an extract-refresh task on a daily schedule fails through the REST API (returns a 500), and the underlying Cloud scheduler has a separate bug where daily executes hourly. Tracked in [#1508](https://github.com/tableau/server-client-python/issues/1508).

<br>

**Subscriptions cannot use an "On Extract Refresh" schedule via the REST API**
: The "When data refreshes" (a.k.a. "On Extract Refresh") subscription trigger available in the Tableau UI has no equivalent in the REST API surface, so TSC cannot expose it. Tracked in [#1658](https://github.com/tableau/server-client-python/issues/1658).

<br>

**Flow thumbnail image is not generated when a flow is published via the REST API**
: A flow published through the REST API (and therefore through TSC's `flows.publish(...)`) is stored without a thumbnail image, whereas the same flow uploaded through the Tableau Prep UI receives one. Tracked in [#1537](https://github.com/tableau/server-client-python/issues/1537).

<br>

If you believe you have found another server-side limitation, please open an issue and mention this section so a maintainer can apply the `Server-Side Enhancement` label and add it to the list above.

<br>
<br>