--- schema_version: "1" id: 8a0cf1bffd37f6e0e59cafb53e07ecf81ebf89196b017e8b6b7170ebd94b4224 title: VirtualConnection collection: tableau version: next locale: en-us portal_url: https://docs.salesforce.com/tableau/next/en-us/api/metadata_api/reference/virtualconnection.doc.md canonical_url: https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/virtualconnection.doc.html source_site: help.tableau.com content_type: documentation content_hash: 43e746a8243b4decd4190975ca3bb58c12ca3f89be249080f53c880afa21d382 --- _menu_ Types OBJECT # VirtualConnection A virtual connection. _Available in Tableau Cloud March 2022 / Server 2022.1 and later._ ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type VirtualConnection implements [Certifiable](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/certifiable.doc.html), [Warnable](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/warnable.doc.html), [CanHaveLabels](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/canhavelabels.doc.html), [Taggable](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/taggable.doc.html) { - # Connection type of this virtual connection - connectionType: [String](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/string.doc.html) @deprecated( reason: "Returns 'null' in Tableau Cloud December 2022 / Server 2023.1 and later, and may be removed in a future release. Use 'connectionType' of 'upstreamDatabases' instead." ) - # The tables exposed by this virtual connection - # - # 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. - tables( - filter: [VirtualConnectionTable_Filter](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnectionTable](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/virtualconnectiontable.doc.html)!]! - # The tables exposed by this virtual connection - # - # 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. - tablesConnection( - after: [String](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnectionTable_Filter](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionTablesConnection](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/virtualconnectiontablesconnection.doc.html) - # Unique identifier used by the metadata API. Not the same as the numeric ID used - # on server - id: [ID](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/id.doc.html)! - # Vizportal ID of this table, for use in client-to-server communications - vizportalId: [String](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/string.doc.html)! - # Vizportal URL ID; used for URL generation - vizportalUrlId: [String](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/string.doc.html)! - # Uri of the virtual connection - uri: [String](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/string.doc.html) - # Locally unique identifier used for the REST API on the Tableau Server - luid: [String](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/string.doc.html)! - # Name shown in server and desktop clients - name: [String](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/string.doc.html) - # Time the Virtual Connection was created. Available in Tableau Cloud June 2022 / - # Server 2022.3 and later. - createdAt: [DateTime](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/datetime.doc.html) - # Time the Virtual Connection was last updated. Available in Tableau Cloud June - # 2022 / Server 2022.3 and later. - updatedAt: [DateTime](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/datetime.doc.html) - # The site which contains this virtual connection - site: [TableauSite](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/tableausite.doc.html)! - # The ID of the project in which the virtual connection is visible and usable. - # Will return null if the published virtual connection is not in a project. - projectVizportalUrlId: [String](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/string.doc.html) - # The name of the project that contains this virtual connection. - projectName: [String](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/string.doc.html) - # The type of the container in which the virtual connection is visible and usable. - # Either personal space or project. - containerType: [String](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/string.doc.html)! - # The name of the container in which the virtual connection is visible and usable. - # Either a personal space or project. - containerName: [String](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/string.doc.html) - # User modifiable description of this virtual connection - description: [String](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/string.doc.html) - # User who owns this virtual connection - owner: [TableauUser](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/tableauuser.doc.html)! - # True if the virtual connection has an active data quality warning - hasActiveWarning: [Boolean](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/boolean.doc.html)! - # Singular data quality warning, deprecated but required to implement @warnable - dataQualityWarning: [DataQualityWarning](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/dataqualitywarning.doc.html) @deprecated( reason: "Use 'dataQualityWarnings'" ) - # The data quality warnings on a virtual connection - # - # 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. - dataQualityWarnings( - filter: [DataQualityWarning_Filter](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/dataqualitywarning_filter.doc.html), - orderBy: [DataQualityWarningSortOrder](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/dataqualitywarningsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DataQualityWarning](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/dataqualitywarning.doc.html)!]! - # The data quality warnings on a virtual connection - # - # 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. - dataQualityWarningsConnection( - after: [String](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/int.doc.html), - filter: [DataQualityWarning_Filter](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/dataqualitywarning_filter.doc.html), - orderBy: [DataQualityWarningSortOrder](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/dataqualitywarningsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DataQualityWarningsConnection](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/dataqualitywarningsconnection.doc.html) - # The data quality certifications on a virtual connection - # - # 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. - dataQualityCertifications( - filter: [DataQualityCertification_Filter](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/dataqualitycertification_filter.doc.html), - orderBy: [DataQualityCertificationSortOrder](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/dataqualitycertificationsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DataQualityCertification](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/dataqualitycertification.doc.html)!]! - # The data quality certifications on a virtual connection - # - # 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. - dataQualityCertificationsConnection( - after: [String](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/int.doc.html), - filter: [DataQualityCertification_Filter](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/dataqualitycertification_filter.doc.html), - orderBy: [DataQualityCertificationSortOrder](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/dataqualitycertificationsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DataQualityCertificationsConnection](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/dataqualitycertificationsconnection.doc.html) - # The labels on a virtual connection. 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. - labels( - filter: [Label_Filter](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/label_filter.doc.html), - orderBy: [LabelSortOrder](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/labelsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Label](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/label.doc.html)!]! - # The labels on a virtual connection. 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. - labelsConnection( - after: [String](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/int.doc.html), - filter: [Label_Filter](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/label_filter.doc.html), - orderBy: [LabelSortOrder](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/labelsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [LabelsConnection](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/labelsconnection.doc.html) - # True if this virtual connection contains an active data quality certification - isCertified: [Boolean](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/boolean.doc.html)! - # Tags associated with the virtual connection - # - # 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. - tags(filter: [Tag_Filter](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/tag_filter.doc.html), orderBy: [TagSortOrder](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/tagsortorder.doc.html)): [[Tag](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/tag.doc.html)!]! - # Tags associated with the virtual connection - # - # 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. - tagsConnection( - after: [String](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/int.doc.html), - filter: [Tag_Filter](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/tag_filter.doc.html), - orderBy: [TagSortOrder](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/tagsortorder.doc.html) - ): [TagsConnection](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/tagsconnection.doc.html) - # Databases upstream of this virtual connection - # - # 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. - upstreamDatabases( - filter: [Database_Filter](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Database](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/database.doc.html)!]! - # Databases upstream of this virtual connection - # - # 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. - upstreamDatabasesConnection( - after: [String](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/int.doc.html), - filter: [Database_Filter](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabasesConnection](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/databasesconnection.doc.html) - # Tables upstream of this virtual connection - # - # 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. - upstreamTables( - filter: [DatabaseTable_Filter](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DatabaseTable](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/databasetable.doc.html)!]! - # Tables upstream of this virtual connection - # - # 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. - upstreamTablesConnection( - after: [String](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/int.doc.html), - filter: [DatabaseTable_Filter](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabaseTablesConnection](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/databasetablesconnection.doc.html) - # The virtual connection tables that are upstream to this virtual connection - # - # 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. - upstreamVirtualConnectionTables( - filter: [VirtualConnectionTable_Filter](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnectionTable](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/virtualconnectiontable.doc.html)!]! - # The virtual connection tables that are upstream to this virtual connection - # - # 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. - upstreamVirtualConnectionTablesConnection( - after: [String](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnectionTable_Filter](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionTablesConnection](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/virtualconnectiontablesconnection.doc.html) - # Flows upstream of this virtual connection - # - # 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. - upstreamFlows( - filter: [Flow_Filter](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Flow](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/flow.doc.html)!]! - # Flows upstream of this virtual connection - # - # 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. - upstreamFlowsConnection( - after: [String](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/int.doc.html), - filter: [Flow_Filter](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FlowsConnection](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/flowsconnection.doc.html) - # Datasources upstream of this virtual connection - # - # 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. - upstreamDatasources( - filter: [PublishedDatasource_Filter](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[PublishedDatasource](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/publisheddatasource.doc.html)!]! - # Datasources upstream of this virtual connection - # - # 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. - upstreamDatasourcesConnection( - after: [String](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/int.doc.html), - filter: [PublishedDatasource_Filter](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [PublishedDatasourcesConnection](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/publisheddatasourcesconnection.doc.html) - # Data quality warnings upstream from this virtual connection - # - # 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. - upstreamDataQualityWarnings( - filter: [DataQualityWarning_Filter](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/dataqualitywarning_filter.doc.html), - orderBy: [DataQualityWarningSortOrder](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/dataqualitywarningsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DataQualityWarning](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/dataqualitywarning.doc.html)!]! - # Data quality warnings upstream from this virtual connection - # - # 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. - upstreamDataQualityWarningsConnection( - after: [String](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/int.doc.html), - filter: [DataQualityWarning_Filter](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/dataqualitywarning_filter.doc.html), - orderBy: [DataQualityWarningSortOrder](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/dataqualitywarningsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DataQualityWarningsConnection](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/dataqualitywarningsconnection.doc.html) - # Labels upstream from this virtual connection. 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. - upstreamLabels( - filter: [Label_Filter](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/label_filter.doc.html), - orderBy: [LabelSortOrder](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/labelsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Label](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/label.doc.html)!]! - # Labels upstream from this virtual connection. 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. - upstreamLabelsConnection( - after: [String](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/int.doc.html), - filter: [Label_Filter](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/label_filter.doc.html), - orderBy: [LabelSortOrder](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/labelsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [LabelsConnection](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/labelsconnection.doc.html) - # Flows downstream of this virtual connection - # - # 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. - downstreamFlows( - filter: [Flow_Filter](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Flow](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/flow.doc.html)!]! - # Flows downstream of this virtual connection - # - # 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. - downstreamFlowsConnection( - after: [String](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/int.doc.html), - filter: [Flow_Filter](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FlowsConnection](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/flowsconnection.doc.html) - # Workbooks downstream of this virtual connection - # - # 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. - downstreamWorkbooks( - filter: [Workbook_Filter](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/workbook_filter.doc.html), - orderBy: [WorkbookSortOrder](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/workbooksortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Workbook](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/workbook.doc.html)!]! - # Workbooks downstream of this virtual connection - # - # 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. - downstreamWorkbooksConnection( - after: [String](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/int.doc.html), - filter: [Workbook_Filter](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/workbook_filter.doc.html), - orderBy: [WorkbookSortOrder](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/workbooksortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [WorkbooksConnection](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/workbooksconnection.doc.html) - # Published Data Sources downstream of this virtual connection - # - # 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. - downstreamDatasources( - filter: [PublishedDatasource_Filter](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[PublishedDatasource](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/publisheddatasource.doc.html)!]! - # Published Data Sources downstream of this virtual connection - # - # 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. - downstreamDatasourcesConnection( - after: [String](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/int.doc.html), - filter: [PublishedDatasource_Filter](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [PublishedDatasourcesConnection](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/publisheddatasourcesconnection.doc.html) - # Lenses downstream of this published connection - # - # 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. - downstreamLenses( - filter: [Lens_Filter](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/lens_filter.doc.html), - orderBy: [LensSortOrder](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/lenssortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Lens](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/lens.doc.html)!]! - # Lenses downstream of this published connection - # - # 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. - downstreamLensesConnection( - after: [String](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/int.doc.html), - filter: [Lens_Filter](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/lens_filter.doc.html), - orderBy: [LensSortOrder](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/lenssortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [LensesConnection](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/lensesconnection.doc.html) - # Sheets downstream of this virtual connection - # - # 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. - downstreamSheets( - filter: [Sheet_Filter](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Sheet](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/sheet.doc.html)!]! - # Sheets downstream of this virtual connection - # - # 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. - downstreamSheetsConnection( - after: [String](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/int.doc.html), - filter: [Sheet_Filter](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [SheetsConnection](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/sheetsconnection.doc.html) - # Dashboards downstream of this virtual connection - # - # 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. - downstreamDashboards( - filter: [Dashboard_Filter](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/dashboard_filter.doc.html), - orderBy: [DashboardSortOrder](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/dashboardsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Dashboard](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/dashboard.doc.html)!]! - # Dashboards downstream of this virtual connection - # - # 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. - downstreamDashboardsConnection( - after: [String](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/int.doc.html), - filter: [Dashboard_Filter](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/dashboard_filter.doc.html), - orderBy: [DashboardSortOrder](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/dashboardsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DashboardsConnection](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/dashboardsconnection.doc.html) - # VirtualConnectionTables downstream of this virtual connection - # - # 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. - downstreamVirtualConnectionTables( - filter: [VirtualConnectionTable_Filter](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnectionTable](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/virtualconnectiontable.doc.html)!]! - # VirtualConnectionTables downstream of this virtual connection - # - # 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. - downstreamVirtualConnectionTablesConnection( - after: [String](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnectionTable_Filter](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionTablesConnection](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/virtualconnectiontablesconnection.doc.html) - # Metrics downstream of this virtual connection - # - # 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. - downstreamMetrics( - filter: [Metric_Filter](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/metric_filter.doc.html), - orderBy: [MetricSortOrder](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/metricsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Metric](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/metric.doc.html)!]! - # Metrics downstream of this virtual connection - # - # 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. - downstreamMetricsConnection( - after: [String](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/int.doc.html), - filter: [Metric_Filter](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/metric_filter.doc.html), - orderBy: [MetricSortOrder](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/metricsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [MetricsConnection](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/metricsconnection.doc.html) - # Owners connected to the database - # - # 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. - downstreamOwners( - filter: [TableauUser_Filter](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/tableauuser_filter.doc.html), - orderBy: [TableauUserSortOrder](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/tableauusersortorder.doc.html) - ): [[TableauUser](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/tableauuser.doc.html)!]! - # Owners connected to the database - # - # 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. - downstreamOwnersConnection( - after: [String](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/int.doc.html), - filter: [TableauUser_Filter](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/tableauuser_filter.doc.html), - orderBy: [TableauUserSortOrder](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/tableauusersortorder.doc.html) - ): [TableauUsersConnection](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/tableauusersconnection.doc.html) - # Metric definitions downstream from this VirtualConnection. - # - # 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. - downstreamMetricDefinitions( - filter: [MetricDefinition_Filter](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/metricdefinition_filter.doc.html), - orderBy: [MetricDefinitionSortOrder](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/metricdefinitionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[MetricDefinition](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/metricdefinition.doc.html)] - # Metric definitions downstream from this VirtualConnection. - # - # 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. - downstreamMetricDefinitionsConnection( - after: [String](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/int.doc.html), - filter: [MetricDefinition_Filter](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/metricdefinition_filter.doc.html), - orderBy: [MetricDefinitionSortOrder](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/metricdefinitionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [MetricDefinitionsConnection](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/metricdefinitionsconnection.doc.html) - } ` ## [_link_](#require-by) Require by - [BinField_GraphQL type for a binned continuous measure field. See https://onlinehelp.tableau.com/current/pro/desktop/en-us/calculations\_bins.html_](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/binfield.doc.html "BinField - GraphQL type for a binned continuous measure field. See https://onlinehelp.tableau.com/current/pro/desktop/en-us/calculations_bins.html") - [CalculatedField_GraphQL type for a calculated field. See https://onlinehelp.tableau.com/current/pro/desktop/en-us/calculations\_calculatedfields.html_](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/calculatedfield.doc.html "CalculatedField - GraphQL type for a calculated field. See https://onlinehelp.tableau.com/current/pro/desktop/en-us/calculations_calculatedfields.html") - [CloudFile_A cloud file connection_](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/cloudfile.doc.html "CloudFile - A cloud file connection") - [Column_GraphQL type for a table column_](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/column.doc.html "Column - GraphQL type for a table column") - [ColumnField_ColumnFields are a type of field which directly connects to a column in some type of table._](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/columnfield.doc.html "ColumnField - ColumnFields are a type of field which directly connects to a column in some type of table.") - [CombinedField_GraphQL type for a combined field. Combined fields concatanate fields together into one string._](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/combinedfield.doc.html "CombinedField - GraphQL type for a combined field. Combined fields concatanate fields together into one string.") - [CombinedSetField_GraphQL type for a combined set field. See https://onlinehelp.tableau.com/current/pro/desktop/en-us/sortgroup\_sets\_create.html#Combine_](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/combinedsetfield.doc.html "CombinedSetField - GraphQL type for a combined set field. See https://onlinehelp.tableau.com/current/pro/desktop/en-us/sortgroup_sets_create.html#Combine") - [CustomSQLTable_A 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._](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/customsqltable.doc.html "CustomSQLTable - A 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.") - [Database_A database containing tables_](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/database.doc.html "Database - A database containing tables") - [DatabaseServer_A database server connection_](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/databaseserver.doc.html "DatabaseServer - A database server connection") - [DatabaseTable_A table that is contained in a database_](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/databasetable.doc.html "DatabaseTable - A table that is contained in a database") - [DataCloud_A Data Cloud connection \*Available in Tableau Cloud February 2024 / Server 2024.2 and later.\*_](datacloud.doc.html "DataCloud - A Data Cloud connection *Available in Tableau Cloud February 2024 / Server 2024.2 and later.*") - [DatasourceField_GraphQL 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._](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/datasourcefield.doc.html "DatasourceField - GraphQL 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.") - [Field_Base GraphQL type for a field_](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [File_A file connection_](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/file.doc.html "File - A file connection") - [Flow_Flows are used to prepare data, which can include aggregation, cleaning, preprocessing, etc._](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/flow.doc.html "Flow - Flows are used to prepare data, which can include aggregation, cleaning, preprocessing, etc.") - [FlowColumnOutputField_Column output field implementation_](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/flowcolumnoutputfield.doc.html "FlowColumnOutputField - Column output field implementation") - [FlowFieldOutputField_Field output field implementation_](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/flowfieldoutputfield.doc.html "FlowFieldOutputField - Field output field implementation") - [FlowOutputField_A wrapper for an output field contained in a published flow._](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/flowoutputfield.doc.html "FlowOutputField - A wrapper for an output field contained in a published flow.") - [GroupField_GraphQL type for a group field. See https://onlinehelp.tableau.com/current/pro/desktop/en-us/sortgroup\_groups\_creating.html_](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/groupfield.doc.html "GroupField - GraphQL type for a group field. See https://onlinehelp.tableau.com/current/pro/desktop/en-us/sortgroup_groups_creating.html") - [HierarchyField_GraphQL type for a hierarchy. See https://onlinehelp.tableau.com/current/pro/desktop/en-us/qs\_hierarchies.html_](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/hierarchyfield.doc.html "HierarchyField - GraphQL type for a hierarchy. See https://onlinehelp.tableau.com/current/pro/desktop/en-us/qs_hierarchies.html") - [Lens_Lenses are curated, embeddable Ask Data experiences. \*Introduced in Tableau Cloud June 2022 / Server 2022.3.\* \*Retired in Tableau Cloud February 2024 / Server 2024.2.\*_](lens.doc.html "Lens - Lenses are curated, embeddable Ask Data experiences. *Introduced in Tableau Cloud June 2022 / Server 2022.3.* *Retired in Tableau Cloud February 2024 / Server 2024.2.*") - [MetricDefinition_A Tableau Pulse metric definition. \*Available in Tableau Cloud June 2024 and later. Tableau Pulse is not available in Tableau Server.\*_](metricdefinition.doc.html "MetricDefinition - A Tableau Pulse metric definition. *Available in Tableau Cloud June 2024 and later. Tableau Pulse is not available in Tableau Server.*") - [PublishedDatasource_A Tableau data source that has been published separately to Tableau Server. It can be used by multiple workbooks._](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/publisheddatasource.doc.html "PublishedDatasource - A Tableau data source that has been published separately to Tableau Server. It can be used by multiple workbooks.") - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/query.doc.html "Query - Query root for Metadata GraphQL interface") - [SetField_GraphQL type for a set field. See https://onlinehelp.tableau.com/current/pro/desktop/en-us/sortgroup\_sets\_create.html_](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/setfield.doc.html "SetField - GraphQL type for a set field. See https://onlinehelp.tableau.com/current/pro/desktop/en-us/sortgroup_sets_create.html") - [Table_A table containing columns_](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/table.doc.html "Table - A table containing columns") - [TableauSite_Site on Tableau server_](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/tableausite.doc.html "TableauSite - Site on Tableau server") - [TableauUser_User on a site on Tableau server_](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/tableauuser.doc.html "TableauUser - User on a site on Tableau server") - [Tag_A tag associated with content items_](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/tag.doc.html "Tag - A tag associated with content items") - [VirtualConnectionsConnection_Connection Type for VirtualConnection_](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/virtualconnectionsconnection.doc.html "VirtualConnectionsConnection - Connection Type for VirtualConnection") - [VirtualConnectionTable_A table in a virtual connection. \*Available in Tableau Cloud March 2022 / Server 2022.1 and later.\*_](virtualconnectiontable.doc.html "VirtualConnectionTable - A table in a virtual connection. *Available in Tableau Cloud March 2022 / Server 2022.1 and later.*") - [WebDataConnector_A web data connector_](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/webdataconnector.doc.html "WebDataConnector - A web data connector") - [Workbook_Workbooks 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)._](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/workbook.doc.html "Workbook - Workbooks 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).")