OBJECT
Flow
Flows are used to prepare data, which can include aggregation, cleaning, preprocessing, etc.
link GraphQL Schema definition
- type Flow implements Warnable, CanHaveLabels, Taggable {
- # Unique identifier used by the metadata API. Not the same as the numeric ID used
- # on server
- ID! :
- # Name shown in server and desktop clients
- String :
- # Locally unique identifier used for the REST API on the Tableau Server
- String :
- # VizPortal URL ID; used for URL generation
- String! :
- # Time the flow was created. Available in Tableau Cloud June 2022 / Server 2022.3
- # and later.
- DateTime :
- # Time the flow was updated. Available in Tableau Cloud June 2022 / Server 2022.3
- # and later.
- DateTime :
- # The site in which the flow is visible and usable
- TableauSite :
- # The ID of the project in which the flow is visible and usable. Will be null if
- # the flow is not in a project.
- String :
- # The name of the project in which the flow is visible and usable
- String :
- # The link to the personal space in which the flow is visible and usable. Will be
- # null if the flow is not in a personal space.
- String :
- # The type of the container in which the flow is visible and usable. Either
- # personal space or project.
- String! :
- # The name of the container in which the flow is visible and usable. Either a
- # personal space or project.
- String :
- # User who owns this flow
- TableauUser :
- # Fields that are inputs to this flow
- #
- # Arguments
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- # permissionMode: Results filtering mode.
- (
- FlowInputField_Filter, :
- FlowInputFieldSortOrder, :
- PermissionMode :
- ): [FlowInputField!]!
- # Fields that are inputs to this flow
- #
- # Arguments
- # after: The cursor to receive the next page of objects. If no
- # cursor is supplied it will start at the beginning of the list. Offset can not be
- # set at the same time. This is the preferred API to use if possible as it is
- # faster.
- # first: Maximum number of objects to be returned in a page. The
- # default is 100
- # offset: The number of entries to offset the start of the page
- # by. If no offset is supplied it will start at the beginning of the list. After
- # can not be set at the same time.
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- # permissionMode: Results filtering mode.
- (
- String, :
- Int, :
- Int, :
- FlowInputField_Filter, :
- FlowInputFieldSortOrder, :
- PermissionMode :
- ): FlowInputFieldsConnection
- # Fields that are outputs of this flow
- #
- # Arguments
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- # permissionMode: Results filtering mode.
- (
- FlowOutputField_Filter, :
- FlowOutputFieldSortOrder, :
- PermissionMode :
- ): [FlowOutputField!]!
- # Fields that are outputs of this flow
- #
- # Arguments
- # after: The cursor to receive the next page of objects. If no
- # cursor is supplied it will start at the beginning of the list. Offset can not be
- # set at the same time. This is the preferred API to use if possible as it is
- # faster.
- # first: Maximum number of objects to be returned in a page. The
- # default is 100
- # offset: The number of entries to offset the start of the page
- # by. If no offset is supplied it will start at the beginning of the list. After
- # can not be set at the same time.
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- # permissionMode: Results filtering mode.
- (
- String, :
- Int, :
- Int, :
- FlowOutputField_Filter, :
- FlowOutputFieldSortOrder, :
- PermissionMode :
- ): FlowOutputFieldsConnection
- # Output steps for this flow
- #
- # Arguments
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- # permissionMode: Results filtering mode.
- (
- FlowOutputStep_Filter, :
- FlowOutputStepSortOrder, :
- PermissionMode :
- ): [FlowOutputStep!]!
- # Output steps for this flow
- #
- # Arguments
- # after: The cursor to receive the next page of objects. If no
- # cursor is supplied it will start at the beginning of the list. Offset can not be
- # set at the same time. This is the preferred API to use if possible as it is
- # faster.
- # first: Maximum number of objects to be returned in a page. The
- # default is 100
- # offset: The number of entries to offset the start of the page
- # by. If no offset is supplied it will start at the beginning of the list. After
- # can not be set at the same time.
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- # permissionMode: Results filtering mode.
- (
- String, :
- Int, :
- Int, :
- FlowOutputStep_Filter, :
- FlowOutputStepSortOrder, :
- PermissionMode :
- ): FlowOutputStepsConnection
- # Description of the flow
- String :
- # True if the flow has an active data quality warning
- Boolean! :
- # True if the flow contains unsupported custom SQL, in which case lineage may be
- # incomplete
- Boolean :
- # Locally unique identifier used for the REST API on the Tableau Server
- String! :
- # Tags associated with a flow
- #
- # Arguments
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- Tag_Filter, : TagSortOrder): [Tag!]! ( :
- # Tags associated with a flow
- #
- # Arguments
- # after: The cursor to receive the next page of objects. If no
- # cursor is supplied it will start at the beginning of the list. Offset can not be
- # set at the same time. This is the preferred API to use if possible as it is
- # faster.
- # first: Maximum number of objects to be returned in a page. The
- # default is 100
- # offset: The number of entries to offset the start of the page
- # by. If no offset is supplied it will start at the beginning of the list. After
- # can not be set at the same time.
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- (
- String, :
- Int, :
- Int, :
- Tag_Filter, :
- TagSortOrder :
- ): TagsConnection
- # The optional data quality warning on a flow
- DataQualityWarning @deprecated( reason: "Use 'dataQualityWarnings'" ) :
- # The data quality warnings on a flow
- #
- # Arguments
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- # permissionMode: Results filtering mode.
- (
- DataQualityWarning_Filter, :
- DataQualityWarningSortOrder, :
- PermissionMode :
- ): [DataQualityWarning!]!
- # The data quality warnings on a flow
- #
- # Arguments
- # after: The cursor to receive the next page of objects. If no
- # cursor is supplied it will start at the beginning of the list. Offset can not be
- # set at the same time. This is the preferred API to use if possible as it is
- # faster.
- # first: Maximum number of objects to be returned in a page. The
- # default is 100
- # offset: The number of entries to offset the start of the page
- # by. If no offset is supplied it will start at the beginning of the list. After
- # can not be set at the same time.
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- # permissionMode: Results filtering mode.
- (
- String, :
- Int, :
- Int, :
- DataQualityWarning_Filter, :
- DataQualityWarningSortOrder, :
- PermissionMode :
- ): DataQualityWarningsConnection
- # The labels on a flow. Available in Tableau Cloud March 2023 / Server 2023.1 and
- # later.
- #
- # Arguments
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- # permissionMode: Results filtering mode.
- (
- Label_Filter, :
- LabelSortOrder, :
- PermissionMode :
- ): [Label!]!
- # The labels on a flow. Available in Tableau Cloud March 2023 / Server 2023.1 and
- # later.
- #
- # Arguments
- # after: The cursor to receive the next page of objects. If no
- # cursor is supplied it will start at the beginning of the list. Offset can not be
- # set at the same time. This is the preferred API to use if possible as it is
- # faster.
- # first: Maximum number of objects to be returned in a page. The
- # default is 100
- # offset: The number of entries to offset the start of the page
- # by. If no offset is supplied it will start at the beginning of the list. After
- # can not be set at the same time.
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- # permissionMode: Results filtering mode.
- (
- String, :
- Int, :
- Int, :
- Label_Filter, :
- LabelSortOrder, :
- PermissionMode :
- ): LabelsConnection
- # Data quality warnings upstream from this flow
- #
- # Arguments
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- # permissionMode: Results filtering mode.
- (
- DataQualityWarning_Filter, :
- DataQualityWarningSortOrder, :
- PermissionMode :
- ): [DataQualityWarning!]!
- # Data quality warnings upstream from this flow
- #
- # Arguments
- # after: The cursor to receive the next page of objects. If no
- # cursor is supplied it will start at the beginning of the list. Offset can not be
- # set at the same time. This is the preferred API to use if possible as it is
- # faster.
- # first: Maximum number of objects to be returned in a page. The
- # default is 100
- # offset: The number of entries to offset the start of the page
- # by. If no offset is supplied it will start at the beginning of the list. After
- # can not be set at the same time.
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- # permissionMode: Results filtering mode.
- (
- String, :
- Int, :
- Int, :
- DataQualityWarning_Filter, :
- DataQualityWarningSortOrder, :
- PermissionMode :
- ): DataQualityWarningsConnection
- # Labels upstream from this flow. Available in Tableau Cloud March 2023 / Server
- # 2023.1 and later.
- #
- # Arguments
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- # permissionMode: Results filtering mode.
- (
- Label_Filter, :
- LabelSortOrder, :
- PermissionMode :
- ): [Label!]!
- # Labels upstream from this flow. Available in Tableau Cloud March 2023 / Server
- # 2023.1 and later.
- #
- # Arguments
- # after: The cursor to receive the next page of objects. If no
- # cursor is supplied it will start at the beginning of the list. Offset can not be
- # set at the same time. This is the preferred API to use if possible as it is
- # faster.
- # first: Maximum number of objects to be returned in a page. The
- # default is 100
- # offset: The number of entries to offset the start of the page
- # by. If no offset is supplied it will start at the beginning of the list. After
- # can not be set at the same time.
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- # permissionMode: Results filtering mode.
- (
- String, :
- Int, :
- Int, :
- Label_Filter, :
- LabelSortOrder, :
- PermissionMode :
- ): LabelsConnection
- # Databases that are upstream from this flow.
- #
- # Arguments
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- # permissionMode: Results filtering mode.
- (
- Database_Filter, :
- DatabaseSortOrder, :
- PermissionMode :
- ): [Database!]!
- # Databases that are upstream from this flow.
- #
- # Arguments
- # after: The cursor to receive the next page of objects. If no
- # cursor is supplied it will start at the beginning of the list. Offset can not be
- # set at the same time. This is the preferred API to use if possible as it is
- # faster.
- # first: Maximum number of objects to be returned in a page. The
- # default is 100
- # offset: The number of entries to offset the start of the page
- # by. If no offset is supplied it will start at the beginning of the list. After
- # can not be set at the same time.
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- # permissionMode: Results filtering mode.
- (
- String, :
- Int, :
- Int, :
- Database_Filter, :
- DatabaseSortOrder, :
- PermissionMode :
- ): DatabasesConnection
- # Tables that are upstream from this flow.
- #
- # Arguments
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- # permissionMode: Results filtering mode.
- (
- DatabaseTable_Filter, :
- DatabaseTableSortOrder, :
- PermissionMode :
- ): [DatabaseTable!]!
- # Tables that are upstream from this flow.
- #
- # Arguments
- # after: The cursor to receive the next page of objects. If no
- # cursor is supplied it will start at the beginning of the list. Offset can not be
- # set at the same time. This is the preferred API to use if possible as it is
- # faster.
- # first: Maximum number of objects to be returned in a page. The
- # default is 100
- # offset: The number of entries to offset the start of the page
- # by. If no offset is supplied it will start at the beginning of the list. After
- # can not be set at the same time.
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- # permissionMode: Results filtering mode.
- (
- String, :
- Int, :
- Int, :
- DatabaseTable_Filter, :
- DatabaseTableSortOrder, :
- PermissionMode :
- ): DatabaseTablesConnection
- # Flows that are upstream from this flow.
- #
- # Arguments
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- # permissionMode: Results filtering mode.
- (
- Flow_Filter, :
- FlowSortOrder, :
- PermissionMode :
- ): [Flow!]!
- # Flows that are upstream from this flow.
- #
- # Arguments
- # after: The cursor to receive the next page of objects. If no
- # cursor is supplied it will start at the beginning of the list. Offset can not be
- # set at the same time. This is the preferred API to use if possible as it is
- # faster.
- # first: Maximum number of objects to be returned in a page. The
- # default is 100
- # offset: The number of entries to offset the start of the page
- # by. If no offset is supplied it will start at the beginning of the list. After
- # can not be set at the same time.
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- # permissionMode: Results filtering mode.
- (
- String, :
- Int, :
- Int, :
- Flow_Filter, :
- FlowSortOrder, :
- PermissionMode :
- ): FlowsConnection
- # Datasources that are upstream from this flow.
- #
- # Arguments
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- # permissionMode: Results filtering mode.
- (
- PublishedDatasource_Filter, :
- PublishedDatasourceSortOrder, :
- PermissionMode :
- ): [PublishedDatasource!]!
- # Datasources that are upstream from this flow.
- #
- # Arguments
- # after: The cursor to receive the next page of objects. If no
- # cursor is supplied it will start at the beginning of the list. Offset can not be
- # set at the same time. This is the preferred API to use if possible as it is
- # faster.
- # first: Maximum number of objects to be returned in a page. The
- # default is 100
- # offset: The number of entries to offset the start of the page
- # by. If no offset is supplied it will start at the beginning of the list. After
- # can not be set at the same time.
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- # permissionMode: Results filtering mode.
- (
- String, :
- Int, :
- Int, :
- PublishedDatasource_Filter, :
- PublishedDatasourceSortOrder, :
- PermissionMode :
- ): PublishedDatasourcesConnection
- # Flows that are downstream from this flow.
- #
- # Arguments
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- # permissionMode: Results filtering mode.
- (
- Flow_Filter, :
- FlowSortOrder, :
- PermissionMode :
- ): [Flow!]!
- # Flows that are downstream from this flow.
- #
- # Arguments
- # after: The cursor to receive the next page of objects. If no
- # cursor is supplied it will start at the beginning of the list. Offset can not be
- # set at the same time. This is the preferred API to use if possible as it is
- # faster.
- # first: Maximum number of objects to be returned in a page. The
- # default is 100
- # offset: The number of entries to offset the start of the page
- # by. If no offset is supplied it will start at the beginning of the list. After
- # can not be set at the same time.
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- # permissionMode: Results filtering mode.
- (
- String, :
- Int, :
- Int, :
- Flow_Filter, :
- FlowSortOrder, :
- PermissionMode :
- ): FlowsConnection
- # Flows that are next immediate downstream from this flow.
- #
- # Arguments
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- # permissionMode: Results filtering mode.
- (
- Flow_Filter, :
- FlowSortOrder, :
- PermissionMode :
- ): [Flow!]!
- # Flows that are next immediate downstream from this flow.
- #
- # Arguments
- # after: The cursor to receive the next page of objects. If no
- # cursor is supplied it will start at the beginning of the list. Offset can not be
- # set at the same time. This is the preferred API to use if possible as it is
- # faster.
- # first: Maximum number of objects to be returned in a page. The
- # default is 100
- # offset: The number of entries to offset the start of the page
- # by. If no offset is supplied it will start at the beginning of the list. After
- # can not be set at the same time.
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- # permissionMode: Results filtering mode.
- (
- String, :
- Int, :
- Int, :
- Flow_Filter, :
- FlowSortOrder, :
- PermissionMode :
- ): FlowsConnection
- # Linked flows that are downstream from this flow.
- #
- # Arguments
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- # permissionMode: Results filtering mode.
- (
- LinkedFlow_Filter, :
- LinkedFlowSortOrder, :
- PermissionMode :
- ): [LinkedFlow!]!
- # Linked flows that are downstream from this flow.
- #
- # Arguments
- # after: The cursor to receive the next page of objects. If no
- # cursor is supplied it will start at the beginning of the list. Offset can not be
- # set at the same time. This is the preferred API to use if possible as it is
- # faster.
- # first: Maximum number of objects to be returned in a page. The
- # default is 100
- # offset: The number of entries to offset the start of the page
- # by. If no offset is supplied it will start at the beginning of the list. After
- # can not be set at the same time.
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- # permissionMode: Results filtering mode.
- (
- String, :
- Int, :
- Int, :
- LinkedFlow_Filter, :
- LinkedFlowSortOrder, :
- PermissionMode :
- ): LinkedFlowsConnection
- # Linked flows that are upstream from this flow.
- #
- # Arguments
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- # permissionMode: Results filtering mode.
- (
- LinkedFlow_Filter, :
- LinkedFlowSortOrder, :
- PermissionMode :
- ): [LinkedFlow!]!
- # Linked flows that are upstream from this flow.
- #
- # Arguments
- # after: The cursor to receive the next page of objects. If no
- # cursor is supplied it will start at the beginning of the list. Offset can not be
- # set at the same time. This is the preferred API to use if possible as it is
- # faster.
- # first: Maximum number of objects to be returned in a page. The
- # default is 100
- # offset: The number of entries to offset the start of the page
- # by. If no offset is supplied it will start at the beginning of the list. After
- # can not be set at the same time.
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- # permissionMode: Results filtering mode.
- (
- String, :
- Int, :
- Int, :
- LinkedFlow_Filter, :
- LinkedFlowSortOrder, :
- PermissionMode :
- ): LinkedFlowsConnection
- # Published Data Sources that are downstream from this flow.
- #
- # Arguments
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- # permissionMode: Results filtering mode.
- (
- PublishedDatasource_Filter, :
- PublishedDatasourceSortOrder, :
- PermissionMode :
- ): [PublishedDatasource!]!
- # Published Data Sources that are downstream from this flow.
- #
- # Arguments
- # after: The cursor to receive the next page of objects. If no
- # cursor is supplied it will start at the beginning of the list. Offset can not be
- # set at the same time. This is the preferred API to use if possible as it is
- # faster.
- # first: Maximum number of objects to be returned in a page. The
- # default is 100
- # offset: The number of entries to offset the start of the page
- # by. If no offset is supplied it will start at the beginning of the list. After
- # can not be set at the same time.
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- # permissionMode: Results filtering mode.
- (
- String, :
- Int, :
- Int, :
- PublishedDatasource_Filter, :
- PublishedDatasourceSortOrder, :
- PermissionMode :
- ): PublishedDatasourcesConnection
- # Lenses that are downstream from this flow
- #
- # Arguments
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- # permissionMode: Results filtering mode.
- (
- Lens_Filter, :
- LensSortOrder, :
- PermissionMode :
- ): [Lens!]!
- # Lenses that are downstream from this flow
- #
- # Arguments
- # after: The cursor to receive the next page of objects. If no
- # cursor is supplied it will start at the beginning of the list. Offset can not be
- # set at the same time. This is the preferred API to use if possible as it is
- # faster.
- # first: Maximum number of objects to be returned in a page. The
- # default is 100
- # offset: The number of entries to offset the start of the page
- # by. If no offset is supplied it will start at the beginning of the list. After
- # can not be set at the same time.
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- # permissionMode: Results filtering mode.
- (
- String, :
- Int, :
- Int, :
- Lens_Filter, :
- LensSortOrder, :
- PermissionMode :
- ): LensesConnection
- # Databases that are downstream from this flow.
- #
- # Arguments
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- # permissionMode: Results filtering mode.
- (
- Database_Filter, :
- DatabaseSortOrder, :
- PermissionMode :
- ): [Database!]!
- # Databases that are downstream from this flow.
- #
- # Arguments
- # after: The cursor to receive the next page of objects. If no
- # cursor is supplied it will start at the beginning of the list. Offset can not be
- # set at the same time. This is the preferred API to use if possible as it is
- # faster.
- # first: Maximum number of objects to be returned in a page. The
- # default is 100
- # offset: The number of entries to offset the start of the page
- # by. If no offset is supplied it will start at the beginning of the list. After
- # can not be set at the same time.
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- # permissionMode: Results filtering mode.
- (
- String, :
- Int, :
- Int, :
- Database_Filter, :
- DatabaseSortOrder, :
- PermissionMode :
- ): DatabasesConnection
- # Tables that are downstream from this flow.
- #
- # Arguments
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- # permissionMode: Results filtering mode.
- (
- DatabaseTable_Filter, :
- DatabaseTableSortOrder, :
- PermissionMode :
- ): [DatabaseTable!]!
- # Tables that are downstream from this flow.
- #
- # Arguments
- # after: The cursor to receive the next page of objects. If no
- # cursor is supplied it will start at the beginning of the list. Offset can not be
- # set at the same time. This is the preferred API to use if possible as it is
- # faster.
- # first: Maximum number of objects to be returned in a page. The
- # default is 100
- # offset: The number of entries to offset the start of the page
- # by. If no offset is supplied it will start at the beginning of the list. After
- # can not be set at the same time.
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- # permissionMode: Results filtering mode.
- (
- String, :
- Int, :
- Int, :
- DatabaseTable_Filter, :
- DatabaseTableSortOrder, :
- PermissionMode :
- ): DatabaseTablesConnection
- # Workbooks that are downstream from this flow
- #
- # Arguments
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- # permissionMode: Results filtering mode.
- (
- Workbook_Filter, :
- WorkbookSortOrder, :
- PermissionMode :
- ): [Workbook!]!
- # Workbooks that are downstream from this flow
- #
- # Arguments
- # after: The cursor to receive the next page of objects. If no
- # cursor is supplied it will start at the beginning of the list. Offset can not be
- # set at the same time. This is the preferred API to use if possible as it is
- # faster.
- # first: Maximum number of objects to be returned in a page. The
- # default is 100
- # offset: The number of entries to offset the start of the page
- # by. If no offset is supplied it will start at the beginning of the list. After
- # can not be set at the same time.
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- # permissionMode: Results filtering mode.
- (
- String, :
- Int, :
- Int, :
- Workbook_Filter, :
- WorkbookSortOrder, :
- PermissionMode :
- ): WorkbooksConnection
- # Dashboards that are downstream from this flow
- #
- # Arguments
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- # permissionMode: Results filtering mode.
- (
- Dashboard_Filter, :
- DashboardSortOrder, :
- PermissionMode :
- ): [Dashboard!]!
- # Dashboards that are downstream from this flow
- #
- # Arguments
- # after: The cursor to receive the next page of objects. If no
- # cursor is supplied it will start at the beginning of the list. Offset can not be
- # set at the same time. This is the preferred API to use if possible as it is
- # faster.
- # first: Maximum number of objects to be returned in a page. The
- # default is 100
- # offset: The number of entries to offset the start of the page
- # by. If no offset is supplied it will start at the beginning of the list. After
- # can not be set at the same time.
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- # permissionMode: Results filtering mode.
- (
- String, :
- Int, :
- Int, :
- Dashboard_Filter, :
- DashboardSortOrder, :
- PermissionMode :
- ): DashboardsConnection
- # Sheets that are downstream from this flow
- #
- # Arguments
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- # permissionMode: Results filtering mode.
- (
- Sheet_Filter, :
- SheetSortOrder, :
- PermissionMode :
- ): [Sheet!]!
- # Sheets that are downstream from this flow
- #
- # Arguments
- # after: The cursor to receive the next page of objects. If no
- # cursor is supplied it will start at the beginning of the list. Offset can not be
- # set at the same time. This is the preferred API to use if possible as it is
- # faster.
- # first: Maximum number of objects to be returned in a page. The
- # default is 100
- # offset: The number of entries to offset the start of the page
- # by. If no offset is supplied it will start at the beginning of the list. After
- # can not be set at the same time.
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- # permissionMode: Results filtering mode.
- (
- String, :
- Int, :
- Int, :
- Sheet_Filter, :
- SheetSortOrder, :
- PermissionMode :
- ): SheetsConnection
- # Metrics that are downstream from this flow
- #
- # Arguments
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- # permissionMode: Results filtering mode.
- (
- Metric_Filter, :
- MetricSortOrder, :
- PermissionMode :
- ): [Metric!]!
- # Metrics that are downstream from this flow
- #
- # Arguments
- # after: The cursor to receive the next page of objects. If no
- # cursor is supplied it will start at the beginning of the list. Offset can not be
- # set at the same time. This is the preferred API to use if possible as it is
- # faster.
- # first: Maximum number of objects to be returned in a page. The
- # default is 100
- # offset: The number of entries to offset the start of the page
- # by. If no offset is supplied it will start at the beginning of the list. After
- # can not be set at the same time.
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- # permissionMode: Results filtering mode.
- (
- String, :
- Int, :
- Int, :
- Metric_Filter, :
- MetricSortOrder, :
- PermissionMode :
- ): MetricsConnection
- # VirtualConnections that are downstream of this flow
- #
- # Arguments
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- # permissionMode: Results filtering mode.
- (
- VirtualConnection_Filter, :
- VirtualConnectionSortOrder, :
- PermissionMode :
- ): [VirtualConnection!]!
- # VirtualConnections that are downstream of this flow
- #
- # Arguments
- # after: The cursor to receive the next page of objects. If no
- # cursor is supplied it will start at the beginning of the list. Offset can not be
- # set at the same time. This is the preferred API to use if possible as it is
- # faster.
- # first: Maximum number of objects to be returned in a page. The
- # default is 100
- # offset: The number of entries to offset the start of the page
- # by. If no offset is supplied it will start at the beginning of the list. After
- # can not be set at the same time.
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- # permissionMode: Results filtering mode.
- (
- String, :
- Int, :
- Int, :
- VirtualConnection_Filter, :
- VirtualConnectionSortOrder, :
- PermissionMode :
- ): VirtualConnectionsConnection
- # VirtualConnectionTables that are downstream of this flow
- #
- # Arguments
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- # permissionMode: Results filtering mode.
- (
- VirtualConnectionTable_Filter, :
- VirtualConnectionTableSortOrder, :
- PermissionMode :
- ): [VirtualConnectionTable!]!
- # VirtualConnectionTables that are downstream of this flow
- #
- # Arguments
- # after: The cursor to receive the next page of objects. If no
- # cursor is supplied it will start at the beginning of the list. Offset can not be
- # set at the same time. This is the preferred API to use if possible as it is
- # faster.
- # first: Maximum number of objects to be returned in a page. The
- # default is 100
- # offset: The number of entries to offset the start of the page
- # by. If no offset is supplied it will start at the beginning of the list. After
- # can not be set at the same time.
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- # permissionMode: Results filtering mode.
- (
- String, :
- Int, :
- Int, :
- VirtualConnectionTable_Filter, :
- VirtualConnectionTableSortOrder, :
- PermissionMode :
- ): VirtualConnectionTablesConnection
- # Owners that are downstream from this flow
- #
- # Arguments
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- (
- TableauUser_Filter, :
- TableauUserSortOrder :
- ): [TableauUser!]!
- # Owners that are downstream from this flow
- #
- # Arguments
- # after: The cursor to receive the next page of objects. If no
- # cursor is supplied it will start at the beginning of the list. Offset can not be
- # set at the same time. This is the preferred API to use if possible as it is
- # faster.
- # first: Maximum number of objects to be returned in a page. The
- # default is 100
- # offset: The number of entries to offset the start of the page
- # by. If no offset is supplied it will start at the beginning of the list. After
- # can not be set at the same time.
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- (
- String, :
- Int, :
- Int, :
- TableauUser_Filter, :
- TableauUserSortOrder :
- ): TableauUsersConnection
- # Flows that are next immediate upstream from this flow.
- #
- # Arguments
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- # permissionMode: Results filtering mode.
- (
- Flow_Filter, :
- FlowSortOrder, :
- PermissionMode :
- ): [Flow]!
- # Flows that are next immediate upstream from this flow.
- #
- # Arguments
- # after: The cursor to receive the next page of objects. If no
- # cursor is supplied it will start at the beginning of the list. Offset can not be
- # set at the same time. This is the preferred API to use if possible as it is
- # faster.
- # first: Maximum number of objects to be returned in a page. The
- # default is 100
- # offset: The number of entries to offset the start of the page
- # by. If no offset is supplied it will start at the beginning of the list. After
- # can not be set at the same time.
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- # permissionMode: Results filtering mode.
- (
- String, :
- Int, :
- Int, :
- Flow_Filter, :
- FlowSortOrder, :
- PermissionMode :
- ): FlowsConnection
- # The virtual connection upstream to this Flow
- #
- # Arguments
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- (
- VirtualConnection_Filter, :
- VirtualConnectionSortOrder :
- ): [VirtualConnection]
- # The virtual connection upstream to this Flow
- #
- # Arguments
- # after: The cursor to receive the next page of objects. If no
- # cursor is supplied it will start at the beginning of the list. Offset can not be
- # set at the same time. This is the preferred API to use if possible as it is
- # faster.
- # first: Maximum number of objects to be returned in a page. The
- # default is 100
- # offset: The number of entries to offset the start of the page
- # by. If no offset is supplied it will start at the beginning of the list. After
- # can not be set at the same time.
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- (
- String, :
- Int, :
- Int, :
- VirtualConnection_Filter, :
- VirtualConnectionSortOrder :
- ): VirtualConnectionsConnection
- # The virtual connection table upstream to this Flow
- #
- # Arguments
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- # permissionMode: Results filtering mode.
- (
- VirtualConnectionTable_Filter, :
- VirtualConnectionTableSortOrder, :
- PermissionMode :
- ): [VirtualConnectionTable]!
- # The virtual connection table upstream to this Flow
- #
- # Arguments
- # after: The cursor to receive the next page of objects. If no
- # cursor is supplied it will start at the beginning of the list. Offset can not be
- # set at the same time. This is the preferred API to use if possible as it is
- # faster.
- # first: Maximum number of objects to be returned in a page. The
- # default is 100
- # offset: The number of entries to offset the start of the page
- # by. If no offset is supplied it will start at the beginning of the list. After
- # can not be set at the same time.
- # filter: Filter by GraphQL field and given value
- # orderBy: Sort by given fields. The sort orders defined first in
- # the list will take priority. If there are no given sort orders or a tie on the
- # final sorted field then the resulting set will be sorted by ID in ascending
- # order.
- # permissionMode: Results filtering mode.
- (
- String, :
- Int, :
- Int, :
- VirtualConnectionTable_Filter, :
- VirtualConnectionTableSortOrder, :
- PermissionMode :
- ): VirtualConnectionTablesConnection
- }
link Require by
- BinFieldGraphQL type for a binned continuous measure field. See https://onlinehelp.tableau.com/current/pro/desktop/en-us/calculations_bins.html
- CalculatedFieldGraphQL type for a calculated field. See https://onlinehelp.tableau.com/current/pro/desktop/en-us/calculations_calculatedfields.html
- CloudFile cloud file connection
- ColumnGraphQL type for a table column
- ColumnFieldColumnFields are a type of field which directly connects to a column in some type of table.
- CombinedFieldGraphQL type for a combined field. Combined fields concatanate fields together into one string.
- CombinedSetFieldGraphQL type for a combined set field. See https://onlinehelp.tableau.com/current/pro/desktop/en-us/sortgroup_sets_create.html#Combine
- CustomSQLTable table that represents the result of evaluating a custom SQL query. These "tables" are owned by the Tableau data source (embedded or published) which contains the SQL query, so they only exist within that data source.
- Dashboard dashboard contained in a published workbook.
- Database database containing tables
- DatabaseServer database server connection
- DatabaseTable table that is contained in a database
- DatasourceFieldGraphQL type for a data source field. Data source fields can only exist in embedded data sources which connect to a published data source. A data source field is an embedded data source's 'layered' representation of a field that already exists in the published data source and is mostly a copy of the field in the published data source. Data source fields can get their own descriptions and renames local to the embedded data source, but cannot otherwise be modified in the embedded data source.
- EmbeddedDatasource data source embedded in a workbook
- FieldBase GraphQL type for a field
- FieldReferencingFieldBase GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula.
- File file connection
- FlowFlows are used to prepare data, which can include aggregation, cleaning, preprocessing, etc.
- FlowColumnInputFieldColumn input field implementation
- FlowColumnOutputFieldColumn output field implementation
- FlowFieldInputFieldField input field implementation
- FlowFieldOutputFieldField output field implementation
- FlowInputField wrapper for an input field contained in a published flow.
- FlowOutputField wrapper for an output field contained in a published flow.
- FlowOutputStep flow output step
- FlowsConnectionConnection Type for Flow
- GroupFieldGraphQL type for a group field. See https://onlinehelp.tableau.com/current/pro/desktop/en-us/sortgroup_groups_creating.html
- HierarchyFieldGraphQL type for a hierarchy. See https://onlinehelp.tableau.com/current/pro/desktop/en-us/qs_hierarchies.html
- LensLenses are curated, embeddable Ask Data experiences. *Available in Tableau Cloud June 2022 / Server 2022.3 and later.*
- LinkedFlowWrapper type including edge information
- MetricMetrics are time series data constructed from fields contained in views.
- PublishedDatasource Tableau data source that has been published separately to Tableau Server. It can be used by multiple workbooks.
- QueryQuery root for Metadata GraphQL interface
- SetFieldGraphQL type for a set field. See https://onlinehelp.tableau.com/current/pro/desktop/en-us/sortgroup_sets_create.html
- Sheet sheet contained in a published workbook.
- Table table containing columns
- TableauSiteSite on Tableau server
- TableauUserUser on a site on Tableau server
- Tag tag associated with content items
- VirtualConnectionVirtual connections are sharable central access points to data. *Available in Tableau Cloud March 2022 / Server 2022.1 and later.*
- VirtualConnectionTableA table in a virtual connection. *Available in Tableau Cloud March 2022 / Server 2022.1 and later.*
- WebDataConnector web data connector
- WorkbookWorkbooks are used to package up Tableau visualizations (which are called "sheets" in the Metadata API) and data models (which are called "embedded data sources" when they are owned by a workbook).