Skip to content

Add Documentation for Prep Flow classes and methods #729

Closed

Description

@thechadd

Hi!
Update: per comment below, verified FlowItem class and methods already exist. Updating this request for documentation of these items.
Original request:
Currently there is no FlowItem class and methods in TSC. Can we get that on the backlog (similar to DatasourceItem and WorkbookItem)? For now we have done a workaround using metadata api integration, but the code implementation was lengthy.

Cheers!
Chadd

Activity

  1. t8y8 commented on Nov 15, 2020

    @t8y8
    Contributor

    They do exist (and have for a little while), see: https://github.com/tableau/server-client-python/blob/master/tableauserverclient/models/flow_item.py for the item class, and there are flow endpoints as well

  2. thechadd commented on Nov 16, 2020

    @thechadd
    Author

    Oooh! Thanks! Can I update my request to get this into the documentation? 😄

  3. changed the title [-]Add support for FlowItem class and methods[/-] [+]Add Documentation for FlowItem class and methods[/+] on Nov 16, 2020
  4. changed the title [-]Add Documentation for FlowItem class and methods[/-] [+]Add Documentation for Prep Flow classes and methods[/+] on Nov 19, 2020
  5. bcantoni commented on Nov 19, 2020

    @bcantoni
    Contributor

    We'll use this issue to track adding the docs to match the code changes from #494

  6. self-assigned this
    on Jul 22, 2022
  7. github-actions commented on Aug 6, 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.

  8. github-actions commented on Aug 21, 2026

    @github-actions

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

  9. jacalata commented on Nov 12, 2026

    @jacalata
    Contributor

    The flow documentation this issue asked for is in the API reference now: the Flows section covers the FlowItem class and every flows.* method (get, get_by_id, publish, download, refresh, update, delete, connections, permissions, data quality warnings, schedule_flow_run, filter), and the Flow Runs section covers flow_runs.get, get_by_id, cancel, wait_for_job and filter. Closing as fixed.

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

Metadata

Metadata

Assignees

Labels

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions