Skip to content

Enhancement request: Support field return specifications #1255

Closed

Description

@ryanstryker

Summary

Allow users to specify the fields to be returned by endpoints as documented here: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_fields.htm

Request Type

Type 1: This behavior is already supported by API endpoints (though buggy in the case of all for some endpoints).

Description

Currently, only the default fields are returned. If more data is needed to populate attributes for a particular item, additional calls have to be made for individual users, workbooks, etc. This results in many unnecessary calls to the same endpoints.

An ancillary issue to this request is that there are (and may continue to be) attributes the API is a able return that the TSC models aren't aware of. There should be a generic way to retrieve values for named fields in the response.

Activity

  1. changed the title [-]Enhancement request: Support Field Return Specifications[/-] [+]Enhancement request: Support field return specifications[/+] on Jul 10, 2023
  2. github-actions commented on Aug 1, 2026

    @github-actions

    This issue has been automatically marked as stale because it has not had recent activity. It will be closed in 14 days if no further activity occurs. If this is still relevant, please comment to keep it open.

  3. github-actions commented on Aug 16, 2026

    @github-actions

    Closing due to inactivity. If this is still relevant, please reopen or file a new issue.

  4. jacalata commented on Aug 25, 2026

    @jacalata
    Contributor

    This is implemented — you can request specific fields via RequestOptions.fields.add(...) for known fields, or set RequestOptions.all_fields = True to request the full set (_all_ per the REST API). See RequestOptions in tableauserverclient/server/request_options.py. Not every endpoint's response parser handles every field yet, so if you hit a case where a field is returned by REST but not surfaced on the TSC model, that's a distinct issue worth filing separately.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions