# tableau Api Tableau Metadata API (metadata_api) - Full Documentation _menu_ Types OBJECT # \_\_Directive ## [_link_](#graphql-schema-definition) GraphQL Schema definition `` - type __Directive { - # The __Directive type represents a Directive that a server supports. - name: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)! - description: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - isRepeatable: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html)! - locations: [[__DirectiveLocation](https://help.tableau.com/current/api/metadata_api/en-us/reference/directivelocation.spec.html)!]! - # Arguments - # **includeDeprecated**: [**Not documented**] - args(includeDeprecated: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html)): [[__InputValue](https://help.tableau.com/current/api/metadata_api/en-us/reference/inputvalue.spec.html)!]! - onOperation: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) @deprecated( reason: "Use `locations`." ) - onFragment: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) @deprecated( reason: "Use `locations`." ) - onField: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) @deprecated( reason: "Use `locations`." ) - } `` ## [_link_](#require-by) Require by - [\_\_Schema_A GraphQL Introspection defines the capabilities of a GraphQL server. It exposes all available types and directives on the server, the entry points for query, mutation, and subscription operations._](https://help.tableau.com/current/api/metadata_api/en-us/reference/schema.spec.html "__Schema - A GraphQL Introspection defines the capabilities of a GraphQL server. It exposes all available types and directives on the server, the entry points for query, mutation, and subscription operations.") _menu_ Types ENUM # \_\_DirectiveLocation An enum describing valid locations where a directive can be placed ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - enum __DirectiveLocation { - # Indicates the directive is valid on queries. - QUERY - # Indicates the directive is valid on mutations. - MUTATION - # Indicates the directive is valid on subscriptions. - SUBSCRIPTION - # Indicates the directive is valid on fields. - FIELD - # Indicates the directive is valid on fragment definitions. - FRAGMENT_DEFINITION - # Indicates the directive is valid on fragment spreads. - FRAGMENT_SPREAD - # Indicates the directive is valid on inline fragments. - INLINE_FRAGMENT - # Indicates the directive is valid on variable definitions. - VARIABLE_DEFINITION - # Indicates the directive is valid on a schema SDL definition. - SCHEMA - # Indicates the directive is valid on a scalar SDL definition. - SCALAR - # Indicates the directive is valid on an object SDL definition. - OBJECT - # Indicates the directive is valid on a field SDL definition. - FIELD_DEFINITION - # Indicates the directive is valid on a field argument SDL definition. - ARGUMENT_DEFINITION - # Indicates the directive is valid on an interface SDL definition. - INTERFACE - # Indicates the directive is valid on an union SDL definition. - UNION - # Indicates the directive is valid on an enum SDL definition. - ENUM - # Indicates the directive is valid on an enum value SDL definition. - ENUM_VALUE - # Indicates the directive is valid on an input object SDL definition. - INPUT_OBJECT - # Indicates the directive is valid on an input object field SDL definition. - INPUT_FIELD_DEFINITION - } ` ## [_link_](#require-by) Require by - [\_\_Directive_null_](https://help.tableau.com/current/api/metadata_api/en-us/reference/directive.spec.html "__Directive - ") _menu_ Types OBJECT # \_\_EnumValue ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type __EnumValue { - name: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)! - description: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - isDeprecated: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html)! - deprecationReason: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - } ` ## [_link_](#require-by) Require by - [\_\_Type_null_](https://help.tableau.com/current/api/metadata_api/en-us/reference/type.spec.html "__Type - ") _menu_ Types OBJECT # \_\_Field ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type __Field { - name: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)! - description: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Arguments - # **includeDeprecated**: [**Not documented**] - args(includeDeprecated: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html)): [[__InputValue](https://help.tableau.com/current/api/metadata_api/en-us/reference/inputvalue.spec.html)!]! - type: [__Type](https://help.tableau.com/current/api/metadata_api/en-us/reference/type.spec.html)! - isDeprecated: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html)! - deprecationReason: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - } ` ## [_link_](#require-by) Require by - [\_\_Type_null_](https://help.tableau.com/current/api/metadata_api/en-us/reference/type.spec.html "__Type - ") _menu_ Types OBJECT # \_\_InputValue ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type __InputValue { - name: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)! - description: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - type: [__Type](https://help.tableau.com/current/api/metadata_api/en-us/reference/type.spec.html)! - defaultValue: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - isDeprecated: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) - deprecationReason: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - } ` ## [_link_](#require-by) Require by - [\_\_Directive_null_](https://help.tableau.com/current/api/metadata_api/en-us/reference/directive.spec.html "__Directive - ") - [\_\_Field_null_](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.spec.html "__Field - ") - [\_\_Type_null_](https://help.tableau.com/current/api/metadata_api/en-us/reference/type.spec.html "__Type - ") _menu_ Types OBJECT # \_\_Schema A GraphQL Introspection defines the capabilities of a GraphQL server. It exposes all available types and directives on the server, the entry points for query, mutation, and subscription operations. ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type __Schema { - description: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # A list of all types supported by this server. - types: [[__Type](https://help.tableau.com/current/api/metadata_api/en-us/reference/type.spec.html)!]! - # The type that query operations will be rooted at. - queryType: [__Type](https://help.tableau.com/current/api/metadata_api/en-us/reference/type.spec.html)! - # If this server supports mutation, the type that mutation operations will be - # rooted at. - mutationType: [__Type](https://help.tableau.com/current/api/metadata_api/en-us/reference/type.spec.html) - # 'A list of all directives supported by this server. - directives: [[__Directive](https://help.tableau.com/current/api/metadata_api/en-us/reference/directive.spec.html)!]! - # 'If this server support subscription, the type that subscription operations will - # be rooted at. - subscriptionType: [__Type](https://help.tableau.com/current/api/metadata_api/en-us/reference/type.spec.html) - } ` ## [_link_](#require-by) Require by This element is not required by anyone _menu_ Types OBJECT # \_\_Type ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type __Type { - kind: [__TypeKind](https://help.tableau.com/current/api/metadata_api/en-us/reference/typekind.spec.html)! - name: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - description: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Arguments - # **includeDeprecated**: [**Not documented**] - fields(includeDeprecated: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html)): [[__Field](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.spec.html)!] - interfaces: [[__Type](https://help.tableau.com/current/api/metadata_api/en-us/reference/type.spec.html)!] - possibleTypes: [[__Type](https://help.tableau.com/current/api/metadata_api/en-us/reference/type.spec.html)!] - # Arguments - # **includeDeprecated**: [**Not documented**] - enumValues(includeDeprecated: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html)): [[__EnumValue](https://help.tableau.com/current/api/metadata_api/en-us/reference/enumvalue.spec.html)!] - # Arguments - # **includeDeprecated**: [**Not documented**] - inputFields(includeDeprecated: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html)): [[__InputValue](https://help.tableau.com/current/api/metadata_api/en-us/reference/inputvalue.spec.html)!] - ofType: [__Type](https://help.tableau.com/current/api/metadata_api/en-us/reference/type.spec.html) - specifiedByUrl: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - } ` ## [_link_](#require-by) Require by - [\_\_Field_null_](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.spec.html "__Field - ") - [\_\_InputValue_null_](https://help.tableau.com/current/api/metadata_api/en-us/reference/inputvalue.spec.html "__InputValue - ") - [\_\_Schema_A GraphQL Introspection defines the capabilities of a GraphQL server. It exposes all available types and directives on the server, the entry points for query, mutation, and subscription operations._](https://help.tableau.com/current/api/metadata_api/en-us/reference/schema.spec.html "__Schema - A GraphQL Introspection defines the capabilities of a GraphQL server. It exposes all available types and directives on the server, the entry points for query, mutation, and subscription operations.") - [\_\_Type_null_](https://help.tableau.com/current/api/metadata_api/en-us/reference/type.spec.html "__Type - ") _menu_ Types ENUM # \_\_TypeKind An enum describing what kind of type a given \_\_Type is ## [_link_](#graphql-schema-definition) GraphQL Schema definition `` - enum __TypeKind { - # Indicates this type is a scalar. 'specifiedByUrl' is a valid field - SCALAR - # Indicates this type is an object. `fields` and `interfaces` are valid fields. - OBJECT - # Indicates this type is an interface. `fields` and `possibleTypes` are valid - # fields. - INTERFACE - # Indicates this type is a union. `possibleTypes` is a valid field. - UNION - # Indicates this type is an enum. `enumValues` is a valid field. - ENUM - # Indicates this type is an input object. `inputFields` is a valid field. - INPUT_OBJECT - # Indicates this type is a list. `ofType` is a valid field. - LIST - # Indicates this type is a non-null. `ofType` is a valid field. - NON_NULL - } `` ## [_link_](#require-by) Require by - [\_\_Type_null_](https://help.tableau.com/current/api/metadata_api/en-us/reference/type.spec.html "__Type - ") # About Tableau Help ### Addressing Implicit Bias in Technical Language In an effort to align with one of our core company values, equality, we have changed terminology to be more inclusive where possible. Because changing terms in code can break current implementations, we maintain the current terminology in the following places: - Tableau APIs: methods, parameters, and variables - Tableau CLIs: commands and options - Installers, installation directories, and terms in configuration files - Tableau Resource Monitoring Tool (we plan to make changes to non-inclusive terminology in the web interface, error messages, and related documentation soon.) - Third-party systems documentation For more information about our ongoing effort to address implicit bias, see [Salesforce Updates Technical Language in Ongoing Effort to Address Implicit Bias \[↗\]](https://www.salesforce.com/news/stories/salesforce-updates-technical-language-in-ongoing-effort-to-address-implicit-bias) on the Salesforce website. _menu_ Types INTERFACE # AnalyticsField Base GraphQL type for a field containing analytics metadata ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - interface AnalyticsField { - # Default format for number or date - defaultFormat: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # For geographic data, the geographic role of the field. See - # https://onlinehelp.tableau.com/current/pro/desktop/en-us/maps_geographicroles.html - semanticRole: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Default aggregation of the field, i.e. 'Sum', 'Average'. See - # https://onlinehelp.tableau.com/current/pro/desktop/en-us/calculations_aggregation.html#AggFuncs - aggregation: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # For the percentile aggregation, the percentile number - aggregationParam: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # The bin field that references this field - # - # 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. - referencedByBins( - filter: [BinField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/binfield_filter.doc.html), - orderBy: [BinFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/binfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[BinField](https://help.tableau.com/current/api/metadata_api/en-us/reference/binfield.doc.html)] - # The bin field that references this field - # - # 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. - referencedByBinsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [BinField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/binfield_filter.doc.html), - orderBy: [BinFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/binfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [BinFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/binfieldsconnection.doc.html) - # Sheets that reference this field - # - # 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. - directSheets( - filter: [Sheet_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Sheet](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html)] - # Sheets that reference this field - # - # 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. - directSheetsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Sheet_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [SheetsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsconnection.doc.html) - # The set field that this field references - # - # 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. - referencedBySets( - filter: [SetField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/setfield_filter.doc.html), - orderBy: [SetFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/setfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[SetField](https://help.tableau.com/current/api/metadata_api/en-us/reference/setfield.doc.html)] - # The set field that this field references - # - # 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. - referencedBySetsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [SetField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/setfield_filter.doc.html), - orderBy: [SetFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/setfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [SetFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/setfieldsconnection.doc.html) - # The field that references this remote field - # - # 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. - referencedByRemoteFields( - filter: [DatasourceField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefield_filter.doc.html), - orderBy: [DatasourceFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DatasourceField](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefield.doc.html)] - # The field that references this remote field - # - # 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. - referencedByRemoteFieldsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DatasourceField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefield_filter.doc.html), - orderBy: [DatasourceFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatasourceFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefieldsconnection.doc.html) - # The hierarchy field that references this field - # - # 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. - referencedByHierarchies( - filter: [HierarchyField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/hierarchyfield_filter.doc.html), - orderBy: [HierarchyFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/hierarchyfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[HierarchyField](https://help.tableau.com/current/api/metadata_api/en-us/reference/hierarchyfield.doc.html)] - # The hierarchy field that references this field - # - # 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. - referencedByHierarchiesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [HierarchyField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/hierarchyfield_filter.doc.html), - orderBy: [HierarchyFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/hierarchyfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [HierarchyFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/hierarchyfieldsconnection.doc.html) - # The field that references this field - # - # 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. - referencedByFields( - filter: [FieldReferencingField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield_filter.doc.html), - orderBy: [FieldReferencingFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[FieldReferencingField](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield.doc.html)] - # The field that references this field - # - # 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. - referencedByFieldsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [FieldReferencingField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield_filter.doc.html), - orderBy: [FieldReferencingFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FieldReferencingFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfieldsconnection.doc.html) - # The data source filters that include this field - # - # 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. - referencedByFilters( - filter: [DatasourceFilter_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefilter_filter.doc.html), - orderBy: [DatasourceFilterSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefiltersortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DatasourceFilter](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefilter.doc.html)] - # The data source filters that include this field - # - # 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. - referencedByFiltersConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DatasourceFilter_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefilter_filter.doc.html), - orderBy: [DatasourceFilterSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefiltersortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatasourceFiltersConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefiltersconnection.doc.html) - # Thie combined set field that references this field - # - # 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. - referencedByCombinedSets( - filter: [CombinedSetField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedsetfield_filter.doc.html), - orderBy: [CombinedSetFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedsetfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[CombinedSetField](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedsetfield.doc.html)] - # Thie combined set field that references this field - # - # 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. - referencedByCombinedSetsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [CombinedSetField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedsetfield_filter.doc.html), - orderBy: [CombinedSetFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedsetfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [CombinedSetFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedsetfieldsconnection.doc.html) - # Sheets that reference this data source field - # - # 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. - sheets( - filter: [Sheet_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Sheet](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html)] - # Sheets that reference this data source field - # - # 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. - sheetsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Sheet_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [SheetsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsconnection.doc.html) - # A flow output field that wraps this field - # - # 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. - referencedByFlowFieldOutputField( - filter: [FlowFieldOutputField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfield_filter.doc.html), - orderBy: [FlowFieldOutputFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[FlowFieldOutputField](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfield.doc.html)] - # A flow output field that wraps this field - # - # 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. - referencedByFlowFieldOutputFieldConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [FlowFieldOutputField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfield_filter.doc.html), - orderBy: [FlowFieldOutputFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FlowFieldOutputFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfieldsconnection.doc.html) - # The calculated field that references this field - # - # 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. - referencedByCalculations( - filter: [CalculatedField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/calculatedfield_filter.doc.html), - orderBy: [CalculatedFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/calculatedfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[CalculatedField](https://help.tableau.com/current/api/metadata_api/en-us/reference/calculatedfield.doc.html)] - # The calculated field that references this field - # - # 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. - referencedByCalculationsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [CalculatedField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/calculatedfield_filter.doc.html), - orderBy: [CalculatedFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/calculatedfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [CalculatedFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/calculatedfieldsconnection.doc.html) - # A flow input field that wraps this field - # - # 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. - referencedByFlowFieldInputField( - filter: [FlowFieldInputField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfield_filter.doc.html), - orderBy: [FlowFieldInputFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfieldsortorder.doc.html) - ): [[FlowFieldInputField](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfield.doc.html)] - # A flow input field that wraps this field - # - # 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. - referencedByFlowFieldInputFieldConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [FlowFieldInputField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfield_filter.doc.html), - orderBy: [FlowFieldInputFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfieldsortorder.doc.html) - ): [FlowFieldInputFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfieldsconnection.doc.html) - # Data source that contains this field - datasource: [Datasource](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasource.doc.html) - # Metric definitions that reference this data source field. - # - # 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. - metricDefinitions( - filter: [MetricDefinition_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinition_filter.doc.html), - orderBy: [MetricDefinitionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[MetricDefinition](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinition.doc.html)] - # Metric definitions that reference this data source field. - # - # 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. - metricDefinitionsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [MetricDefinition_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinition_filter.doc.html), - orderBy: [MetricDefinitionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [MetricDefinitionsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsconnection.doc.html) - # The group field that references this field - # - # 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. - referencedByGroups( - filter: [GroupField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/groupfield_filter.doc.html), - orderBy: [GroupFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/groupfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[GroupField](https://help.tableau.com/current/api/metadata_api/en-us/reference/groupfield.doc.html)] - # The group field that references this field - # - # 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. - referencedByGroupsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [GroupField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/groupfield_filter.doc.html), - orderBy: [GroupFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/groupfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [GroupFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/groupfieldsconnection.doc.html) - # The combined field that references this field - # - # 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. - referencedByCombinedFields( - filter: [CombinedField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedfield_filter.doc.html), - orderBy: [CombinedFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[CombinedField](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedfield.doc.html)] - # The combined field that references this field - # - # 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. - referencedByCombinedFieldsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [CombinedField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedfield_filter.doc.html), - orderBy: [CombinedFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [CombinedFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedfieldsconnection.doc.html) - # List of lens fields which are derived from this field - # - # 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. - derivedLensFields( - filter: [LensField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensfield_filter.doc.html), - orderBy: [LensFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[LensField](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensfield.doc.html)] - # List of lens fields which are derived from this field - # - # 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. - derivedLensFieldsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [LensField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensfield_filter.doc.html), - orderBy: [LensFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [LensFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensfieldsconnection.doc.html) - } ` ## [_link_](#require-by) Require by - [AnalyticsFieldsConnection_Connection Type for AnalyticsField_](https://help.tableau.com/current/api/metadata_api/en-us/reference/analyticsfieldsconnection.doc.html "AnalyticsFieldsConnection - Connection Type for AnalyticsField") - [CalculatedField_GraphQL type for a calculated field. See https://onlinehelp.tableau.com/current/pro/desktop/en-us/calculations\_calculatedfields.html_](https://help.tableau.com/current/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") - [ColumnField_ColumnFields are a type of field which directly connects to a column in some type of table._](https://help.tableau.com/current/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.") _menu_ Types INPUT\_OBJECT # AnalyticsField\_Filter Filter by GraphQL field and given value ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input AnalyticsField_Filter { - # Unique Identifier of object to retrieve - id: [ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html) - # Unique Identifier of object to retrieve - idWithin: [[ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html)] - } ` ## [_link_](#require-by) Require by This element is not required by anyone _menu_ Types ENUM # AnalyticsFieldOrderField Enum for fields that can be used for sorting ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - enum AnalyticsFieldOrderField { - # Sort by id - ID - } ` ## [_link_](#require-by) Require by - [AnalyticsFieldSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/analyticsfieldsortorder.doc.html "AnalyticsFieldSortOrder - 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.") _menu_ Types OBJECT # AnalyticsFieldsConnection Connection Type for AnalyticsField ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type AnalyticsFieldsConnection { - # List of nodes - nodes: [[AnalyticsField](https://help.tableau.com/current/api/metadata_api/en-us/reference/analyticsfield.doc.html)!]! - # Information for pagination - pageInfo: [PageInfo](https://help.tableau.com/current/api/metadata_api/en-us/reference/pageinfo.doc.html)! - # Total number of objects in connection - totalCount: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html)! - } ` ## [_link_](#require-by) Require by This element is not required by anyone _menu_ Types INPUT\_OBJECT # AnalyticsFieldSortOrder 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. ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input AnalyticsFieldSortOrder { - # GraphQL field to sort on - field: [AnalyticsFieldOrderField](https://help.tableau.com/current/api/metadata_api/en-us/reference/analyticsfieldorderfield.doc.html)! - # Order direction to sort output - direction: [OrderDirection](https://help.tableau.com/current/api/metadata_api/en-us/reference/orderdirection.doc.html)! - } ` ## [_link_](#require-by) Require by This element is not required by anyone _menu_ Types OBJECT # AskDataExtension AskDataExtensions to base Tableau functionality. ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type AskDataExtension { - # Unique identifier used by the metadata API - id: [ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html)! - # Lens configured for the askData extension - lens: [Lens](https://help.tableau.com/current/api/metadata_api/en-us/reference/lens.doc.html) - # The dashboard that contains this askData extension - dashboard: [Dashboard](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard.doc.html) - } ` ## [_link_](#require-by) Require by - [AskDataExtensionsConnection_Connection Type for AskDataExtension_](https://help.tableau.com/current/api/metadata_api/en-us/reference/askdataextensionsconnection.doc.html "AskDataExtensionsConnection - Connection Type for AskDataExtension") - [Dashboard_A dashboard contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard.doc.html "Dashboard - A dashboard contained in a published workbook.") - [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.*") - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/api/metadata_api/en-us/reference/query.doc.html "Query - Query root for Metadata GraphQL interface") _menu_ Types INPUT\_OBJECT # AskDataExtension\_Filter Filter by GraphQL field and given value ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input AskDataExtension_Filter { - # Unique identifier used by the metadata API - id: [ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html) - # Unique identifier used by the metadata API - idWithin: [[ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html)] - } ` ## [_link_](#require-by) Require by - [Dashboard_A dashboard contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard.doc.html "Dashboard - A dashboard contained in a published workbook.") - [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.*") - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/api/metadata_api/en-us/reference/query.doc.html "Query - Query root for Metadata GraphQL interface") _menu_ Types INPUT\_OBJECT # AskDataExtension\_Required\_Filter Filter by GraphQL field and given value ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input AskDataExtension_Required_Filter { - # Unique identifier used by the metadata API - id: [ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html) - # Unique identifier used by the metadata API - idWithin: [[ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html)] - } ` ## [_link_](#require-by) Require by This element is not required by anyone _menu_ Types ENUM # AskDataExtensionOrderField Enum for fields that can be used for sorting ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - enum AskDataExtensionOrderField { - # Sort by id - ID - } ` ## [_link_](#require-by) Require by - [AskDataExtensionSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/askdataextensionsortorder.doc.html "AskDataExtensionSortOrder - 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.") _menu_ Types OBJECT # AskDataExtensionsConnection Connection Type for AskDataExtension ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type AskDataExtensionsConnection { - # List of nodes - nodes: [[AskDataExtension](https://help.tableau.com/current/api/metadata_api/en-us/reference/askdataextension.doc.html)!]! - # Information for pagination - pageInfo: [PageInfo](https://help.tableau.com/current/api/metadata_api/en-us/reference/pageinfo.doc.html)! - # Total number of objects in connection - totalCount: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html)! - } ` ## [_link_](#require-by) Require by - [Dashboard_A dashboard contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard.doc.html "Dashboard - A dashboard contained in a published workbook.") - [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.*") - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/api/metadata_api/en-us/reference/query.doc.html "Query - Query root for Metadata GraphQL interface") _menu_ Types INPUT\_OBJECT # AskDataExtensionSortOrder 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. ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input AskDataExtensionSortOrder { - # GraphQL field to sort on - field: [AskDataExtensionOrderField](https://help.tableau.com/current/api/metadata_api/en-us/reference/askdataextensionorderfield.doc.html)! - # Order direction to sort output - direction: [OrderDirection](https://help.tableau.com/current/api/metadata_api/en-us/reference/orderdirection.doc.html)! - } ` ## [_link_](#require-by) Require by - [Dashboard_A dashboard contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard.doc.html "Dashboard - A dashboard contained in a published workbook.") - [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.*") - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/api/metadata_api/en-us/reference/query.doc.html "Query - Query root for Metadata GraphQL interface") _menu_ Types OBJECT # BinField GraphQL type for a binned continuous measure field. See [https://onlinehelp.tableau.com/current/pro/desktop/en-us/calculations\_bins.html](https://onlinehelp.tableau.com/current/pro/desktop/en-us/calculations_bins.html) ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type BinField implements [Field](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.doc.html), [DataField](https://help.tableau.com/current/api/metadata_api/en-us/reference/datafield.doc.html), [FieldReferencingField](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield.doc.html), [Node](https://help.tableau.com/current/api/metadata_api/en-us/reference/node.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/current/api/metadata_api/en-us/reference/id.doc.html)! - # Name shown in server and desktop clients - name: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Name internally used to uniquely identify fields - fullyQualifiedName: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Description of field shown in server and desktop clients - description: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # description that is shown in the Tableau UI - # - # Arguments - # **inheritanceType**: Method for selecting inherited value - # **permissionMode**: Option to select how to apply permissions. By - # default it is OBFUSCATE_RESULTS - descriptionInherited( - inheritanceType: [InheritanceType](https://help.tableau.com/current/api/metadata_api/en-us/reference/inheritancetype.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[InheritedStringResult](https://help.tableau.com/current/api/metadata_api/en-us/reference/inheritedstringresult.doc.html)] - # True if the field is hidden - isHidden: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) - # Name of folder if the field is in a folder. See - # https://onlinehelp.tableau.com/current/pro/desktop/en-us/datafields_dwfeatures.html#Organize - folderName: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Data category of the field - dataCategory: [FieldRoleCategory](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldrolecategory.doc.html) - # Role of the field: 'dimension', 'measure' or 'unknown' - role: [FieldRole](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldrole.doc.html) - # Type of the data in the field. See - # https://onlinehelp.tableau.com/current/pro/desktop/en-us/datafields_typesandroles_datatypes.html - dataType: [FieldDataType](https://help.tableau.com/current/api/metadata_api/en-us/reference/fielddatatype.doc.html) - # Formula of the calculated field - formula: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Size of the bin - binSize: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # List of fields, if any, that this field references - # - # 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. - fields( - filter: [Field_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/field_filter.doc.html), - orderBy: [FieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Field](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.doc.html)!]! - # List of fields, if any, that this field references - # - # 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. - fieldsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Field_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/field_filter.doc.html), - orderBy: [FieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsconnection.doc.html) - # List of parameters, if any, used in this field - # - # 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. - parameters( - filter: [Parameter_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/parameter_filter.doc.html), - orderBy: [ParameterSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/parametersortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Parameter](https://help.tableau.com/current/api/metadata_api/en-us/reference/parameter.doc.html)!]! - # List of parameters, if any, used in this field - # - # 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. - parametersConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Parameter_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/parameter_filter.doc.html), - orderBy: [ParameterSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/parametersortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [ParametersConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/parametersconnection.doc.html) - # Columns downstream of this field - # - # 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. - downstreamColumns( - filter: [Column_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/column_filter.doc.html), - orderBy: [ColumnSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Column](https://help.tableau.com/current/api/metadata_api/en-us/reference/column.doc.html)!]! - # Columns downstream of this field - # - # 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. - downstreamColumnsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Column_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/column_filter.doc.html), - orderBy: [ColumnSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [ColumnsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnsconnection.doc.html) - # Tables downstream of this field - # - # 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. - downstreamTables( - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DatabaseTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable.doc.html)!]! - # Tables downstream of this field - # - # 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. - downstreamTablesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabaseTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesconnection.doc.html) - # Virtual connection tables downstream of this field - # - # 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/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnectionTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable.doc.html)!]! - # Virtual connection tables downstream of this field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnectionTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesconnection.doc.html) - # Virtual connections downstream of this field - # - # 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. - downstreamVirtualConnections( - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection.doc.html)!]! - # Virtual connections downstream of this field - # - # 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. - downstreamVirtualConnectionsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsconnection.doc.html) - # Databases downstream of this field - # - # 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. - downstreamDatabases( - filter: [Database_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Database](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html)!]! - # Databases downstream of this field - # - # 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. - downstreamDatabasesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Database_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabasesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesconnection.doc.html) - # Flows downstream of this field - # - # 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/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Flow](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow.doc.html)!]! - # Flows downstream of this field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Flow_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FlowsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsconnection.doc.html) - # downstream fields that reference this field - # - # 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. - downstreamFields( - filter: [Field_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/field_filter.doc.html), - orderBy: [FieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Field](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.doc.html)!]! - # downstream fields that reference this field - # - # 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. - downstreamFieldsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Field_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/field_filter.doc.html), - orderBy: [FieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsconnection.doc.html) - # Datasources connected downstream from this field - # - # 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/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[PublishedDatasource](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource.doc.html)!] - # Datasources connected downstream from this field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [PublishedDatasource_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [PublishedDatasourcesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesconnection.doc.html) - # Lenses connected downstream from this field - # - # 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/current/api/metadata_api/en-us/reference/lens_filter.doc.html), - orderBy: [LensSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/lenssortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Lens](https://help.tableau.com/current/api/metadata_api/en-us/reference/lens.doc.html)!] - # Lenses connected downstream from this field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Lens_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/lens_filter.doc.html), - orderBy: [LensSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/lenssortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [LensesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensesconnection.doc.html) - # Sheets connected downstream from the field - # - # 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/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Sheet](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html)!]! - # Sheets connected downstream from the field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Sheet_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [SheetsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsconnection.doc.html) - # Dashboards connected downstream from the field - # - # 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/current/api/metadata_api/en-us/reference/dashboard_filter.doc.html), - orderBy: [DashboardSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboardsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Dashboard](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard.doc.html)!]! - # Dashboards connected downstream from the field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Dashboard_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard_filter.doc.html), - orderBy: [DashboardSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboardsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DashboardsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboardsconnection.doc.html) - # Workbooks connected downstream from the field - # - # 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/current/api/metadata_api/en-us/reference/workbook_filter.doc.html), - orderBy: [WorkbookSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Workbook](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbook.doc.html)!] - # Workbooks connected downstream from the field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Workbook_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbook_filter.doc.html), - orderBy: [WorkbookSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [WorkbooksConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksconnection.doc.html) - # Metrics connected downstream from the field - # - # 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/current/api/metadata_api/en-us/reference/metric_filter.doc.html), - orderBy: [MetricSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Metric](https://help.tableau.com/current/api/metadata_api/en-us/reference/metric.doc.html)!] - # Metrics connected downstream from the field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Metric_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metric_filter.doc.html), - orderBy: [MetricSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [MetricsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricsconnection.doc.html) - # Workbook owners (authors) connected downstream from the field - # - # 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/current/api/metadata_api/en-us/reference/tableauuser_filter.doc.html), - orderBy: [TableauUserSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauusersortorder.doc.html) - ): [[TableauUser](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauuser.doc.html)!] - # Workbook owners (authors) connected downstream from the field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [TableauUser_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauuser_filter.doc.html), - orderBy: [TableauUserSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauusersortorder.doc.html) - ): [TableauUsersConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauusersconnection.doc.html) - # Tables connected upstream from the field - # - # 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/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DatabaseTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable.doc.html)!]! - # Tables connected upstream from the field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabaseTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesconnection.doc.html) - # Virtual connection tables upstream of this field - # - # 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/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnectionTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable.doc.html)!]! - # Virtual connection tables upstream of this field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnectionTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesconnection.doc.html) - # Virtual connections upstream of this field - # - # 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. - upstreamVirtualConnections( - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection.doc.html)!]! - # Virtual connections upstream of this field - # - # 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. - upstreamVirtualConnectionsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsconnection.doc.html) - # Databases connected upstream from the field - # - # 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/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Database](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html)!]! - # Databases connected upstream from the field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Database_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabasesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesconnection.doc.html) - # Flows connected upstream from the field - # - # 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/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Flow](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow.doc.html)!]! - # Flows connected upstream from the field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Flow_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FlowsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsconnection.doc.html) - # Datasources connected upstream from the field - # - # 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/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[PublishedDatasource](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource.doc.html)!]! - # Datasources connected upstream from the field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [PublishedDatasource_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [PublishedDatasourcesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesconnection.doc.html) - # The field that references this field - # - # 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. - referencedByFields( - filter: [FieldReferencingField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield_filter.doc.html), - orderBy: [FieldReferencingFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[FieldReferencingField](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield.doc.html)] - # The field that references this field - # - # 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. - referencedByFieldsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [FieldReferencingField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield_filter.doc.html), - orderBy: [FieldReferencingFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FieldReferencingFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfieldsconnection.doc.html) - # Data source that contains this field - datasource: [Datasource](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasource.doc.html) - # Metric definitions that reference this data source field. - # - # 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. - metricDefinitions( - filter: [MetricDefinition_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinition_filter.doc.html), - orderBy: [MetricDefinitionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[MetricDefinition](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinition.doc.html)] - # Metric definitions that reference this data source field. - # - # 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. - metricDefinitionsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [MetricDefinition_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinition_filter.doc.html), - orderBy: [MetricDefinitionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [MetricDefinitionsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsconnection.doc.html) - # The data source filters that include this field - # - # 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. - referencedByFilters( - filter: [DatasourceFilter_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefilter_filter.doc.html), - orderBy: [DatasourceFilterSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefiltersortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DatasourceFilter](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefilter.doc.html)] - # The data source filters that include this field - # - # 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. - referencedByFiltersConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DatasourceFilter_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefilter_filter.doc.html), - orderBy: [DatasourceFilterSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefiltersortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatasourceFiltersConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefiltersconnection.doc.html) - # The bin field that references this field - # - # 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. - referencedByBins( - filter: [BinField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/binfield_filter.doc.html), - orderBy: [BinFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/binfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[BinField](https://help.tableau.com/current/api/metadata_api/en-us/reference/binfield.doc.html)] - # The bin field that references this field - # - # 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. - referencedByBinsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [BinField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/binfield_filter.doc.html), - orderBy: [BinFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/binfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [BinFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/binfieldsconnection.doc.html) - # The calculated field that references this field - # - # 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. - referencedByCalculations( - filter: [CalculatedField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/calculatedfield_filter.doc.html), - orderBy: [CalculatedFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/calculatedfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[CalculatedField](https://help.tableau.com/current/api/metadata_api/en-us/reference/calculatedfield.doc.html)] - # The calculated field that references this field - # - # 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. - referencedByCalculationsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [CalculatedField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/calculatedfield_filter.doc.html), - orderBy: [CalculatedFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/calculatedfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [CalculatedFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/calculatedfieldsconnection.doc.html) - # The combined field that references this field - # - # 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. - referencedByCombinedFields( - filter: [CombinedField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedfield_filter.doc.html), - orderBy: [CombinedFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[CombinedField](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedfield.doc.html)] - # The combined field that references this field - # - # 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. - referencedByCombinedFieldsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [CombinedField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedfield_filter.doc.html), - orderBy: [CombinedFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [CombinedFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedfieldsconnection.doc.html) - # Thie combined set field that references this field - # - # 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. - referencedByCombinedSets( - filter: [CombinedSetField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedsetfield_filter.doc.html), - orderBy: [CombinedSetFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedsetfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[CombinedSetField](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedsetfield.doc.html)] - # Thie combined set field that references this field - # - # 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. - referencedByCombinedSetsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [CombinedSetField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedsetfield_filter.doc.html), - orderBy: [CombinedSetFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedsetfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [CombinedSetFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedsetfieldsconnection.doc.html) - # The field that references this remote field - # - # 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. - referencedByRemoteFields( - filter: [DatasourceField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefield_filter.doc.html), - orderBy: [DatasourceFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DatasourceField](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefield.doc.html)] - # The field that references this remote field - # - # 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. - referencedByRemoteFieldsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DatasourceField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefield_filter.doc.html), - orderBy: [DatasourceFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatasourceFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefieldsconnection.doc.html) - # The group field that references this field - # - # 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. - referencedByGroups( - filter: [GroupField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/groupfield_filter.doc.html), - orderBy: [GroupFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/groupfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[GroupField](https://help.tableau.com/current/api/metadata_api/en-us/reference/groupfield.doc.html)] - # The group field that references this field - # - # 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. - referencedByGroupsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [GroupField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/groupfield_filter.doc.html), - orderBy: [GroupFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/groupfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [GroupFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/groupfieldsconnection.doc.html) - # The set field that this field references - # - # 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. - referencedBySets( - filter: [SetField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/setfield_filter.doc.html), - orderBy: [SetFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/setfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[SetField](https://help.tableau.com/current/api/metadata_api/en-us/reference/setfield.doc.html)] - # The set field that this field references - # - # 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. - referencedBySetsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [SetField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/setfield_filter.doc.html), - orderBy: [SetFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/setfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [SetFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/setfieldsconnection.doc.html) - # The hierarchy field that references this field - # - # 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. - referencedByHierarchies( - filter: [HierarchyField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/hierarchyfield_filter.doc.html), - orderBy: [HierarchyFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/hierarchyfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[HierarchyField](https://help.tableau.com/current/api/metadata_api/en-us/reference/hierarchyfield.doc.html)] - # The hierarchy field that references this field - # - # 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. - referencedByHierarchiesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [HierarchyField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/hierarchyfield_filter.doc.html), - orderBy: [HierarchyFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/hierarchyfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [HierarchyFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/hierarchyfieldsconnection.doc.html) - # Sheets that reference this data source field - # - # 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. - sheets( - filter: [Sheet_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Sheet](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html)] - # Sheets that reference this data source field - # - # 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. - sheetsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Sheet_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [SheetsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsconnection.doc.html) - # Sheets that reference this field - # - # 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. - directSheets( - filter: [Sheet_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Sheet](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html)] - # Sheets that reference this field - # - # 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. - directSheetsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Sheet_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [SheetsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsconnection.doc.html) - # List of lens fields which are derived from this field - # - # 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. - derivedLensFields( - filter: [LensField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensfield_filter.doc.html), - orderBy: [LensFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[LensField](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensfield.doc.html)] - # List of lens fields which are derived from this field - # - # 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. - derivedLensFieldsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [LensField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensfield_filter.doc.html), - orderBy: [LensFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [LensFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensfieldsconnection.doc.html) - # A flow input field that wraps this field - # - # 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. - referencedByFlowFieldInputField( - filter: [FlowFieldInputField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfield_filter.doc.html), - orderBy: [FlowFieldInputFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfieldsortorder.doc.html) - ): [[FlowFieldInputField](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfield.doc.html)] - # A flow input field that wraps this field - # - # 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. - referencedByFlowFieldInputFieldConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [FlowFieldInputField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfield_filter.doc.html), - orderBy: [FlowFieldInputFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfieldsortorder.doc.html) - ): [FlowFieldInputFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfieldsconnection.doc.html) - # A flow output field that wraps this field - # - # 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. - referencedByFlowFieldOutputField( - filter: [FlowFieldOutputField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfield_filter.doc.html), - orderBy: [FlowFieldOutputFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[FlowFieldOutputField](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfield.doc.html)] - # A flow output field that wraps this field - # - # 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. - referencedByFlowFieldOutputFieldConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [FlowFieldOutputField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfield_filter.doc.html), - orderBy: [FlowFieldOutputFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FlowFieldOutputFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfieldsconnection.doc.html) - # fields that are upstream of this field - # - # 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. - upstreamFields( - filter: [Field_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/field_filter.doc.html), - orderBy: [FieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Field](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.doc.html)]! - # fields that are upstream of this field - # - # 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. - upstreamFieldsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Field_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/field_filter.doc.html), - orderBy: [FieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsconnection.doc.html) - # Metric definitions downstream from this field. - # - # 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/current/api/metadata_api/en-us/reference/metricdefinition_filter.doc.html), - orderBy: [MetricDefinitionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[MetricDefinition](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinition.doc.html)] - # Metric definitions downstream from this field. - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [MetricDefinition_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinition_filter.doc.html), - orderBy: [MetricDefinitionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [MetricDefinitionsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsconnection.doc.html) - # All upstream columns this field references - # - # 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. - upstreamColumns( - filter: [Column_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/column_filter.doc.html), - orderBy: [ColumnSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Column](https://help.tableau.com/current/api/metadata_api/en-us/reference/column.doc.html)]! - # All upstream columns this field references - # - # 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. - upstreamColumnsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Column_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/column_filter.doc.html), - orderBy: [ColumnSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [ColumnsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnsconnection.doc.html) - } ` ## [_link_](#require-by) Require by - [AnalyticsField_Base GraphQL type for a field containing analytics metadata_](https://help.tableau.com/current/api/metadata_api/en-us/reference/analyticsfield.doc.html "AnalyticsField - Base GraphQL type for a field containing analytics metadata") - [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/current/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") - [BinFieldsConnection_Connection Type for BinField_](https://help.tableau.com/current/api/metadata_api/en-us/reference/binfieldsconnection.doc.html "BinFieldsConnection - Connection Type for BinField") - [CalculatedField_GraphQL type for a calculated field. See https://onlinehelp.tableau.com/current/pro/desktop/en-us/calculations\_calculatedfields.html_](https://help.tableau.com/current/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") - [ColumnField_ColumnFields are a type of field which directly connects to a column in some type of table._](https://help.tableau.com/current/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/current/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/current/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") - [DataField_Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField._](https://help.tableau.com/current/api/metadata_api/en-us/reference/datafield.doc.html "DataField - Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField.") - [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/current/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/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [FieldReferencingField_Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula._](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield.doc.html "FieldReferencingField - Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula.") - [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/current/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/current/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") - [Parameter_Tableau Parameter. For more info see https://onlinehelp.tableau.com/current/pro/desktop/en-us/parameters\_create.html_](https://help.tableau.com/current/api/metadata_api/en-us/reference/parameter.doc.html "Parameter - Tableau Parameter. For more info see https://onlinehelp.tableau.com/current/pro/desktop/en-us/parameters_create.html") - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/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/current/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") _menu_ Types INPUT\_OBJECT # BinField\_Filter Filter by GraphQL field and given value ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input BinField_Filter { - # Name shown in server and desktop clients - name: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Name shown in server and desktop clients - nameWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.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/current/api/metadata_api/en-us/reference/id.doc.html) - # Unique identifier used by the metadata API. Not the same as the numeric ID used - # on server - idWithin: [[ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html)] - # True if the field is hidden - isHidden: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) - # True if the field is hidden - isHiddenWithin: [[Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html)] - # Filter the output based on text query. - text: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - } ` ## [_link_](#require-by) Require by - [AnalyticsField_Base GraphQL type for a field containing analytics metadata_](https://help.tableau.com/current/api/metadata_api/en-us/reference/analyticsfield.doc.html "AnalyticsField - Base GraphQL type for a field containing analytics metadata") - [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/current/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/current/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") - [ColumnField_ColumnFields are a type of field which directly connects to a column in some type of table._](https://help.tableau.com/current/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/current/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/current/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") - [DataField_Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField._](https://help.tableau.com/current/api/metadata_api/en-us/reference/datafield.doc.html "DataField - Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField.") - [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/current/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/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [FieldReferencingField_Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula._](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield.doc.html "FieldReferencingField - Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula.") - [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/current/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/current/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") - [Parameter_Tableau Parameter. For more info see https://onlinehelp.tableau.com/current/pro/desktop/en-us/parameters\_create.html_](https://help.tableau.com/current/api/metadata_api/en-us/reference/parameter.doc.html "Parameter - Tableau Parameter. For more info see https://onlinehelp.tableau.com/current/pro/desktop/en-us/parameters_create.html") - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/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/current/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") _menu_ Types INPUT\_OBJECT # BinField\_Required\_Filter Filter by GraphQL field and given value ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input BinField_Required_Filter { - # Name shown in server and desktop clients - name: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Name shown in server and desktop clients - nameWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.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/current/api/metadata_api/en-us/reference/id.doc.html) - # Unique identifier used by the metadata API. Not the same as the numeric ID used - # on server - idWithin: [[ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html)] - } ` ## [_link_](#require-by) Require by This element is not required by anyone _menu_ Types ENUM # BinFieldOrderField Enum for fields that can be used for sorting ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - enum BinFieldOrderField { - # Sort by downstreamSheets count - DOWNSTREAM_SHEETS_COUNT - # Sort by fields count - FIELDS_COUNT - # Sort by dataCategory - DATA_CATEGORY - # Sort by dataType - DATA_TYPE - # Sort by id - ID - # Sort by isHidden - IS_HIDDEN - # Sort by name - NAME - # Sort by role - ROLE - } ` ## [_link_](#require-by) Require by - [BinFieldSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/binfieldsortorder.doc.html "BinFieldSortOrder - 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.") _menu_ Types OBJECT # BinFieldsConnection Connection Type for BinField ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type BinFieldsConnection { - # List of nodes - nodes: [[BinField](https://help.tableau.com/current/api/metadata_api/en-us/reference/binfield.doc.html)!]! - # Information for pagination - pageInfo: [PageInfo](https://help.tableau.com/current/api/metadata_api/en-us/reference/pageinfo.doc.html)! - # Total number of objects in connection - totalCount: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html)! - } ` ## [_link_](#require-by) Require by - [AnalyticsField_Base GraphQL type for a field containing analytics metadata_](https://help.tableau.com/current/api/metadata_api/en-us/reference/analyticsfield.doc.html "AnalyticsField - Base GraphQL type for a field containing analytics metadata") - [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/current/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/current/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") - [ColumnField_ColumnFields are a type of field which directly connects to a column in some type of table._](https://help.tableau.com/current/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/current/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/current/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") - [DataField_Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField._](https://help.tableau.com/current/api/metadata_api/en-us/reference/datafield.doc.html "DataField - Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField.") - [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/current/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/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [FieldReferencingField_Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula._](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield.doc.html "FieldReferencingField - Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula.") - [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/current/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/current/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") - [Parameter_Tableau Parameter. For more info see https://onlinehelp.tableau.com/current/pro/desktop/en-us/parameters\_create.html_](https://help.tableau.com/current/api/metadata_api/en-us/reference/parameter.doc.html "Parameter - Tableau Parameter. For more info see https://onlinehelp.tableau.com/current/pro/desktop/en-us/parameters_create.html") - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/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/current/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") _menu_ Types INPUT\_OBJECT # BinFieldSortOrder 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. ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input BinFieldSortOrder { - # GraphQL field to sort on - field: [BinFieldOrderField](https://help.tableau.com/current/api/metadata_api/en-us/reference/binfieldorderfield.doc.html)! - # Order direction to sort output - direction: [OrderDirection](https://help.tableau.com/current/api/metadata_api/en-us/reference/orderdirection.doc.html)! - } ` ## [_link_](#require-by) Require by - [AnalyticsField_Base GraphQL type for a field containing analytics metadata_](https://help.tableau.com/current/api/metadata_api/en-us/reference/analyticsfield.doc.html "AnalyticsField - Base GraphQL type for a field containing analytics metadata") - [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/current/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/current/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") - [ColumnField_ColumnFields are a type of field which directly connects to a column in some type of table._](https://help.tableau.com/current/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/current/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/current/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") - [DataField_Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField._](https://help.tableau.com/current/api/metadata_api/en-us/reference/datafield.doc.html "DataField - Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField.") - [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/current/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/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [FieldReferencingField_Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula._](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield.doc.html "FieldReferencingField - Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula.") - [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/current/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/current/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") - [Parameter_Tableau Parameter. For more info see https://onlinehelp.tableau.com/current/pro/desktop/en-us/parameters\_create.html_](https://help.tableau.com/current/api/metadata_api/en-us/reference/parameter.doc.html "Parameter - Tableau Parameter. For more info see https://onlinehelp.tableau.com/current/pro/desktop/en-us/parameters_create.html") - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/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/current/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") _menu_ Types SCALAR # Boolean Built-in Boolean ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - scalar Boolean ` ## [_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/current/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") - [BinField\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/binfield_filter.doc.html "BinField_Filter - Filter by GraphQL field and given value") - [CalculatedField_GraphQL type for a calculated field. See https://onlinehelp.tableau.com/current/pro/desktop/en-us/calculations\_calculatedfields.html_](https://help.tableau.com/current/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") - [CalculatedField\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/calculatedfield_filter.doc.html "CalculatedField_Filter - Filter by GraphQL field and given value") - [Certifiable_A content item that can be certified_](https://help.tableau.com/current/api/metadata_api/en-us/reference/certifiable.doc.html "Certifiable - A content item that can be certified") - [Certifiable\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/certifiable_filter.doc.html "Certifiable_Filter - Filter by GraphQL field and given value") - [CloudFile_A cloud file connection_](https://help.tableau.com/current/api/metadata_api/en-us/reference/cloudfile.doc.html "CloudFile - A cloud file connection") - [CloudFile\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/cloudfile_filter.doc.html "CloudFile_Filter - Filter by GraphQL field and given value") - [Column_GraphQL type for a table column_](https://help.tableau.com/current/api/metadata_api/en-us/reference/column.doc.html "Column - GraphQL type for a table column") - [Column\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/column_filter.doc.html "Column_Filter - Filter by GraphQL field and given value") - [ColumnField_ColumnFields are a type of field which directly connects to a column in some type of table._](https://help.tableau.com/current/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.") - [ColumnField\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnfield_filter.doc.html "ColumnField_Filter - Filter by GraphQL field and given value") - [CombinedField_GraphQL type for a combined field. Combined fields concatanate fields together into one string._](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedfield.doc.html "CombinedField - GraphQL type for a combined field. Combined fields concatanate fields together into one string.") - [CombinedField\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedfield_filter.doc.html "CombinedField_Filter - Filter by GraphQL field and given value") - [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/current/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") - [CombinedSetField\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedsetfield_filter.doc.html "CombinedSetField_Filter - Filter by GraphQL field and given value") - [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/current/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.") - [CustomSQLTable\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/customsqltable_filter.doc.html "CustomSQLTable_Filter - Filter by GraphQL field and given value") - [Database_A database containing tables_](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html "Database - A database containing tables") - [Database\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/database_filter.doc.html "Database_Filter - Filter by GraphQL field and given value") - [DatabaseServer_A database server connection_](https://help.tableau.com/current/api/metadata_api/en-us/reference/databaseserver.doc.html "DatabaseServer - A database server connection") - [DatabaseServer\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/databaseserver_filter.doc.html "DatabaseServer_Filter - Filter by GraphQL field and given value") - [DatabaseTable_A table that is contained in a database_](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable.doc.html "DatabaseTable - A table that is contained in a database") - [DatabaseTable\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html "DatabaseTable_Filter - Filter by GraphQL field and given value") - [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.*") - [DataCloud\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/datacloud_filter.doc.html "DataCloud_Filter - Filter by GraphQL field and given value") - [DataQualityCertification_A data quality certification associated with a content item_](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitycertification.doc.html "DataQualityCertification - A data quality certification associated with a content item") - [DataQualityCertification\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitycertification_filter.doc.html "DataQualityCertification_Filter - Filter by GraphQL field and given value") - [DataQualityWarning_A data quality warning associated with a content item_](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarning.doc.html "DataQualityWarning - A data quality warning associated with a content item") - [DataQualityWarning\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarning_filter.doc.html "DataQualityWarning_Filter - Filter by GraphQL field and given value") - [Datasource_Root GraphQL type for embedded and published data sources Data sources are a way to represent how Tableau Desktop and Tableau Server model and connect to data. Data sources can be published separately, as a published data source, or may be contained in a workbook as an embedded data source. See https://onlinehelp.tableau.com/current/server/en-us/datasource.htm_](datasource.doc.html "Datasource - Root GraphQL type for embedded and published data sources Data sources are a way to represent how Tableau Desktop and Tableau Server model and connect to data. Data sources can be published separately, as a published data source, or may be contained in a workbook as an embedded data source. See https://onlinehelp.tableau.com/current/server/en-us/datasource.htm") - [Datasource\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasource_filter.doc.html "Datasource_Filter - Filter by GraphQL field and given value") - [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/current/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.") - [DatasourceField\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefield_filter.doc.html "DatasourceField_Filter - Filter by GraphQL field and given value") - [EmbeddedDatasource_A data source embedded in a workbook_](https://help.tableau.com/current/api/metadata_api/en-us/reference/embeddeddatasource.doc.html "EmbeddedDatasource - A data source embedded in a workbook") - [EmbeddedDatasource\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/embeddeddatasource_filter.doc.html "EmbeddedDatasource_Filter - Filter by GraphQL field and given value") - [Field_Base GraphQL type for a field_](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [Field\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/field_filter.doc.html "Field_Filter - Filter by GraphQL field and given value") - [File_A file connection_](https://help.tableau.com/current/api/metadata_api/en-us/reference/file.doc.html "File - A file connection") - [File\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/file_filter.doc.html "File_Filter - Filter by GraphQL field and given value") - [Flow_Flows are used to prepare data, which can include aggregation, cleaning, preprocessing, etc._](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow.doc.html "Flow - Flows are used to prepare data, which can include aggregation, cleaning, preprocessing, etc.") - [Flow\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow_filter.doc.html "Flow_Filter - Filter by GraphQL field and given value") - [GenericLabel_A label that can be attached to assets. \*Available in Tableau Cloud March 2023 / Server 2023.1 and later.\*_](genericlabel.doc.html "GenericLabel - A label that can be attached to assets. *Available in Tableau Cloud March 2023 / Server 2023.1 and later.*") - [GenericLabel\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/genericlabel_filter.doc.html "GenericLabel_Filter - Filter by GraphQL field and given value") - [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/current/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") - [GroupField\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/groupfield_filter.doc.html "GroupField_Filter - Filter by GraphQL field and given value") - [HierarchyField_GraphQL type for a hierarchy. See https://onlinehelp.tableau.com/current/pro/desktop/en-us/qs\_hierarchies.html_](https://help.tableau.com/current/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") - [HierarchyField\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/hierarchyfield_filter.doc.html "HierarchyField_Filter - Filter by GraphQL field and given value") - [Label_A label that can be attached to assets. \*Available in Tableau Cloud March 2023 / Server 2023.1 and later.\*_](label.doc.html "Label - A label that can be attached to assets. *Available in Tableau Cloud March 2023 / Server 2023.1 and later.*") - [Label\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/label_filter.doc.html "Label_Filter - Filter by GraphQL field and given value") - [PageInfo_Information about pagination in a connection_](https://help.tableau.com/current/api/metadata_api/en-us/reference/pageinfo.doc.html "PageInfo - Information about pagination in a connection") - [PublishedDatasource_A Tableau data source that has been published separately to Tableau Server. It can be used by multiple workbooks._](https://help.tableau.com/current/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.") - [PublishedDatasource\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html "PublishedDatasource_Filter - Filter by GraphQL field and given value") - [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/current/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") - [SetField\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/setfield_filter.doc.html "SetField_Filter - Filter by GraphQL field and given value") - [Table_A table containing columns_](https://help.tableau.com/current/api/metadata_api/en-us/reference/table.doc.html "Table - A table containing columns") - [VirtualConnection_A virtual connection. \*Available in Tableau Cloud March 2022 / Server 2022.1 and later.\*_](virtualconnection.doc.html "VirtualConnection - A virtual connection. *Available in Tableau Cloud March 2022 / Server 2022.1 and later.*") - [VirtualConnection\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html "VirtualConnection_Filter - Filter by GraphQL field and given value") - [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.*") - [VirtualConnectionTable\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html "VirtualConnectionTable_Filter - Filter by GraphQL field and given value") - [Warnable_A content item that can have data quality warnings_](https://help.tableau.com/current/api/metadata_api/en-us/reference/warnable.doc.html "Warnable - A content item that can have data quality warnings") - [Warnable\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/warnable_filter.doc.html "Warnable_Filter - Filter by GraphQL field and given value") - [WebDataConnector_A web data connector_](https://help.tableau.com/current/api/metadata_api/en-us/reference/webdataconnector.doc.html "WebDataConnector - A web data connector") - [WebDataConnector\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/webdataconnector_filter.doc.html "WebDataConnector_Filter - Filter by GraphQL field and given value") - [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/current/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).") - [Workbook\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbook_filter.doc.html "Workbook_Filter - Filter by GraphQL field and given value") - [\_\_Directive_null_](https://help.tableau.com/current/api/metadata_api/en-us/reference/directive.spec.html "__Directive - ") - [\_\_EnumValue_null_](https://help.tableau.com/current/api/metadata_api/en-us/reference/enumvalue.spec.html "__EnumValue - ") - [\_\_Field_null_](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.spec.html "__Field - ") - [\_\_InputValue_null_](https://help.tableau.com/current/api/metadata_api/en-us/reference/inputvalue.spec.html "__InputValue - ") - [\_\_Type_null_](https://help.tableau.com/current/api/metadata_api/en-us/reference/type.spec.html "__Type - ") _menu_ Types OBJECT # CalculatedField GraphQL type for a calculated field. See [https://onlinehelp.tableau.com/current/pro/desktop/en-us/calculations\_calculatedfields.html](https://onlinehelp.tableau.com/current/pro/desktop/en-us/calculations_calculatedfields.html) ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type CalculatedField implements [Field](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.doc.html), [DataField](https://help.tableau.com/current/api/metadata_api/en-us/reference/datafield.doc.html), [AnalyticsField](https://help.tableau.com/current/api/metadata_api/en-us/reference/analyticsfield.doc.html), [FieldReferencingField](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield.doc.html), [Node](https://help.tableau.com/current/api/metadata_api/en-us/reference/node.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/current/api/metadata_api/en-us/reference/id.doc.html)! - # Name shown in server and desktop clients - name: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Name internally used to uniquely identify fields - fullyQualifiedName: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Description of field shown in server and desktop clients - description: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # description that is shown in the Tableau UI - # - # Arguments - # **inheritanceType**: Method for selecting inherited value - # **permissionMode**: Option to select how to apply permissions. By - # default it is OBFUSCATE_RESULTS - descriptionInherited( - inheritanceType: [InheritanceType](https://help.tableau.com/current/api/metadata_api/en-us/reference/inheritancetype.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[InheritedStringResult](https://help.tableau.com/current/api/metadata_api/en-us/reference/inheritedstringresult.doc.html)] - # True if the field is hidden - isHidden: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) - # Name of folder if the field is in a folder. See - # https://onlinehelp.tableau.com/current/pro/desktop/en-us/datafields_dwfeatures.html#Organize - folderName: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Data category of the field - dataCategory: [FieldRoleCategory](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldrolecategory.doc.html) - # Role of the field: 'dimension', 'measure' or 'unknown' - role: [FieldRole](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldrole.doc.html) - # Type of the data in the field. See - # https://onlinehelp.tableau.com/current/pro/desktop/en-us/datafields_typesandroles_datatypes.html - dataType: [FieldDataType](https://help.tableau.com/current/api/metadata_api/en-us/reference/fielddatatype.doc.html) - # Default format for number or date - defaultFormat: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # For geographic data, the geographic role of the field. See - # https://onlinehelp.tableau.com/current/pro/desktop/en-us/maps_geographicroles.html - semanticRole: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Default aggregation of the field, i.e. 'Sum', 'Average'. See - # https://onlinehelp.tableau.com/current/pro/desktop/en-us/calculations_aggregation.html#AggFuncs - aggregation: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # For the percentile aggregation, the percentile number - aggregationParam: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Formula of the calculated field - formula: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # True if Tableau automatically created this field. A list of autogenerated fields - # are here: - # https://onlinehelp.tableau.com/current/pro/desktop/en-us/datafields_understanddatawindow.html#AutoFields - isAutoGenerated: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) - # True if field formula that involves a user function (for example, USERNAME or - # ISMEMBEROF) - hasUserReference: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) - # List of fields, if any, that this field references - # - # 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. - fields( - filter: [Field_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/field_filter.doc.html), - orderBy: [FieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Field](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.doc.html)!]! - # List of fields, if any, that this field references - # - # 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. - fieldsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Field_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/field_filter.doc.html), - orderBy: [FieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsconnection.doc.html) - # List of parameters, if any, used in this field - # - # 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. - parameters( - filter: [Parameter_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/parameter_filter.doc.html), - orderBy: [ParameterSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/parametersortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Parameter](https://help.tableau.com/current/api/metadata_api/en-us/reference/parameter.doc.html)!]! - # List of parameters, if any, used in this field - # - # 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. - parametersConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Parameter_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/parameter_filter.doc.html), - orderBy: [ParameterSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/parametersortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [ParametersConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/parametersconnection.doc.html) - # Columns downstream of this field - # - # 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. - downstreamColumns( - filter: [Column_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/column_filter.doc.html), - orderBy: [ColumnSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Column](https://help.tableau.com/current/api/metadata_api/en-us/reference/column.doc.html)!]! - # Columns downstream of this field - # - # 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. - downstreamColumnsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Column_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/column_filter.doc.html), - orderBy: [ColumnSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [ColumnsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnsconnection.doc.html) - # Tables downstream of this field - # - # 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. - downstreamTables( - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DatabaseTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable.doc.html)!]! - # Tables downstream of this field - # - # 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. - downstreamTablesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabaseTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesconnection.doc.html) - # Virtual connection tables downstream of this field - # - # 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/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnectionTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable.doc.html)!]! - # Virtual connection tables downstream of this field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnectionTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesconnection.doc.html) - # Virtual connections downstream of this field - # - # 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. - downstreamVirtualConnections( - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection.doc.html)!]! - # Virtual connections downstream of this field - # - # 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. - downstreamVirtualConnectionsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsconnection.doc.html) - # Databases downstream of this field - # - # 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. - downstreamDatabases( - filter: [Database_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Database](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html)!]! - # Databases downstream of this field - # - # 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. - downstreamDatabasesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Database_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabasesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesconnection.doc.html) - # Flows downstream of this field - # - # 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/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Flow](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow.doc.html)!]! - # Flows downstream of this field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Flow_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FlowsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsconnection.doc.html) - # downstream fields that reference this field - # - # 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. - downstreamFields( - filter: [Field_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/field_filter.doc.html), - orderBy: [FieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Field](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.doc.html)!]! - # downstream fields that reference this field - # - # 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. - downstreamFieldsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Field_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/field_filter.doc.html), - orderBy: [FieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsconnection.doc.html) - # Datasources connected downstream from this field - # - # 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/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[PublishedDatasource](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource.doc.html)!] - # Datasources connected downstream from this field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [PublishedDatasource_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [PublishedDatasourcesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesconnection.doc.html) - # Lenses connected downstream from this field - # - # 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/current/api/metadata_api/en-us/reference/lens_filter.doc.html), - orderBy: [LensSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/lenssortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Lens](https://help.tableau.com/current/api/metadata_api/en-us/reference/lens.doc.html)!] - # Lenses connected downstream from this field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Lens_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/lens_filter.doc.html), - orderBy: [LensSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/lenssortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [LensesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensesconnection.doc.html) - # Sheets connected downstream from the field - # - # 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/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Sheet](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html)!]! - # Sheets connected downstream from the field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Sheet_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [SheetsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsconnection.doc.html) - # Dashboards connected downstream from the field - # - # 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/current/api/metadata_api/en-us/reference/dashboard_filter.doc.html), - orderBy: [DashboardSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboardsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Dashboard](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard.doc.html)!]! - # Dashboards connected downstream from the field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Dashboard_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard_filter.doc.html), - orderBy: [DashboardSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboardsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DashboardsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboardsconnection.doc.html) - # Workbooks connected downstream from the field - # - # 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/current/api/metadata_api/en-us/reference/workbook_filter.doc.html), - orderBy: [WorkbookSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Workbook](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbook.doc.html)!] - # Workbooks connected downstream from the field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Workbook_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbook_filter.doc.html), - orderBy: [WorkbookSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [WorkbooksConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksconnection.doc.html) - # Metrics connected downstream from the field - # - # 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/current/api/metadata_api/en-us/reference/metric_filter.doc.html), - orderBy: [MetricSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Metric](https://help.tableau.com/current/api/metadata_api/en-us/reference/metric.doc.html)!] - # Metrics connected downstream from the field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Metric_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metric_filter.doc.html), - orderBy: [MetricSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [MetricsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricsconnection.doc.html) - # Workbook owners (authors) connected downstream from the field - # - # 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/current/api/metadata_api/en-us/reference/tableauuser_filter.doc.html), - orderBy: [TableauUserSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauusersortorder.doc.html) - ): [[TableauUser](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauuser.doc.html)!] - # Workbook owners (authors) connected downstream from the field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [TableauUser_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauuser_filter.doc.html), - orderBy: [TableauUserSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauusersortorder.doc.html) - ): [TableauUsersConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauusersconnection.doc.html) - # Tables connected upstream from the field - # - # 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/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DatabaseTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable.doc.html)!]! - # Tables connected upstream from the field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabaseTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesconnection.doc.html) - # Virtual connection tables upstream of this field - # - # 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/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnectionTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable.doc.html)!]! - # Virtual connection tables upstream of this field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnectionTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesconnection.doc.html) - # Virtual connections upstream of this field - # - # 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. - upstreamVirtualConnections( - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection.doc.html)!]! - # Virtual connections upstream of this field - # - # 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. - upstreamVirtualConnectionsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsconnection.doc.html) - # Databases connected upstream from the field - # - # 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/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Database](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html)!]! - # Databases connected upstream from the field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Database_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabasesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesconnection.doc.html) - # Flows connected upstream from the field - # - # 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/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Flow](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow.doc.html)!]! - # Flows connected upstream from the field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Flow_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FlowsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsconnection.doc.html) - # Datasources connected upstream from the field - # - # 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/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[PublishedDatasource](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource.doc.html)!]! - # Datasources connected upstream from the field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [PublishedDatasource_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [PublishedDatasourcesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesconnection.doc.html) - # The field that references this field - # - # 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. - referencedByFields( - filter: [FieldReferencingField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield_filter.doc.html), - orderBy: [FieldReferencingFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[FieldReferencingField](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield.doc.html)] - # The field that references this field - # - # 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. - referencedByFieldsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [FieldReferencingField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield_filter.doc.html), - orderBy: [FieldReferencingFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FieldReferencingFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfieldsconnection.doc.html) - # Data source that contains this field - datasource: [Datasource](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasource.doc.html) - # Metric definitions that reference this data source field. - # - # 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. - metricDefinitions( - filter: [MetricDefinition_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinition_filter.doc.html), - orderBy: [MetricDefinitionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[MetricDefinition](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinition.doc.html)] - # Metric definitions that reference this data source field. - # - # 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. - metricDefinitionsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [MetricDefinition_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinition_filter.doc.html), - orderBy: [MetricDefinitionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [MetricDefinitionsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsconnection.doc.html) - # The data source filters that include this field - # - # 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. - referencedByFilters( - filter: [DatasourceFilter_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefilter_filter.doc.html), - orderBy: [DatasourceFilterSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefiltersortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DatasourceFilter](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefilter.doc.html)] - # The data source filters that include this field - # - # 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. - referencedByFiltersConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DatasourceFilter_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefilter_filter.doc.html), - orderBy: [DatasourceFilterSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefiltersortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatasourceFiltersConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefiltersconnection.doc.html) - # The bin field that references this field - # - # 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. - referencedByBins( - filter: [BinField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/binfield_filter.doc.html), - orderBy: [BinFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/binfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[BinField](https://help.tableau.com/current/api/metadata_api/en-us/reference/binfield.doc.html)] - # The bin field that references this field - # - # 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. - referencedByBinsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [BinField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/binfield_filter.doc.html), - orderBy: [BinFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/binfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [BinFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/binfieldsconnection.doc.html) - # The calculated field that references this field - # - # 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. - referencedByCalculations( - filter: [CalculatedField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/calculatedfield_filter.doc.html), - orderBy: [CalculatedFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/calculatedfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[CalculatedField](https://help.tableau.com/current/api/metadata_api/en-us/reference/calculatedfield.doc.html)] - # The calculated field that references this field - # - # 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. - referencedByCalculationsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [CalculatedField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/calculatedfield_filter.doc.html), - orderBy: [CalculatedFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/calculatedfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [CalculatedFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/calculatedfieldsconnection.doc.html) - # The combined field that references this field - # - # 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. - referencedByCombinedFields( - filter: [CombinedField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedfield_filter.doc.html), - orderBy: [CombinedFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[CombinedField](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedfield.doc.html)] - # The combined field that references this field - # - # 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. - referencedByCombinedFieldsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [CombinedField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedfield_filter.doc.html), - orderBy: [CombinedFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [CombinedFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedfieldsconnection.doc.html) - # Thie combined set field that references this field - # - # 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. - referencedByCombinedSets( - filter: [CombinedSetField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedsetfield_filter.doc.html), - orderBy: [CombinedSetFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedsetfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[CombinedSetField](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedsetfield.doc.html)] - # Thie combined set field that references this field - # - # 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. - referencedByCombinedSetsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [CombinedSetField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedsetfield_filter.doc.html), - orderBy: [CombinedSetFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedsetfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [CombinedSetFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedsetfieldsconnection.doc.html) - # The field that references this remote field - # - # 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. - referencedByRemoteFields( - filter: [DatasourceField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefield_filter.doc.html), - orderBy: [DatasourceFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DatasourceField](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefield.doc.html)] - # The field that references this remote field - # - # 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. - referencedByRemoteFieldsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DatasourceField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefield_filter.doc.html), - orderBy: [DatasourceFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatasourceFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefieldsconnection.doc.html) - # The group field that references this field - # - # 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. - referencedByGroups( - filter: [GroupField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/groupfield_filter.doc.html), - orderBy: [GroupFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/groupfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[GroupField](https://help.tableau.com/current/api/metadata_api/en-us/reference/groupfield.doc.html)] - # The group field that references this field - # - # 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. - referencedByGroupsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [GroupField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/groupfield_filter.doc.html), - orderBy: [GroupFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/groupfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [GroupFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/groupfieldsconnection.doc.html) - # The set field that this field references - # - # 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. - referencedBySets( - filter: [SetField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/setfield_filter.doc.html), - orderBy: [SetFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/setfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[SetField](https://help.tableau.com/current/api/metadata_api/en-us/reference/setfield.doc.html)] - # The set field that this field references - # - # 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. - referencedBySetsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [SetField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/setfield_filter.doc.html), - orderBy: [SetFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/setfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [SetFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/setfieldsconnection.doc.html) - # The hierarchy field that references this field - # - # 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. - referencedByHierarchies( - filter: [HierarchyField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/hierarchyfield_filter.doc.html), - orderBy: [HierarchyFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/hierarchyfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[HierarchyField](https://help.tableau.com/current/api/metadata_api/en-us/reference/hierarchyfield.doc.html)] - # The hierarchy field that references this field - # - # 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. - referencedByHierarchiesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [HierarchyField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/hierarchyfield_filter.doc.html), - orderBy: [HierarchyFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/hierarchyfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [HierarchyFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/hierarchyfieldsconnection.doc.html) - # Sheet that contains this calculated field - sheet: [Sheet](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html) - # Sheets that reference this data source field - # - # 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. - sheets( - filter: [Sheet_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Sheet](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html)] - # Sheets that reference this data source field - # - # 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. - sheetsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Sheet_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [SheetsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsconnection.doc.html) - # Sheets that reference this field - # - # 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. - directSheets( - filter: [Sheet_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Sheet](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html)] - # Sheets that reference this field - # - # 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. - directSheetsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Sheet_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [SheetsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsconnection.doc.html) - # List of lens fields which are derived from this field - # - # 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. - derivedLensFields( - filter: [LensField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensfield_filter.doc.html), - orderBy: [LensFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[LensField](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensfield.doc.html)] - # List of lens fields which are derived from this field - # - # 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. - derivedLensFieldsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [LensField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensfield_filter.doc.html), - orderBy: [LensFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [LensFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensfieldsconnection.doc.html) - # A flow input field that wraps this field - # - # 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. - referencedByFlowFieldInputField( - filter: [FlowFieldInputField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfield_filter.doc.html), - orderBy: [FlowFieldInputFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfieldsortorder.doc.html) - ): [[FlowFieldInputField](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfield.doc.html)] - # A flow input field that wraps this field - # - # 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. - referencedByFlowFieldInputFieldConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [FlowFieldInputField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfield_filter.doc.html), - orderBy: [FlowFieldInputFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfieldsortorder.doc.html) - ): [FlowFieldInputFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfieldsconnection.doc.html) - # A flow output field that wraps this field - # - # 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. - referencedByFlowFieldOutputField( - filter: [FlowFieldOutputField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfield_filter.doc.html), - orderBy: [FlowFieldOutputFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[FlowFieldOutputField](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfield.doc.html)] - # A flow output field that wraps this field - # - # 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. - referencedByFlowFieldOutputFieldConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [FlowFieldOutputField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfield_filter.doc.html), - orderBy: [FlowFieldOutputFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FlowFieldOutputFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfieldsconnection.doc.html) - # fields that are upstream of this field - # - # 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. - upstreamFields( - filter: [Field_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/field_filter.doc.html), - orderBy: [FieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Field](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.doc.html)]! - # fields that are upstream of this field - # - # 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. - upstreamFieldsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Field_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/field_filter.doc.html), - orderBy: [FieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsconnection.doc.html) - # Metric definitions downstream from this field. - # - # 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/current/api/metadata_api/en-us/reference/metricdefinition_filter.doc.html), - orderBy: [MetricDefinitionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[MetricDefinition](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinition.doc.html)] - # Metric definitions downstream from this field. - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [MetricDefinition_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinition_filter.doc.html), - orderBy: [MetricDefinitionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [MetricDefinitionsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsconnection.doc.html) - # All upstream columns this field references - # - # 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. - upstreamColumns( - filter: [Column_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/column_filter.doc.html), - orderBy: [ColumnSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Column](https://help.tableau.com/current/api/metadata_api/en-us/reference/column.doc.html)]! - # All upstream columns this field references - # - # 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. - upstreamColumnsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Column_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/column_filter.doc.html), - orderBy: [ColumnSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [ColumnsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnsconnection.doc.html) - } ` ## [_link_](#require-by) Require by - [AnalyticsField_Base GraphQL type for a field containing analytics metadata_](https://help.tableau.com/current/api/metadata_api/en-us/reference/analyticsfield.doc.html "AnalyticsField - Base GraphQL type for a field containing analytics metadata") - [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/current/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/current/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") - [CalculatedFieldsConnection_Connection Type for CalculatedField_](https://help.tableau.com/current/api/metadata_api/en-us/reference/calculatedfieldsconnection.doc.html "CalculatedFieldsConnection - Connection Type for CalculatedField") - [ColumnField_ColumnFields are a type of field which directly connects to a column in some type of table._](https://help.tableau.com/current/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/current/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/current/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") - [DataField_Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField._](https://help.tableau.com/current/api/metadata_api/en-us/reference/datafield.doc.html "DataField - Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField.") - [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/current/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/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [FieldReferencingField_Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula._](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield.doc.html "FieldReferencingField - Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula.") - [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/current/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/current/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") - [Parameter_Tableau Parameter. For more info see https://onlinehelp.tableau.com/current/pro/desktop/en-us/parameters\_create.html_](https://help.tableau.com/current/api/metadata_api/en-us/reference/parameter.doc.html "Parameter - Tableau Parameter. For more info see https://onlinehelp.tableau.com/current/pro/desktop/en-us/parameters_create.html") - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/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/current/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") - [Sheet_A sheet contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html "Sheet - A sheet contained in a published workbook.") _menu_ Types INPUT\_OBJECT # CalculatedField\_Filter Filter by GraphQL field and given value ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input CalculatedField_Filter { - # Name shown in server and desktop clients - name: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Name shown in server and desktop clients - nameWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.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/current/api/metadata_api/en-us/reference/id.doc.html) - # Unique identifier used by the metadata API. Not the same as the numeric ID used - # on server - idWithin: [[ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html)] - # True if the field is hidden - isHidden: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) - # True if the field is hidden - isHiddenWithin: [[Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html)] - # Filter the output based on text query. - text: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - } ` ## [_link_](#require-by) Require by - [AnalyticsField_Base GraphQL type for a field containing analytics metadata_](https://help.tableau.com/current/api/metadata_api/en-us/reference/analyticsfield.doc.html "AnalyticsField - Base GraphQL type for a field containing analytics metadata") - [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/current/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/current/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") - [ColumnField_ColumnFields are a type of field which directly connects to a column in some type of table._](https://help.tableau.com/current/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/current/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/current/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") - [DataField_Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField._](https://help.tableau.com/current/api/metadata_api/en-us/reference/datafield.doc.html "DataField - Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField.") - [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/current/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/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [FieldReferencingField_Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula._](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield.doc.html "FieldReferencingField - Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula.") - [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/current/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/current/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") - [Parameter_Tableau Parameter. For more info see https://onlinehelp.tableau.com/current/pro/desktop/en-us/parameters\_create.html_](https://help.tableau.com/current/api/metadata_api/en-us/reference/parameter.doc.html "Parameter - Tableau Parameter. For more info see https://onlinehelp.tableau.com/current/pro/desktop/en-us/parameters_create.html") - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/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/current/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") - [Sheet_A sheet contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html "Sheet - A sheet contained in a published workbook.") _menu_ Types INPUT\_OBJECT # CalculatedField\_Required\_Filter Filter by GraphQL field and given value ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input CalculatedField_Required_Filter { - # Name shown in server and desktop clients - name: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Name shown in server and desktop clients - nameWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.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/current/api/metadata_api/en-us/reference/id.doc.html) - # Unique identifier used by the metadata API. Not the same as the numeric ID used - # on server - idWithin: [[ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html)] - } ` ## [_link_](#require-by) Require by This element is not required by anyone _menu_ Types ENUM # CalculatedFieldOrderField Enum for fields that can be used for sorting ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - enum CalculatedFieldOrderField { - # Sort by downstreamSheets count - DOWNSTREAM_SHEETS_COUNT - # Sort by fields count - FIELDS_COUNT - # Sort by dataCategory - DATA_CATEGORY - # Sort by dataType - DATA_TYPE - # Sort by id - ID - # Sort by isHidden - IS_HIDDEN - # Sort by name - NAME - # Sort by role - ROLE - } ` ## [_link_](#require-by) Require by - [CalculatedFieldSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/calculatedfieldsortorder.doc.html "CalculatedFieldSortOrder - 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.") _menu_ Types OBJECT # CalculatedFieldsConnection Connection Type for CalculatedField ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type CalculatedFieldsConnection { - # List of nodes - nodes: [[CalculatedField](https://help.tableau.com/current/api/metadata_api/en-us/reference/calculatedfield.doc.html)!]! - # Information for pagination - pageInfo: [PageInfo](https://help.tableau.com/current/api/metadata_api/en-us/reference/pageinfo.doc.html)! - # Total number of objects in connection - totalCount: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html)! - } ` ## [_link_](#require-by) Require by - [AnalyticsField_Base GraphQL type for a field containing analytics metadata_](https://help.tableau.com/current/api/metadata_api/en-us/reference/analyticsfield.doc.html "AnalyticsField - Base GraphQL type for a field containing analytics metadata") - [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/current/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/current/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") - [ColumnField_ColumnFields are a type of field which directly connects to a column in some type of table._](https://help.tableau.com/current/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/current/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/current/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") - [DataField_Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField._](https://help.tableau.com/current/api/metadata_api/en-us/reference/datafield.doc.html "DataField - Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField.") - [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/current/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/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [FieldReferencingField_Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula._](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield.doc.html "FieldReferencingField - Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula.") - [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/current/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/current/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") - [Parameter_Tableau Parameter. For more info see https://onlinehelp.tableau.com/current/pro/desktop/en-us/parameters\_create.html_](https://help.tableau.com/current/api/metadata_api/en-us/reference/parameter.doc.html "Parameter - Tableau Parameter. For more info see https://onlinehelp.tableau.com/current/pro/desktop/en-us/parameters_create.html") - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/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/current/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") - [Sheet_A sheet contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html "Sheet - A sheet contained in a published workbook.") _menu_ Types INPUT\_OBJECT # CalculatedFieldSortOrder 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. ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input CalculatedFieldSortOrder { - # GraphQL field to sort on - field: [CalculatedFieldOrderField](https://help.tableau.com/current/api/metadata_api/en-us/reference/calculatedfieldorderfield.doc.html)! - # Order direction to sort output - direction: [OrderDirection](https://help.tableau.com/current/api/metadata_api/en-us/reference/orderdirection.doc.html)! - } ` ## [_link_](#require-by) Require by - [AnalyticsField_Base GraphQL type for a field containing analytics metadata_](https://help.tableau.com/current/api/metadata_api/en-us/reference/analyticsfield.doc.html "AnalyticsField - Base GraphQL type for a field containing analytics metadata") - [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/current/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/current/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") - [ColumnField_ColumnFields are a type of field which directly connects to a column in some type of table._](https://help.tableau.com/current/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/current/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/current/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") - [DataField_Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField._](https://help.tableau.com/current/api/metadata_api/en-us/reference/datafield.doc.html "DataField - Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField.") - [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/current/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/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [FieldReferencingField_Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula._](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield.doc.html "FieldReferencingField - Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula.") - [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/current/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/current/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") - [Parameter_Tableau Parameter. For more info see https://onlinehelp.tableau.com/current/pro/desktop/en-us/parameters\_create.html_](https://help.tableau.com/current/api/metadata_api/en-us/reference/parameter.doc.html "Parameter - Tableau Parameter. For more info see https://onlinehelp.tableau.com/current/pro/desktop/en-us/parameters_create.html") - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/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/current/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") - [Sheet_A sheet contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html "Sheet - A sheet contained in a published workbook.") _menu_ Types INTERFACE # CanHaveLabels A content item that can have labels. _Available in Tableau Cloud March 2023 / Server 2023.1 and later._ ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - interface CanHaveLabels { - # Unique identifier used by the metadata API. Not the same as the numeric ID used - # on server - id: [ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html)! - # The name of the asset - name: [String](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/string.doc.html)! - # The labels on a content item. 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/current/api/metadata_api/en-us/reference/label_filter.doc.html), - orderBy: [LabelSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/labelsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Label](https://help.tableau.com/current/api/metadata_api/en-us/reference/label.doc.html)!]! - # The labels on a content item. 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Label_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/label_filter.doc.html), - orderBy: [LabelSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/labelsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [LabelsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/labelsconnection.doc.html) - } ` ## [_link_](#require-by) Require by - [CanHaveLabelsesConnection_Connection Type for CanHaveLabels_](https://help.tableau.com/current/api/metadata_api/en-us/reference/canhavelabelsesconnection.doc.html "CanHaveLabelsesConnection - Connection Type for CanHaveLabels") - [CloudFile_A cloud file connection_](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/column.doc.html "Column - GraphQL type for a table column") - [DatabaseServer_A database server connection_](https://help.tableau.com/current/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/current/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.*") - [DataQualityCertification_A data quality certification associated with a content item_](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitycertification.doc.html "DataQualityCertification - A data quality certification associated with a content item") - [DataQualityWarning_A data quality warning associated with a content item_](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarning.doc.html "DataQualityWarning - A data quality warning associated with a content item") - [File_A file connection_](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/flow.doc.html "Flow - Flows are used to prepare data, which can include aggregation, cleaning, preprocessing, etc.") - [GenericLabel_A label that can be attached to assets. \*Available in Tableau Cloud March 2023 / Server 2023.1 and later.\*_](genericlabel.doc.html "GenericLabel - A label that can be attached to assets. *Available in Tableau Cloud March 2023 / Server 2023.1 and later.*") - [Label_A label that can be attached to assets. \*Available in Tableau Cloud March 2023 / Server 2023.1 and later.\*_](label.doc.html "Label - A label that can be attached to assets. *Available in Tableau Cloud March 2023 / Server 2023.1 and later.*") - [PublishedDatasource_A Tableau data source that has been published separately to Tableau Server. It can be used by multiple workbooks._](https://help.tableau.com/current/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.") - [VirtualConnection_A virtual connection. \*Available in Tableau Cloud March 2022 / Server 2022.1 and later.\*_](virtualconnection.doc.html "VirtualConnection - A virtual connection. *Available in Tableau Cloud March 2022 / Server 2022.1 and later.*") - [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/current/api/metadata_api/en-us/reference/webdataconnector.doc.html "WebDataConnector - A web data connector") _menu_ Types INPUT\_OBJECT # CanHaveLabels\_Filter Filter by GraphQL field and given value ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input CanHaveLabels_Filter { - # Locally unique identifier used for the REST API on the Tableau Server - luid: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Locally unique identifier used for the REST API on the Tableau Server - luidWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.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/current/api/metadata_api/en-us/reference/id.doc.html) - # Unique identifier used by the metadata API. Not the same as the numeric ID used - # on server - idWithin: [[ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html)] - } ` ## [_link_](#require-by) Require by This element is not required by anyone _menu_ Types OBJECT # CanHaveLabelsesConnection Connection Type for CanHaveLabels ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type CanHaveLabelsesConnection { - # List of nodes - nodes: [[CanHaveLabels](https://help.tableau.com/current/api/metadata_api/en-us/reference/canhavelabels.doc.html)!]! - # Information for pagination - pageInfo: [PageInfo](https://help.tableau.com/current/api/metadata_api/en-us/reference/pageinfo.doc.html)! - # Total number of objects in connection - totalCount: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html)! - } ` ## [_link_](#require-by) Require by This element is not required by anyone _menu_ Types ENUM # CanHaveLabelsOrderField Enum for fields that can be used for sorting ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - enum CanHaveLabelsOrderField { - # Sort by id - ID - # Sort by luid - LUID - } ` ## [_link_](#require-by) Require by - [CanHaveLabelsSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/canhavelabelssortorder.doc.html "CanHaveLabelsSortOrder - 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.") _menu_ Types INPUT\_OBJECT # CanHaveLabelsSortOrder 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. ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input CanHaveLabelsSortOrder { - # GraphQL field to sort on - field: [CanHaveLabelsOrderField](https://help.tableau.com/current/api/metadata_api/en-us/reference/canhavelabelsorderfield.doc.html)! - # Order direction to sort output - direction: [OrderDirection](https://help.tableau.com/current/api/metadata_api/en-us/reference/orderdirection.doc.html)! - } ` ## [_link_](#require-by) Require by This element is not required by anyone _menu_ Types INTERFACE # Certifiable A content item that can be certified ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - interface Certifiable { - # Unique identifier used by the metadata API. Not the same as the numeric ID used - # on server - id: [ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html)! - # The name of the asset - name: [String](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/string.doc.html)! - # True if this content item contains an active data quality certification - isCertified: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html)! - # The data quality certifications on a content item - # - # 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/current/api/metadata_api/en-us/reference/dataqualitycertification_filter.doc.html), - orderBy: [DataQualityCertificationSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitycertificationsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DataQualityCertification](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitycertification.doc.html)!]! - # The data quality certifications on a content item - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DataQualityCertification_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitycertification_filter.doc.html), - orderBy: [DataQualityCertificationSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitycertificationsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DataQualityCertificationsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitycertificationsconnection.doc.html) - } ` ## [_link_](#require-by) Require by - [CertifiablesConnection_Connection Type for Certifiable_](https://help.tableau.com/current/api/metadata_api/en-us/reference/certifiablesconnection.doc.html "CertifiablesConnection - Connection Type for Certifiable") - [CloudFile_A cloud file connection_](https://help.tableau.com/current/api/metadata_api/en-us/reference/cloudfile.doc.html "CloudFile - A cloud file connection") - [DatabaseServer_A database server connection_](https://help.tableau.com/current/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/current/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.*") - [File_A file connection_](https://help.tableau.com/current/api/metadata_api/en-us/reference/file.doc.html "File - A file connection") - [PublishedDatasource_A Tableau data source that has been published separately to Tableau Server. It can be used by multiple workbooks._](https://help.tableau.com/current/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.") - [VirtualConnection_A virtual connection. \*Available in Tableau Cloud March 2022 / Server 2022.1 and later.\*_](virtualconnection.doc.html "VirtualConnection - A virtual connection. *Available in Tableau Cloud March 2022 / Server 2022.1 and later.*") - [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/current/api/metadata_api/en-us/reference/webdataconnector.doc.html "WebDataConnector - A web data connector") _menu_ Types INPUT\_OBJECT # Certifiable\_Filter Filter by GraphQL field and given value ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input Certifiable_Filter { - # Locally unique identifier used for the REST API on the Tableau Server - luid: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Locally unique identifier used for the REST API on the Tableau Server - luidWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)] - # True if this content item contains an active data quality certification - isCertified: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) - # True if this content item contains an active data quality certification - isCertifiedWithin: [[Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.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/current/api/metadata_api/en-us/reference/id.doc.html) - # Unique identifier used by the metadata API. Not the same as the numeric ID used - # on server - idWithin: [[ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html)] - } ` ## [_link_](#require-by) Require by This element is not required by anyone _menu_ Types ENUM # CertifiableOrderField Enum for fields that can be used for sorting ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - enum CertifiableOrderField { - # Sort by id - ID - # Sort by isCertified - IS_CERTIFIED - # Sort by luid - LUID - } ` ## [_link_](#require-by) Require by - [CertifiableSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/certifiablesortorder.doc.html "CertifiableSortOrder - 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.") _menu_ Types OBJECT # CertifiablesConnection Connection Type for Certifiable ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type CertifiablesConnection { - # List of nodes - nodes: [[Certifiable](https://help.tableau.com/current/api/metadata_api/en-us/reference/certifiable.doc.html)!]! - # Information for pagination - pageInfo: [PageInfo](https://help.tableau.com/current/api/metadata_api/en-us/reference/pageinfo.doc.html)! - # Total number of objects in connection - totalCount: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html)! - } ` ## [_link_](#require-by) Require by This element is not required by anyone _menu_ Types INPUT\_OBJECT # CertifiableSortOrder 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. ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input CertifiableSortOrder { - # GraphQL field to sort on - field: [CertifiableOrderField](https://help.tableau.com/current/api/metadata_api/en-us/reference/certifiableorderfield.doc.html)! - # Order direction to sort output - direction: [OrderDirection](https://help.tableau.com/current/api/metadata_api/en-us/reference/orderdirection.doc.html)! - } ` ## [_link_](#require-by) Require by This element is not required by anyone _menu_ Types OBJECT # CloudFile A cloud file connection ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type CloudFile implements [Database](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html), [Warnable](https://help.tableau.com/current/api/metadata_api/en-us/reference/warnable.doc.html), [Certifiable](https://help.tableau.com/current/api/metadata_api/en-us/reference/certifiable.doc.html), [CanHaveLabels](https://help.tableau.com/current/api/metadata_api/en-us/reference/canhavelabels.doc.html), [Taggable](https://help.tableau.com/current/api/metadata_api/en-us/reference/taggable.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/current/api/metadata_api/en-us/reference/id.doc.html)! - # Vizportal ID of this database, for use in client-to-server communications - vizportalId: [String](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/string.doc.html)! - # Name shown in server and desktop clients - name: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Connection type shortname - connectionType: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # True if this file is embedded in Tableau content, e.g., a packaged workbook - isEmbedded: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) - # The provider of the cloud file, e.g., onedrive, google-sheets, dropbox, and box - provider: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # The file extension - fileExtension: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # The MIME type - mimeType: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # The ID used by the provider for the cloud file. Each provider uses IDs in a - # different format. - fileId: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # URL for requesting the cloud file - requestUrl: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # User modifiable description of this database - description: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # The ID of the project in which the database is visible. Will be empty if the - # database is not in a project. - projectVizportalUrlId: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # The name of the project in which the database is visible. Will be empty if the - # database is not in a project. - projectName: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Contact for this database - contact: [TableauUser](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauuser.doc.html) - # True if this database contains an active data quality certification - isCertified: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html)! - # True if this database has its permission locked - isControlledPermissionsEnabled: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) - # True if this database has been grouped with other databases - isGrouped: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) - # Notes related to this database being marked as certified - certificationNote: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) @deprecated( reason: "No longer supported. Use 'dataQualityCertifications'" ) - # User who marked this database as certified - certifier: [TableauUser](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauuser.doc.html) @deprecated( reason: "No longer supported. Use 'dataQualityCertifications'" ) - # True if the database has an active data quality warning - hasActiveWarning: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html)! - # The optional data quality warning on a database - dataQualityWarning: [DataQualityWarning](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarning.doc.html) @deprecated( reason: "Use 'dataQualityWarnings'" ) - # The data quality warnings on a 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. - # **permissionMode**: Results filtering mode. - dataQualityWarnings( - filter: [DataQualityWarning_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarning_filter.doc.html), - orderBy: [DataQualityWarningSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarningsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DataQualityWarning](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarning.doc.html)!]! - # The data quality warnings on a 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. - # **permissionMode**: Results filtering mode. - dataQualityWarningsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DataQualityWarning_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarning_filter.doc.html), - orderBy: [DataQualityWarningSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarningsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DataQualityWarningsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarningsconnection.doc.html) - # The data quality certifications on a 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. - # **permissionMode**: Results filtering mode. - dataQualityCertifications( - filter: [DataQualityCertification_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitycertification_filter.doc.html), - orderBy: [DataQualityCertificationSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitycertificationsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DataQualityCertification](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitycertification.doc.html)!]! - # The data quality certifications on a 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. - # **permissionMode**: Results filtering mode. - dataQualityCertificationsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DataQualityCertification_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitycertification_filter.doc.html), - orderBy: [DataQualityCertificationSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitycertificationsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DataQualityCertificationsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitycertificationsconnection.doc.html) - # The labels on a database. 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/current/api/metadata_api/en-us/reference/label_filter.doc.html), - orderBy: [LabelSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/labelsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Label](https://help.tableau.com/current/api/metadata_api/en-us/reference/label.doc.html)!]! - # The labels on a database. 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Label_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/label_filter.doc.html), - orderBy: [LabelSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/labelsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [LabelsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/labelsconnection.doc.html) - # Data quality warnings upstream from this 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. - # **permissionMode**: Results filtering mode. - upstreamDataQualityWarnings( - filter: [DataQualityWarning_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarning_filter.doc.html), - orderBy: [DataQualityWarningSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarningsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DataQualityWarning](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarning.doc.html)!]! - # Data quality warnings upstream from this 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. - # **permissionMode**: Results filtering mode. - upstreamDataQualityWarningsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DataQualityWarning_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarning_filter.doc.html), - orderBy: [DataQualityWarningSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarningsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DataQualityWarningsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarningsconnection.doc.html) - # Labels upstream from this database. 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/current/api/metadata_api/en-us/reference/label_filter.doc.html), - orderBy: [LabelSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/labelsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Label](https://help.tableau.com/current/api/metadata_api/en-us/reference/label.doc.html)!]! - # Labels upstream from this database. 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Label_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/label_filter.doc.html), - orderBy: [LabelSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/labelsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [LabelsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/labelsconnection.doc.html) - # Tags associated with 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. - tags(filter: [Tag_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/tag_filter.doc.html), orderBy: [TagSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tagsortorder.doc.html)): [[Tag](https://help.tableau.com/current/api/metadata_api/en-us/reference/tag.doc.html)!]! - # Tags associated with 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. - tagsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Tag_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/tag_filter.doc.html), - orderBy: [TagSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tagsortorder.doc.html) - ): [TagsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/tagsconnection.doc.html) - # Databases upstream of this 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. - # **permissionMode**: Results filtering mode. - upstreamDatabases( - filter: [Database_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Database](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html)!]! - # Databases upstream of this 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. - # **permissionMode**: Results filtering mode. - upstreamDatabasesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Database_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabasesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesconnection.doc.html) - # Tables upstream of this 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. - # **permissionMode**: Results filtering mode. - upstreamTables( - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DatabaseTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable.doc.html)!]! - # Tables upstream of this 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. - # **permissionMode**: Results filtering mode. - upstreamTablesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabaseTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesconnection.doc.html) - # Virtual connection tables upstream of this 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. - # **permissionMode**: Results filtering mode. - upstreamVirtualConnections( - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection.doc.html)!]! - # Virtual connection tables upstream of this 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. - # **permissionMode**: Results filtering mode. - upstreamVirtualConnectionsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsconnection.doc.html) - # Virtual connection tables upstream of this 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. - # **permissionMode**: Results filtering mode. - upstreamVirtualConnectionTables( - filter: [VirtualConnectionTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnectionTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable.doc.html)!]! - # Virtual connection tables upstream of this 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. - # **permissionMode**: Results filtering mode. - upstreamVirtualConnectionTablesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnectionTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesconnection.doc.html) - # Flows upstream of this 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. - # **permissionMode**: Results filtering mode. - upstreamFlows( - filter: [Flow_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Flow](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow.doc.html)!]! - # Flows upstream of this 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. - # **permissionMode**: Results filtering mode. - upstreamFlowsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Flow_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FlowsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsconnection.doc.html) - # Datasources upstream of this 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. - # **permissionMode**: Results filtering mode. - upstreamDatasources( - filter: [PublishedDatasource_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[PublishedDatasource](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource.doc.html)!]! - # Datasources upstream of this 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. - # **permissionMode**: Results filtering mode. - upstreamDatasourcesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [PublishedDatasource_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [PublishedDatasourcesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesconnection.doc.html) - # Databases downstream of this 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. - # **permissionMode**: Results filtering mode. - downstreamDatabases( - filter: [Database_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Database](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html)!]! - # Databases downstream of this 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. - # **permissionMode**: Results filtering mode. - downstreamDatabasesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Database_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabasesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesconnection.doc.html) - # Tables downstream of this 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. - # **permissionMode**: Results filtering mode. - downstreamTables( - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DatabaseTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable.doc.html)!]! - # Tables downstream of this 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. - # **permissionMode**: Results filtering mode. - downstreamTablesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabaseTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesconnection.doc.html) - # Virtual connection tables downstream of this 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. - # **permissionMode**: Results filtering mode. - downstreamVirtualConnections( - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection.doc.html)!]! - # Virtual connection tables downstream of this 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. - # **permissionMode**: Results filtering mode. - downstreamVirtualConnectionsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsconnection.doc.html) - # Virtual connection tables downstream of this 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. - # **permissionMode**: Results filtering mode. - downstreamVirtualConnectionTables( - filter: [VirtualConnectionTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnectionTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable.doc.html)!]! - # Virtual connection tables downstream of this 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. - # **permissionMode**: Results filtering mode. - downstreamVirtualConnectionTablesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnectionTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesconnection.doc.html) - # Flows downstream of this 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. - # **permissionMode**: Results filtering mode. - downstreamFlows( - filter: [Flow_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Flow](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow.doc.html)!]! - # Flows downstream of this 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. - # **permissionMode**: Results filtering mode. - downstreamFlowsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Flow_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FlowsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsconnection.doc.html) - # Published datasources 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. - # **permissionMode**: Results filtering mode. - downstreamDatasources( - filter: [PublishedDatasource_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[PublishedDatasource](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource.doc.html)!]! - # Published datasources 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. - # **permissionMode**: Results filtering mode. - downstreamDatasourcesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [PublishedDatasource_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [PublishedDatasourcesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesconnection.doc.html) - # Lenses 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. - # **permissionMode**: Results filtering mode. - downstreamLenses( - filter: [Lens_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/lens_filter.doc.html), - orderBy: [LensSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/lenssortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Lens](https://help.tableau.com/current/api/metadata_api/en-us/reference/lens.doc.html)!]! - # Lenses 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. - # **permissionMode**: Results filtering mode. - downstreamLensesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Lens_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/lens_filter.doc.html), - orderBy: [LensSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/lenssortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [LensesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensesconnection.doc.html) - # Workbooks 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. - # **permissionMode**: Results filtering mode. - downstreamWorkbooks( - filter: [Workbook_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbook_filter.doc.html), - orderBy: [WorkbookSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Workbook](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbook.doc.html)!]! - # Workbooks 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. - # **permissionMode**: Results filtering mode. - downstreamWorkbooksConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Workbook_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbook_filter.doc.html), - orderBy: [WorkbookSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [WorkbooksConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksconnection.doc.html) - # Dashboards 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. - # **permissionMode**: Results filtering mode. - downstreamDashboards( - filter: [Dashboard_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard_filter.doc.html), - orderBy: [DashboardSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboardsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Dashboard](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard.doc.html)!]! - # Dashboards 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. - # **permissionMode**: Results filtering mode. - downstreamDashboardsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Dashboard_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard_filter.doc.html), - orderBy: [DashboardSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboardsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DashboardsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboardsconnection.doc.html) - # Sheets 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. - # **permissionMode**: Results filtering mode. - downstreamSheets( - filter: [Sheet_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Sheet](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html)!]! - # Sheets 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. - # **permissionMode**: Results filtering mode. - downstreamSheetsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Sheet_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [SheetsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsconnection.doc.html) - # Metrics 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. - # **permissionMode**: Results filtering mode. - downstreamMetrics( - filter: [Metric_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metric_filter.doc.html), - orderBy: [MetricSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Metric](https://help.tableau.com/current/api/metadata_api/en-us/reference/metric.doc.html)!]! - # Metrics 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. - # **permissionMode**: Results filtering mode. - downstreamMetricsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Metric_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metric_filter.doc.html), - orderBy: [MetricSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [MetricsConnection](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/tableauuser_filter.doc.html), - orderBy: [TableauUserSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauusersortorder.doc.html) - ): [[TableauUser](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [TableauUser_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauuser_filter.doc.html), - orderBy: [TableauUserSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauusersortorder.doc.html) - ): [TableauUsersConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauusersconnection.doc.html) - # The custom SQL queries that reference this 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. - # **permissionMode**: Results filtering mode. - referencedByQueries( - filter: [CustomSQLTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/customsqltable_filter.doc.html), - orderBy: [CustomSQLTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/customsqltablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[CustomSQLTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/customsqltable.doc.html)] - # The custom SQL queries that reference this 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. - # **permissionMode**: Results filtering mode. - referencedByQueriesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [CustomSQLTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/customsqltable_filter.doc.html), - orderBy: [CustomSQLTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/customsqltablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [CustomSQLTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/customsqltablesconnection.doc.html) - # Tables belonging to this 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. - # **permissionMode**: Results filtering mode. - tables( - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DatabaseTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable.doc.html)] - # Tables belonging to this 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. - # **permissionMode**: Results filtering mode. - tablesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabaseTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesconnection.doc.html) - # Metric definitions downstream from this 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. - # **permissionMode**: Results filtering mode. - downstreamMetricDefinitions( - filter: [MetricDefinition_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinition_filter.doc.html), - orderBy: [MetricDefinitionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[MetricDefinition](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinition.doc.html)]! - # Metric definitions downstream from this 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. - # **permissionMode**: Results filtering mode. - downstreamMetricDefinitionsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [MetricDefinition_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinition_filter.doc.html), - orderBy: [MetricDefinitionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [MetricDefinitionsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsconnection.doc.html) - } ` ## [_link_](#require-by) Require by - [CloudFilesConnection_Connection Type for CloudFile_](https://help.tableau.com/current/api/metadata_api/en-us/reference/cloudfilesconnection.doc.html "CloudFilesConnection - Connection Type for CloudFile") - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/api/metadata_api/en-us/reference/query.doc.html "Query - Query root for Metadata GraphQL interface") _menu_ Types INPUT\_OBJECT # CloudFile\_Filter Filter by GraphQL field and given value ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input CloudFile_Filter { - # True if the database has an active data quality warning - hasActiveWarning: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) - # True if the database has an active data quality warning - hasActiveWarningWithin: [[Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html)] - # Locally unique identifier used for the REST API on the Tableau Server - luid: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Locally unique identifier used for the REST API on the Tableau Server - luidWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)] - # True if this database contains an active data quality certification - isCertified: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) - # True if this database contains an active data quality certification - isCertifiedWithin: [[Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html)] - # Name shown in server and desktop clients - name: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Name shown in server and desktop clients - nameWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)] - # True if this file is embedded in Tableau content, e.g., a packaged workbook - isEmbedded: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) - # True if this file is embedded in Tableau content, e.g., a packaged workbook - isEmbeddedWithin: [[Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.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/current/api/metadata_api/en-us/reference/id.doc.html) - # Unique identifier used by the Metadata API. Not the same as the numeric ID used - # on server - idWithin: [[ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html)] - # The name of the project in which the database is visible. Will be empty if the - # database is not in a project. - projectName: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # The name of the project in which the database is visible. Will be empty if the - # database is not in a project. - projectNameWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)] - # Connection type shortname - connectionType: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Connection type shortname - connectionTypeWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)] - # Filter the output based on text query. - text: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - } ` ## [_link_](#require-by) Require by - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/api/metadata_api/en-us/reference/query.doc.html "Query - Query root for Metadata GraphQL interface") _menu_ Types ENUM # CloudFileOrderField Enum for fields that can be used for sorting ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - enum CloudFileOrderField { - # Sort by downstreamDatasources count - DOWNSTREAM_DATASOURCES_COUNT - # Sort by downstreamVirtualConnections count - DOWNSTREAM_VIRTUAL_CONNECTIONS_COUNT - # Sort by downstreamWorkbooks count - DOWNSTREAM_WORKBOOKS_COUNT - # Sort by connectionType - CONNECTION_TYPE - # Sort by hasActiveWarning - HAS_ACTIVE_WARNING - # Sort by id - ID - # Sort by isCertified - IS_CERTIFIED - # Sort by isEmbedded - IS_EMBEDDED - # Sort by luid - LUID - # Sort by name - NAME - # Sort by projectName - PROJECT_NAME - } ` ## [_link_](#require-by) Require by - [CloudFileSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/cloudfilesortorder.doc.html "CloudFileSortOrder - 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.") _menu_ Types OBJECT # CloudFilesConnection Connection Type for CloudFile ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type CloudFilesConnection { - # List of nodes - nodes: [[CloudFile](https://help.tableau.com/current/api/metadata_api/en-us/reference/cloudfile.doc.html)!]! - # Information for pagination - pageInfo: [PageInfo](https://help.tableau.com/current/api/metadata_api/en-us/reference/pageinfo.doc.html)! - # Total number of objects in connection - totalCount: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html)! - } ` ## [_link_](#require-by) Require by - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/api/metadata_api/en-us/reference/query.doc.html "Query - Query root for Metadata GraphQL interface") _menu_ Types INPUT\_OBJECT # CloudFileSortOrder 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. ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input CloudFileSortOrder { - # GraphQL field to sort on - field: [CloudFileOrderField](https://help.tableau.com/current/api/metadata_api/en-us/reference/cloudfileorderfield.doc.html)! - # Order direction to sort output - direction: [OrderDirection](https://help.tableau.com/current/api/metadata_api/en-us/reference/orderdirection.doc.html)! - } ` ## [_link_](#require-by) Require by - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/api/metadata_api/en-us/reference/query.doc.html "Query - Query root for Metadata GraphQL interface") _menu_ Types OBJECT # Column GraphQL type for a table column ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type Column implements [Warnable](https://help.tableau.com/current/api/metadata_api/en-us/reference/warnable.doc.html), [CanHaveLabels](https://help.tableau.com/current/api/metadata_api/en-us/reference/canhavelabels.doc.html), [Taggable](https://help.tableau.com/current/api/metadata_api/en-us/reference/taggable.doc.html), [Node](https://help.tableau.com/current/api/metadata_api/en-us/reference/node.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/current/api/metadata_api/en-us/reference/id.doc.html)! - # Vizportal ID of this column, for use in client-to-server communications - vizportalId: [String](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/string.doc.html)! - # Name of column - name: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Optional display name for column - displayName: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # User modifiable description of this column - description: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # description that is shown in the Tableau UI - # - # Arguments - # **inheritanceType**: Method for selecting inherited value - # **permissionMode**: Option to select how to apply permissions. By - # default it is OBFUSCATE_RESULTS - descriptionInherited( - inheritanceType: [InheritanceType](https://help.tableau.com/current/api/metadata_api/en-us/reference/inheritancetype.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[InheritedStringResult](https://help.tableau.com/current/api/metadata_api/en-us/reference/inheritedstringresult.doc.html)] - # Remote type on the database. Types correspond to OLEDB types here: - # https://referencesource.microsoft.com/#system.data/System/Data/OleDb/OLEDB_Enum.cs,364 - remoteType: [RemoteType](https://help.tableau.com/current/api/metadata_api/en-us/reference/remotetype.doc.html)! - # True if this column may contain null values - isNullable: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) - # True if this column has an active data quality warning. Available in Tableau - # Cloud October 2022 / Server 2022.3 and later. - hasActiveWarning: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html)! - # The optional data quality warning on this column. - dataQualityWarning: [DataQualityWarning](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarning.doc.html) @deprecated( reason: "Use 'dataQualityWarnings'" ) - # The data quality warnings on this column. Available in Tableau Cloud October - # 2022 / Server 2022.3 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. - dataQualityWarnings( - filter: [DataQualityWarning_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarning_filter.doc.html), - orderBy: [DataQualityWarningSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarningsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DataQualityWarning](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarning.doc.html)!]! - # The data quality warnings on this column. Available in Tableau Cloud October - # 2022 / Server 2022.3 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. - dataQualityWarningsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DataQualityWarning_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarning_filter.doc.html), - orderBy: [DataQualityWarningSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarningsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DataQualityWarningsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarningsconnection.doc.html) - # The labels on this column. 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/current/api/metadata_api/en-us/reference/label_filter.doc.html), - orderBy: [LabelSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/labelsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Label](https://help.tableau.com/current/api/metadata_api/en-us/reference/label.doc.html)!]! - # The labels on this column. 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Label_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/label_filter.doc.html), - orderBy: [LabelSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/labelsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [LabelsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/labelsconnection.doc.html) - # Tags associated with the column - # - # 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/current/api/metadata_api/en-us/reference/tag_filter.doc.html), orderBy: [TagSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tagsortorder.doc.html)): [[Tag](https://help.tableau.com/current/api/metadata_api/en-us/reference/tag.doc.html)!]! - # Tags associated with the column - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Tag_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/tag_filter.doc.html), - orderBy: [TagSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tagsortorder.doc.html) - ): [TagsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/tagsconnection.doc.html) - # A column that this column logically represents. - remoteColumn: [Column](https://help.tableau.com/current/api/metadata_api/en-us/reference/column.doc.html) - # Tables upstream from the column - # - # 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/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DatabaseTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable.doc.html)!]! - # Tables upstream from the column - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabaseTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesconnection.doc.html) - # Virtual connection tables upstream from the column - # - # 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/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnectionTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable.doc.html)!]! - # Virtual connection tables upstream from the column - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnectionTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesconnection.doc.html) - # Virtual connections upstream from the column - # - # 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. - upstreamVirtualConnections( - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection.doc.html)!]! - # Virtual connections upstream from the column - # - # 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. - upstreamVirtualConnectionsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsconnection.doc.html) - # Databases upstream from the Table - # - # 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/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Database](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html)!]! - # Databases upstream from the Table - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Database_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabasesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesconnection.doc.html) - # Flows connected upstream from the column - # - # 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/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Flow](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow.doc.html)!]! - # Flows connected upstream from the column - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Flow_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FlowsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsconnection.doc.html) - # Datasources upstream from this column - # - # 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/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[PublishedDatasource](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource.doc.html)!]! - # Datasources upstream from this column - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [PublishedDatasource_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [PublishedDatasourcesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesconnection.doc.html) - # Columns downstream from the column - # - # 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. - downstreamColumns( - filter: [Column_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/column_filter.doc.html), - orderBy: [ColumnSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Column](https://help.tableau.com/current/api/metadata_api/en-us/reference/column.doc.html)!]! - # Columns downstream from the column - # - # 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. - downstreamColumnsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Column_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/column_filter.doc.html), - orderBy: [ColumnSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [ColumnsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnsconnection.doc.html) - # Tables downstream from the column - # - # 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. - downstreamTables( - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DatabaseTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable.doc.html)!]! - # Tables downstream from the column - # - # 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. - downstreamTablesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabaseTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesconnection.doc.html) - # Virtual connection tables downstream from the column - # - # 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/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnectionTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable.doc.html)!]! - # Virtual connection tables downstream from the column - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnectionTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesconnection.doc.html) - # Virtual connections downstream from the column - # - # 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. - downstreamVirtualConnections( - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection.doc.html)!]! - # Virtual connections downstream from the column - # - # 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. - downstreamVirtualConnectionsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsconnection.doc.html) - # Databases downstream from the column - # - # 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. - downstreamDatabases( - filter: [Database_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Database](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html)!]! - # Databases downstream from the column - # - # 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. - downstreamDatabasesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Database_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabasesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesconnection.doc.html) - # Flows downstream from the column - # - # 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/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Flow](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow.doc.html)!]! - # Flows downstream from the column - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Flow_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FlowsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsconnection.doc.html) - # Fields downstream from the column - # - # 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. - downstreamFields( - filter: [Field_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/field_filter.doc.html), - orderBy: [FieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Field](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.doc.html)!]! - # Fields downstream from the column - # - # 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. - downstreamFieldsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Field_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/field_filter.doc.html), - orderBy: [FieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsconnection.doc.html) - # Published datasources downstream from the column - # - # 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/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[PublishedDatasource](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource.doc.html)!]! - # Published datasources downstream from the column - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [PublishedDatasource_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [PublishedDatasourcesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesconnection.doc.html) - # Lenses downstream from the column - # - # 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/current/api/metadata_api/en-us/reference/lens_filter.doc.html), - orderBy: [LensSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/lenssortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Lens](https://help.tableau.com/current/api/metadata_api/en-us/reference/lens.doc.html)!]! - # Lenses downstream from the column - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Lens_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/lens_filter.doc.html), - orderBy: [LensSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/lenssortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [LensesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensesconnection.doc.html) - # Sheets downstream from the column - # - # 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/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Sheet](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html)!]! - # Sheets downstream from the column - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Sheet_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [SheetsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsconnection.doc.html) - # Dashboards downstream from the column - # - # 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/current/api/metadata_api/en-us/reference/dashboard_filter.doc.html), - orderBy: [DashboardSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboardsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Dashboard](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard.doc.html)!]! - # Dashboards downstream from the column - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Dashboard_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard_filter.doc.html), - orderBy: [DashboardSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboardsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DashboardsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboardsconnection.doc.html) - # Workbooks downstream from the column - # - # 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/current/api/metadata_api/en-us/reference/workbook_filter.doc.html), - orderBy: [WorkbookSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Workbook](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbook.doc.html)!]! - # Workbooks downstream from the column - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Workbook_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbook_filter.doc.html), - orderBy: [WorkbookSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [WorkbooksConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksconnection.doc.html) - # Metrics downstream from the column - # - # 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/current/api/metadata_api/en-us/reference/metric_filter.doc.html), - orderBy: [MetricSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Metric](https://help.tableau.com/current/api/metadata_api/en-us/reference/metric.doc.html)!]! - # Metrics downstream from the column - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Metric_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metric_filter.doc.html), - orderBy: [MetricSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [MetricsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricsconnection.doc.html) - # Owners of workbooks and published datasources downstream from the column - # - # 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/current/api/metadata_api/en-us/reference/tableauuser_filter.doc.html), - orderBy: [TableauUserSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauusersortorder.doc.html) - ): [[TableauUser](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauuser.doc.html)!]! - # Owners of workbooks and published datasources downstream from the column - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [TableauUser_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauuser_filter.doc.html), - orderBy: [TableauUserSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauusersortorder.doc.html) - ): [TableauUsersConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauusersconnection.doc.html) - # The table that this column belongs to - table: [Table](https://help.tableau.com/current/api/metadata_api/en-us/reference/table.doc.html) - # The column field that references this column - # - # 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. - referencedByFields( - filter: [ColumnField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnfield_filter.doc.html), - orderBy: [ColumnFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[ColumnField](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnfield.doc.html)] - # The column field that references this column - # - # 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. - referencedByFieldsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [ColumnField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnfield_filter.doc.html), - orderBy: [ColumnFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [ColumnFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnfieldsconnection.doc.html) - # A column that logically represents this column. - # - # 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. - referencedByRemoteColumn( - filter: [Column_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/column_filter.doc.html), - orderBy: [ColumnSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Column](https://help.tableau.com/current/api/metadata_api/en-us/reference/column.doc.html)] - # A column that logically represents this column. - # - # 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. - referencedByRemoteColumnConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Column_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/column_filter.doc.html), - orderBy: [ColumnSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [ColumnsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnsconnection.doc.html) - # A flow input field that wraps this column - # - # 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. - referencedByFlowColumnInputField( - filter: [FlowColumnInputField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowcolumninputfield_filter.doc.html), - orderBy: [FlowColumnInputFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowcolumninputfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[FlowColumnInputField](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowcolumninputfield.doc.html)] - # A flow input field that wraps this column - # - # 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. - referencedByFlowColumnInputFieldConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [FlowColumnInputField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowcolumninputfield_filter.doc.html), - orderBy: [FlowColumnInputFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowcolumninputfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FlowColumnInputFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowcolumninputfieldsconnection.doc.html) - # A flow output field that wraps this column - # - # 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. - referencedByFlowColumnOutputField( - filter: [FlowColumnOutputField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowcolumnoutputfield_filter.doc.html), - orderBy: [FlowColumnOutputFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowcolumnoutputfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[FlowColumnOutputField](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowcolumnoutputfield.doc.html)] - # A flow output field that wraps this column - # - # 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. - referencedByFlowColumnOutputFieldConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [FlowColumnOutputField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowcolumnoutputfield_filter.doc.html), - orderBy: [FlowColumnOutputFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowcolumnoutputfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FlowColumnOutputFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowcolumnoutputfieldsconnection.doc.html) - # fields that are upstream of this column - # - # 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. - upstreamFields( - filter: [Field_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/field_filter.doc.html), - orderBy: [FieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Field](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.doc.html)]! - # fields that are upstream of this column - # - # 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. - upstreamFieldsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Field_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/field_filter.doc.html), - orderBy: [FieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsconnection.doc.html) - # Metric definitions downstream from the column. - # - # 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/current/api/metadata_api/en-us/reference/metricdefinition_filter.doc.html), - orderBy: [MetricDefinitionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[MetricDefinition](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinition.doc.html)] - # Metric definitions downstream from the column. - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [MetricDefinition_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinition_filter.doc.html), - orderBy: [MetricDefinitionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [MetricDefinitionsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsconnection.doc.html) - # All upstream columns this column references - # - # 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. - upstreamColumns( - filter: [Column_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/column_filter.doc.html), - orderBy: [ColumnSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Column](https://help.tableau.com/current/api/metadata_api/en-us/reference/column.doc.html)]! - # All upstream columns this column references - # - # 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. - upstreamColumnsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Column_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/column_filter.doc.html), - orderBy: [ColumnSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [ColumnsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnsconnection.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/current/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/current/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") - [Column_GraphQL type for a table column_](https://help.tableau.com/current/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/current/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.") - [ColumnsConnection_Connection Type for Column_](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnsconnection.doc.html "ColumnsConnection - Connection Type for Column") - [CombinedField_GraphQL type for a combined field. Combined fields concatanate fields together into one string._](https://help.tableau.com/current/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/current/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/current/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.") - [Dashboard_A dashboard contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard.doc.html "Dashboard - A dashboard contained in a published workbook.") - [DatabaseTable_A table that is contained in a database_](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable.doc.html "DatabaseTable - A table that is contained in a database") - [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/current/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/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [FlowColumnInputField_Column input field implementation_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowcolumninputfield.doc.html "FlowColumnInputField - Column input field implementation") - [FlowColumnOutputField_Column output field implementation_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowcolumnoutputfield.doc.html "FlowColumnOutputField - Column output field implementation") - [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/current/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/current/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") - [Metric_Metrics are time series data constructed from fields contained in views. \*Retired in Tableau Cloud February 2024 / Server 2024.2.\*_](metric.doc.html "Metric - Metrics are time series data constructed from fields contained in views. *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.*") - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/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/current/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") - [Sheet_A sheet contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html "Sheet - A sheet contained in a published workbook.") - [Table_A table containing columns_](https://help.tableau.com/current/api/metadata_api/en-us/reference/table.doc.html "Table - A table containing columns") - [Tag_A tag associated with content items_](https://help.tableau.com/current/api/metadata_api/en-us/reference/tag.doc.html "Tag - A tag associated with content items") - [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.*") _menu_ Types INPUT\_OBJECT # Column\_Filter Filter by GraphQL field and given value ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input Column_Filter { - # True if this column has an active data quality warning. Available in Tableau - # Cloud October 2022 / Server 2022.3 and later. - hasActiveWarning: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) - # True if this column has an active data quality warning. Available in Tableau - # Cloud October 2022 / Server 2022.3 and later. - hasActiveWarningWithin: [[Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html)] - # Locally unique identifier used for the REST API on the Tableau Server - luid: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Locally unique identifier used for the REST API on the Tableau Server - luidWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)] - # Optional display name for column - displayName: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Optional display name for column - displayNameWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)] - # Name of column - name: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Name of column - nameWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.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/current/api/metadata_api/en-us/reference/id.doc.html) - # Unique identifier used by the metadata API. Not the same as the numeric ID used - # on server - idWithin: [[ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.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/current/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/current/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") - [Column_GraphQL type for a table column_](https://help.tableau.com/current/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/current/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/current/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/current/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/current/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.") - [Dashboard_A dashboard contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard.doc.html "Dashboard - A dashboard contained in a published workbook.") - [DatabaseTable_A table that is contained in a database_](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable.doc.html "DatabaseTable - A table that is contained in a database") - [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/current/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/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [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/current/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/current/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") - [Metric_Metrics are time series data constructed from fields contained in views. \*Retired in Tableau Cloud February 2024 / Server 2024.2.\*_](metric.doc.html "Metric - Metrics are time series data constructed from fields contained in views. *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.*") - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/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/current/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") - [Sheet_A sheet contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html "Sheet - A sheet contained in a published workbook.") - [Table_A table containing columns_](https://help.tableau.com/current/api/metadata_api/en-us/reference/table.doc.html "Table - A table containing columns") - [Tag_A tag associated with content items_](https://help.tableau.com/current/api/metadata_api/en-us/reference/tag.doc.html "Tag - A tag associated with content items") - [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.*") _menu_ Types INPUT\_OBJECT # Column\_Required\_Filter Filter by GraphQL field and given value ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input Column_Required_Filter { - # Name of column - name: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Name of column - nameWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.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/current/api/metadata_api/en-us/reference/id.doc.html) - # Unique identifier used by the metadata API. Not the same as the numeric ID used - # on server - idWithin: [[ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html)] - } ` ## [_link_](#require-by) Require by This element is not required by anyone _menu_ Types OBJECT # ColumnField ColumnFields are a type of field which directly connects to a column in some type of table. ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type ColumnField implements [Field](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.doc.html), [DataField](https://help.tableau.com/current/api/metadata_api/en-us/reference/datafield.doc.html), [AnalyticsField](https://help.tableau.com/current/api/metadata_api/en-us/reference/analyticsfield.doc.html), [Node](https://help.tableau.com/current/api/metadata_api/en-us/reference/node.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/current/api/metadata_api/en-us/reference/id.doc.html)! - # Name shown in server and desktop clients - name: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Name internally used to uniquely identify fields - fullyQualifiedName: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Description of field shown in server and desktop clients - description: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # description that is shown in the Tableau UI - # - # Arguments - # **inheritanceType**: Method for selecting inherited value - # **permissionMode**: Option to select how to apply permissions. By - # default it is OBFUSCATE_RESULTS - descriptionInherited( - inheritanceType: [InheritanceType](https://help.tableau.com/current/api/metadata_api/en-us/reference/inheritancetype.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[InheritedStringResult](https://help.tableau.com/current/api/metadata_api/en-us/reference/inheritedstringresult.doc.html)] - # True if the field is hidden - isHidden: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) - # Name of folder if the field is in a folder. See - # https://onlinehelp.tableau.com/current/pro/desktop/en-us/datafields_dwfeatures.html#Organize - folderName: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Data category of the field - dataCategory: [FieldRoleCategory](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldrolecategory.doc.html) - # Role of the field: 'dimension', 'measure' or 'unknown' - role: [FieldRole](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldrole.doc.html) - # Type of the data in the field. See - # https://onlinehelp.tableau.com/current/pro/desktop/en-us/datafields_typesandroles_datatypes.html - dataType: [FieldDataType](https://help.tableau.com/current/api/metadata_api/en-us/reference/fielddatatype.doc.html) - # Default format for number or date - defaultFormat: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # For geographic data, the geographic role of the field. See - # https://onlinehelp.tableau.com/current/pro/desktop/en-us/maps_geographicroles.html - semanticRole: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Default aggregation of the field, i.e. 'Sum', 'Average'. See - # https://onlinehelp.tableau.com/current/pro/desktop/en-us/calculations_aggregation.html#AggFuncs - aggregation: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # For the percentile aggregation, the percentile number - aggregationParam: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # List of columns, if any, that this field references - # - # 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. - columns( - filter: [Column_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/column_filter.doc.html), - orderBy: [ColumnSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Column](https://help.tableau.com/current/api/metadata_api/en-us/reference/column.doc.html)!]! - # List of columns, if any, that this field references - # - # 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. - columnsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Column_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/column_filter.doc.html), - orderBy: [ColumnSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [ColumnsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnsconnection.doc.html) - # Columns downstream of this field - # - # 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. - downstreamColumns( - filter: [Column_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/column_filter.doc.html), - orderBy: [ColumnSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Column](https://help.tableau.com/current/api/metadata_api/en-us/reference/column.doc.html)!]! - # Columns downstream of this field - # - # 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. - downstreamColumnsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Column_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/column_filter.doc.html), - orderBy: [ColumnSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [ColumnsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnsconnection.doc.html) - # Tables downstream of this field - # - # 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. - downstreamTables( - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DatabaseTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable.doc.html)!]! - # Tables downstream of this field - # - # 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. - downstreamTablesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabaseTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesconnection.doc.html) - # Virtual connection tables downstream of this field - # - # 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/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnectionTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable.doc.html)!]! - # Virtual connection tables downstream of this field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnectionTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesconnection.doc.html) - # Virtual connections downstream of this field - # - # 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. - downstreamVirtualConnections( - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection.doc.html)!]! - # Virtual connections downstream of this field - # - # 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. - downstreamVirtualConnectionsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsconnection.doc.html) - # Databases downstream of this field - # - # 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. - downstreamDatabases( - filter: [Database_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Database](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html)!]! - # Databases downstream of this field - # - # 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. - downstreamDatabasesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Database_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabasesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesconnection.doc.html) - # Flows downstream of this field - # - # 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/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Flow](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow.doc.html)!]! - # Flows downstream of this field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Flow_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FlowsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsconnection.doc.html) - # downstream fields that reference this field - # - # 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. - downstreamFields( - filter: [Field_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/field_filter.doc.html), - orderBy: [FieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Field](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.doc.html)!]! - # downstream fields that reference this field - # - # 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. - downstreamFieldsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Field_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/field_filter.doc.html), - orderBy: [FieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsconnection.doc.html) - # Datasources connected downstream from this field - # - # 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/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[PublishedDatasource](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource.doc.html)!] - # Datasources connected downstream from this field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [PublishedDatasource_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [PublishedDatasourcesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesconnection.doc.html) - # Lenses connected downstream from this field - # - # 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/current/api/metadata_api/en-us/reference/lens_filter.doc.html), - orderBy: [LensSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/lenssortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Lens](https://help.tableau.com/current/api/metadata_api/en-us/reference/lens.doc.html)!] - # Lenses connected downstream from this field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Lens_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/lens_filter.doc.html), - orderBy: [LensSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/lenssortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [LensesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensesconnection.doc.html) - # Sheets connected downstream from the field - # - # 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/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Sheet](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html)!]! - # Sheets connected downstream from the field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Sheet_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [SheetsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsconnection.doc.html) - # Dashboards connected downstream from the field - # - # 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/current/api/metadata_api/en-us/reference/dashboard_filter.doc.html), - orderBy: [DashboardSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboardsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Dashboard](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard.doc.html)!]! - # Dashboards connected downstream from the field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Dashboard_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard_filter.doc.html), - orderBy: [DashboardSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboardsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DashboardsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboardsconnection.doc.html) - # Workbooks connected downstream from the field - # - # 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/current/api/metadata_api/en-us/reference/workbook_filter.doc.html), - orderBy: [WorkbookSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Workbook](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbook.doc.html)!] - # Workbooks connected downstream from the field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Workbook_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbook_filter.doc.html), - orderBy: [WorkbookSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [WorkbooksConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksconnection.doc.html) - # Metrics connected downstream from the field - # - # 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/current/api/metadata_api/en-us/reference/metric_filter.doc.html), - orderBy: [MetricSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Metric](https://help.tableau.com/current/api/metadata_api/en-us/reference/metric.doc.html)!] - # Metrics connected downstream from the field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Metric_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metric_filter.doc.html), - orderBy: [MetricSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [MetricsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricsconnection.doc.html) - # Workbook owners (authors) connected downstream from the field - # - # 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/current/api/metadata_api/en-us/reference/tableauuser_filter.doc.html), - orderBy: [TableauUserSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauusersortorder.doc.html) - ): [[TableauUser](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauuser.doc.html)!] - # Workbook owners (authors) connected downstream from the field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [TableauUser_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauuser_filter.doc.html), - orderBy: [TableauUserSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauusersortorder.doc.html) - ): [TableauUsersConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauusersconnection.doc.html) - # Tables connected upstream from the field - # - # 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/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DatabaseTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable.doc.html)!]! - # Tables connected upstream from the field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabaseTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesconnection.doc.html) - # Virtual connection tables upstream of this field - # - # 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/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnectionTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable.doc.html)!]! - # Virtual connection tables upstream of this field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnectionTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesconnection.doc.html) - # Virtual connections upstream of this field - # - # 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. - upstreamVirtualConnections( - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection.doc.html)!]! - # Virtual connections upstream of this field - # - # 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. - upstreamVirtualConnectionsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsconnection.doc.html) - # Databases connected upstream from the field - # - # 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/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Database](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html)!]! - # Databases connected upstream from the field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Database_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabasesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesconnection.doc.html) - # Flows connected upstream from the field - # - # 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/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Flow](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow.doc.html)!]! - # Flows connected upstream from the field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Flow_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FlowsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsconnection.doc.html) - # Datasources connected upstream from the field - # - # 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/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[PublishedDatasource](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource.doc.html)!]! - # Datasources connected upstream from the field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [PublishedDatasource_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [PublishedDatasourcesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesconnection.doc.html) - # The field that references this field - # - # 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. - referencedByFields( - filter: [FieldReferencingField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield_filter.doc.html), - orderBy: [FieldReferencingFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[FieldReferencingField](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield.doc.html)] - # The field that references this field - # - # 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. - referencedByFieldsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [FieldReferencingField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield_filter.doc.html), - orderBy: [FieldReferencingFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FieldReferencingFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfieldsconnection.doc.html) - # Data source that contains this field - datasource: [Datasource](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasource.doc.html) - # Metric definitions that reference this data source field. - # - # 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. - metricDefinitions( - filter: [MetricDefinition_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinition_filter.doc.html), - orderBy: [MetricDefinitionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[MetricDefinition](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinition.doc.html)] - # Metric definitions that reference this data source field. - # - # 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. - metricDefinitionsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [MetricDefinition_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinition_filter.doc.html), - orderBy: [MetricDefinitionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [MetricDefinitionsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsconnection.doc.html) - # The data source filters that include this field - # - # 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. - referencedByFilters( - filter: [DatasourceFilter_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefilter_filter.doc.html), - orderBy: [DatasourceFilterSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefiltersortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DatasourceFilter](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefilter.doc.html)] - # The data source filters that include this field - # - # 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. - referencedByFiltersConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DatasourceFilter_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefilter_filter.doc.html), - orderBy: [DatasourceFilterSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefiltersortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatasourceFiltersConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefiltersconnection.doc.html) - # The bin field that references this field - # - # 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. - referencedByBins( - filter: [BinField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/binfield_filter.doc.html), - orderBy: [BinFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/binfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[BinField](https://help.tableau.com/current/api/metadata_api/en-us/reference/binfield.doc.html)] - # The bin field that references this field - # - # 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. - referencedByBinsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [BinField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/binfield_filter.doc.html), - orderBy: [BinFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/binfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [BinFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/binfieldsconnection.doc.html) - # The calculated field that references this field - # - # 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. - referencedByCalculations( - filter: [CalculatedField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/calculatedfield_filter.doc.html), - orderBy: [CalculatedFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/calculatedfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[CalculatedField](https://help.tableau.com/current/api/metadata_api/en-us/reference/calculatedfield.doc.html)] - # The calculated field that references this field - # - # 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. - referencedByCalculationsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [CalculatedField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/calculatedfield_filter.doc.html), - orderBy: [CalculatedFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/calculatedfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [CalculatedFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/calculatedfieldsconnection.doc.html) - # The combined field that references this field - # - # 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. - referencedByCombinedFields( - filter: [CombinedField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedfield_filter.doc.html), - orderBy: [CombinedFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[CombinedField](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedfield.doc.html)] - # The combined field that references this field - # - # 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. - referencedByCombinedFieldsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [CombinedField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedfield_filter.doc.html), - orderBy: [CombinedFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [CombinedFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedfieldsconnection.doc.html) - # Thie combined set field that references this field - # - # 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. - referencedByCombinedSets( - filter: [CombinedSetField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedsetfield_filter.doc.html), - orderBy: [CombinedSetFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedsetfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[CombinedSetField](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedsetfield.doc.html)] - # Thie combined set field that references this field - # - # 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. - referencedByCombinedSetsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [CombinedSetField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedsetfield_filter.doc.html), - orderBy: [CombinedSetFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedsetfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [CombinedSetFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedsetfieldsconnection.doc.html) - # The field that references this remote field - # - # 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. - referencedByRemoteFields( - filter: [DatasourceField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefield_filter.doc.html), - orderBy: [DatasourceFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DatasourceField](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefield.doc.html)] - # The field that references this remote field - # - # 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. - referencedByRemoteFieldsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DatasourceField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefield_filter.doc.html), - orderBy: [DatasourceFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatasourceFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefieldsconnection.doc.html) - # The group field that references this field - # - # 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. - referencedByGroups( - filter: [GroupField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/groupfield_filter.doc.html), - orderBy: [GroupFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/groupfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[GroupField](https://help.tableau.com/current/api/metadata_api/en-us/reference/groupfield.doc.html)] - # The group field that references this field - # - # 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. - referencedByGroupsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [GroupField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/groupfield_filter.doc.html), - orderBy: [GroupFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/groupfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [GroupFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/groupfieldsconnection.doc.html) - # The set field that this field references - # - # 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. - referencedBySets( - filter: [SetField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/setfield_filter.doc.html), - orderBy: [SetFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/setfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[SetField](https://help.tableau.com/current/api/metadata_api/en-us/reference/setfield.doc.html)] - # The set field that this field references - # - # 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. - referencedBySetsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [SetField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/setfield_filter.doc.html), - orderBy: [SetFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/setfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [SetFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/setfieldsconnection.doc.html) - # The hierarchy field that references this field - # - # 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. - referencedByHierarchies( - filter: [HierarchyField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/hierarchyfield_filter.doc.html), - orderBy: [HierarchyFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/hierarchyfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[HierarchyField](https://help.tableau.com/current/api/metadata_api/en-us/reference/hierarchyfield.doc.html)] - # The hierarchy field that references this field - # - # 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. - referencedByHierarchiesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [HierarchyField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/hierarchyfield_filter.doc.html), - orderBy: [HierarchyFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/hierarchyfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [HierarchyFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/hierarchyfieldsconnection.doc.html) - # Sheets that reference this data source field - # - # 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. - sheets( - filter: [Sheet_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Sheet](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html)] - # Sheets that reference this data source field - # - # 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. - sheetsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Sheet_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [SheetsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsconnection.doc.html) - # Sheets that reference this field - # - # 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. - directSheets( - filter: [Sheet_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Sheet](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html)] - # Sheets that reference this field - # - # 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. - directSheetsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Sheet_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [SheetsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsconnection.doc.html) - # List of lens fields which are derived from this field - # - # 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. - derivedLensFields( - filter: [LensField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensfield_filter.doc.html), - orderBy: [LensFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[LensField](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensfield.doc.html)] - # List of lens fields which are derived from this field - # - # 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. - derivedLensFieldsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [LensField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensfield_filter.doc.html), - orderBy: [LensFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [LensFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensfieldsconnection.doc.html) - # A flow input field that wraps this field - # - # 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. - referencedByFlowFieldInputField( - filter: [FlowFieldInputField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfield_filter.doc.html), - orderBy: [FlowFieldInputFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfieldsortorder.doc.html) - ): [[FlowFieldInputField](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfield.doc.html)] - # A flow input field that wraps this field - # - # 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. - referencedByFlowFieldInputFieldConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [FlowFieldInputField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfield_filter.doc.html), - orderBy: [FlowFieldInputFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfieldsortorder.doc.html) - ): [FlowFieldInputFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfieldsconnection.doc.html) - # A flow output field that wraps this field - # - # 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. - referencedByFlowFieldOutputField( - filter: [FlowFieldOutputField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfield_filter.doc.html), - orderBy: [FlowFieldOutputFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[FlowFieldOutputField](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfield.doc.html)] - # A flow output field that wraps this field - # - # 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. - referencedByFlowFieldOutputFieldConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [FlowFieldOutputField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfield_filter.doc.html), - orderBy: [FlowFieldOutputFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FlowFieldOutputFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfieldsconnection.doc.html) - # fields that are upstream of this field - # - # 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. - upstreamFields( - filter: [Field_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/field_filter.doc.html), - orderBy: [FieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Field](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.doc.html)]! - # fields that are upstream of this field - # - # 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. - upstreamFieldsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Field_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/field_filter.doc.html), - orderBy: [FieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsconnection.doc.html) - # Metric definitions downstream from this field. - # - # 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/current/api/metadata_api/en-us/reference/metricdefinition_filter.doc.html), - orderBy: [MetricDefinitionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[MetricDefinition](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinition.doc.html)] - # Metric definitions downstream from this field. - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [MetricDefinition_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinition_filter.doc.html), - orderBy: [MetricDefinitionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [MetricDefinitionsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsconnection.doc.html) - # All upstream columns this field references - # - # 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. - upstreamColumns( - filter: [Column_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/column_filter.doc.html), - orderBy: [ColumnSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Column](https://help.tableau.com/current/api/metadata_api/en-us/reference/column.doc.html)]! - # All upstream columns this field references - # - # 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. - upstreamColumnsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Column_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/column_filter.doc.html), - orderBy: [ColumnSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [ColumnsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnsconnection.doc.html) - } ` ## [_link_](#require-by) Require by - [Column_GraphQL type for a table column_](https://help.tableau.com/current/api/metadata_api/en-us/reference/column.doc.html "Column - GraphQL type for a table column") - [ColumnFieldsConnection_Connection Type for ColumnField_](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnfieldsconnection.doc.html "ColumnFieldsConnection - Connection Type for ColumnField") - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/api/metadata_api/en-us/reference/query.doc.html "Query - Query root for Metadata GraphQL interface") _menu_ Types INPUT\_OBJECT # ColumnField\_Filter Filter by GraphQL field and given value ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input ColumnField_Filter { - # Name shown in server and desktop clients - name: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Name shown in server and desktop clients - nameWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.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/current/api/metadata_api/en-us/reference/id.doc.html) - # Unique identifier used by the metadata API. Not the same as the numeric ID used - # on server - idWithin: [[ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html)] - # True if the field is hidden - isHidden: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) - # True if the field is hidden - isHiddenWithin: [[Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html)] - # Filter the output based on text query. - text: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - } ` ## [_link_](#require-by) Require by - [Column_GraphQL type for a table column_](https://help.tableau.com/current/api/metadata_api/en-us/reference/column.doc.html "Column - GraphQL type for a table column") - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/api/metadata_api/en-us/reference/query.doc.html "Query - Query root for Metadata GraphQL interface") _menu_ Types INPUT\_OBJECT # ColumnField\_Required\_Filter Filter by GraphQL field and given value ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input ColumnField_Required_Filter { - # Name shown in server and desktop clients - name: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Name shown in server and desktop clients - nameWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.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/current/api/metadata_api/en-us/reference/id.doc.html) - # Unique identifier used by the metadata API. Not the same as the numeric ID used - # on server - idWithin: [[ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html)] - } ` ## [_link_](#require-by) Require by This element is not required by anyone _menu_ Types ENUM # ColumnFieldOrderField Enum for fields that can be used for sorting ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - enum ColumnFieldOrderField { - # Sort by downstreamSheets count - DOWNSTREAM_SHEETS_COUNT - # Sort by dataCategory - DATA_CATEGORY - # Sort by dataType - DATA_TYPE - # Sort by id - ID - # Sort by isHidden - IS_HIDDEN - # Sort by name - NAME - # Sort by role - ROLE - } ` ## [_link_](#require-by) Require by - [ColumnFieldSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnfieldsortorder.doc.html "ColumnFieldSortOrder - 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.") _menu_ Types OBJECT # ColumnFieldsConnection Connection Type for ColumnField ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type ColumnFieldsConnection { - # List of nodes - nodes: [[ColumnField](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnfield.doc.html)!]! - # Information for pagination - pageInfo: [PageInfo](https://help.tableau.com/current/api/metadata_api/en-us/reference/pageinfo.doc.html)! - # Total number of objects in connection - totalCount: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html)! - } ` ## [_link_](#require-by) Require by - [Column_GraphQL type for a table column_](https://help.tableau.com/current/api/metadata_api/en-us/reference/column.doc.html "Column - GraphQL type for a table column") - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/api/metadata_api/en-us/reference/query.doc.html "Query - Query root for Metadata GraphQL interface") _menu_ Types INPUT\_OBJECT # ColumnFieldSortOrder 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. ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input ColumnFieldSortOrder { - # GraphQL field to sort on - field: [ColumnFieldOrderField](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnfieldorderfield.doc.html)! - # Order direction to sort output - direction: [OrderDirection](https://help.tableau.com/current/api/metadata_api/en-us/reference/orderdirection.doc.html)! - } ` ## [_link_](#require-by) Require by - [Column_GraphQL type for a table column_](https://help.tableau.com/current/api/metadata_api/en-us/reference/column.doc.html "Column - GraphQL type for a table column") - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/api/metadata_api/en-us/reference/query.doc.html "Query - Query root for Metadata GraphQL interface") _menu_ Types ENUM # ColumnOrderField Enum for fields that can be used for sorting ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - enum ColumnOrderField { - # Sort by downstreamSheets count - DOWNSTREAM_SHEETS_COUNT - # Sort by displayName - DISPLAY_NAME - # Sort by hasActiveWarning - HAS_ACTIVE_WARNING - # Sort by id - ID - # Sort by luid - LUID - # Sort by name - NAME - } ` ## [_link_](#require-by) Require by - [ColumnSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnsortorder.doc.html "ColumnSortOrder - 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.") _menu_ Types OBJECT # ColumnsConnection Connection Type for Column ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type ColumnsConnection { - # List of nodes - nodes: [[Column](https://help.tableau.com/current/api/metadata_api/en-us/reference/column.doc.html)!]! - # Information for pagination - pageInfo: [PageInfo](https://help.tableau.com/current/api/metadata_api/en-us/reference/pageinfo.doc.html)! - # Total number of objects in connection - totalCount: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.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/current/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/current/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") - [Column_GraphQL type for a table column_](https://help.tableau.com/current/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/current/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/current/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/current/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/current/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.") - [Dashboard_A dashboard contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard.doc.html "Dashboard - A dashboard contained in a published workbook.") - [DatabaseTable_A table that is contained in a database_](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable.doc.html "DatabaseTable - A table that is contained in a database") - [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/current/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/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [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/current/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/current/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") - [Metric_Metrics are time series data constructed from fields contained in views. \*Retired in Tableau Cloud February 2024 / Server 2024.2.\*_](metric.doc.html "Metric - Metrics are time series data constructed from fields contained in views. *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.*") - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/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/current/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") - [Sheet_A sheet contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html "Sheet - A sheet contained in a published workbook.") - [Table_A table containing columns_](https://help.tableau.com/current/api/metadata_api/en-us/reference/table.doc.html "Table - A table containing columns") - [Tag_A tag associated with content items_](https://help.tableau.com/current/api/metadata_api/en-us/reference/tag.doc.html "Tag - A tag associated with content items") - [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.*") _menu_ Types INPUT\_OBJECT # ColumnSortOrder 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. ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input ColumnSortOrder { - # GraphQL field to sort on - field: [ColumnOrderField](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnorderfield.doc.html)! - # Order direction to sort output - direction: [OrderDirection](https://help.tableau.com/current/api/metadata_api/en-us/reference/orderdirection.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/current/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/current/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") - [Column_GraphQL type for a table column_](https://help.tableau.com/current/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/current/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/current/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/current/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/current/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.") - [Dashboard_A dashboard contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard.doc.html "Dashboard - A dashboard contained in a published workbook.") - [DatabaseTable_A table that is contained in a database_](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable.doc.html "DatabaseTable - A table that is contained in a database") - [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/current/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/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [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/current/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/current/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") - [Metric_Metrics are time series data constructed from fields contained in views. \*Retired in Tableau Cloud February 2024 / Server 2024.2.\*_](metric.doc.html "Metric - Metrics are time series data constructed from fields contained in views. *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.*") - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/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/current/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") - [Sheet_A sheet contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html "Sheet - A sheet contained in a published workbook.") - [Table_A table containing columns_](https://help.tableau.com/current/api/metadata_api/en-us/reference/table.doc.html "Table - A table containing columns") - [Tag_A tag associated with content items_](https://help.tableau.com/current/api/metadata_api/en-us/reference/tag.doc.html "Tag - A tag associated with content items") - [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.*") _menu_ Types OBJECT # CombinedField GraphQL type for a combined field. Combined fields concatanate fields together into one string. ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type CombinedField implements [Field](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.doc.html), [FieldReferencingField](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield.doc.html), [Node](https://help.tableau.com/current/api/metadata_api/en-us/reference/node.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/current/api/metadata_api/en-us/reference/id.doc.html)! - # Name shown in server and desktop clients - name: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Name internally used to uniquely identify fields - fullyQualifiedName: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Description of field shown in server and desktop clients - description: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # description that is shown in the Tableau UI - # - # Arguments - # **inheritanceType**: Method for selecting inherited value - # **permissionMode**: Option to select how to apply permissions. By - # default it is OBFUSCATE_RESULTS - descriptionInherited( - inheritanceType: [InheritanceType](https://help.tableau.com/current/api/metadata_api/en-us/reference/inheritancetype.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[InheritedStringResult](https://help.tableau.com/current/api/metadata_api/en-us/reference/inheritedstringresult.doc.html)] - # True if the field is hidden - isHidden: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) - # Name of folder if the field is in a folder. See - # https://onlinehelp.tableau.com/current/pro/desktop/en-us/datafields_dwfeatures.html#Organize - folderName: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # List of fields, if any, that this field references - # - # 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. - fields( - filter: [Field_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/field_filter.doc.html), - orderBy: [FieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Field](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.doc.html)!]! - # List of fields, if any, that this field references - # - # 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. - fieldsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Field_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/field_filter.doc.html), - orderBy: [FieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsconnection.doc.html) - # Columns downstream of this field - # - # 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. - downstreamColumns( - filter: [Column_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/column_filter.doc.html), - orderBy: [ColumnSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Column](https://help.tableau.com/current/api/metadata_api/en-us/reference/column.doc.html)!]! - # Columns downstream of this field - # - # 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. - downstreamColumnsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Column_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/column_filter.doc.html), - orderBy: [ColumnSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [ColumnsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnsconnection.doc.html) - # Tables downstream of this field - # - # 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. - downstreamTables( - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DatabaseTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable.doc.html)!]! - # Tables downstream of this field - # - # 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. - downstreamTablesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabaseTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesconnection.doc.html) - # Virtual connection tables downstream of this field - # - # 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/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnectionTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable.doc.html)!]! - # Virtual connection tables downstream of this field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnectionTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesconnection.doc.html) - # Virtual connections downstream of this field - # - # 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. - downstreamVirtualConnections( - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection.doc.html)!]! - # Virtual connections downstream of this field - # - # 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. - downstreamVirtualConnectionsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsconnection.doc.html) - # Databases downstream of this field - # - # 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. - downstreamDatabases( - filter: [Database_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Database](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html)!]! - # Databases downstream of this field - # - # 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. - downstreamDatabasesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Database_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabasesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesconnection.doc.html) - # Flows downstream of this field - # - # 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/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Flow](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow.doc.html)!]! - # Flows downstream of this field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Flow_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FlowsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsconnection.doc.html) - # downstream fields that reference this field - # - # 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. - downstreamFields( - filter: [Field_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/field_filter.doc.html), - orderBy: [FieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Field](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.doc.html)!]! - # downstream fields that reference this field - # - # 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. - downstreamFieldsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Field_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/field_filter.doc.html), - orderBy: [FieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsconnection.doc.html) - # Datasources connected downstream from this field - # - # 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/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[PublishedDatasource](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource.doc.html)!] - # Datasources connected downstream from this field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [PublishedDatasource_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [PublishedDatasourcesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesconnection.doc.html) - # Lenses connected downstream from this field - # - # 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/current/api/metadata_api/en-us/reference/lens_filter.doc.html), - orderBy: [LensSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/lenssortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Lens](https://help.tableau.com/current/api/metadata_api/en-us/reference/lens.doc.html)!] - # Lenses connected downstream from this field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Lens_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/lens_filter.doc.html), - orderBy: [LensSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/lenssortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [LensesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensesconnection.doc.html) - # Sheets connected downstream from the field - # - # 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/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Sheet](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html)!]! - # Sheets connected downstream from the field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Sheet_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [SheetsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsconnection.doc.html) - # Dashboards connected downstream from the field - # - # 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/current/api/metadata_api/en-us/reference/dashboard_filter.doc.html), - orderBy: [DashboardSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboardsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Dashboard](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard.doc.html)!]! - # Dashboards connected downstream from the field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Dashboard_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard_filter.doc.html), - orderBy: [DashboardSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboardsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DashboardsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboardsconnection.doc.html) - # Workbooks connected downstream from the field - # - # 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/current/api/metadata_api/en-us/reference/workbook_filter.doc.html), - orderBy: [WorkbookSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Workbook](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbook.doc.html)!] - # Workbooks connected downstream from the field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Workbook_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbook_filter.doc.html), - orderBy: [WorkbookSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [WorkbooksConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksconnection.doc.html) - # Metrics connected downstream from the field - # - # 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/current/api/metadata_api/en-us/reference/metric_filter.doc.html), - orderBy: [MetricSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Metric](https://help.tableau.com/current/api/metadata_api/en-us/reference/metric.doc.html)!] - # Metrics connected downstream from the field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Metric_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metric_filter.doc.html), - orderBy: [MetricSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [MetricsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricsconnection.doc.html) - # Workbook owners (authors) connected downstream from the field - # - # 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/current/api/metadata_api/en-us/reference/tableauuser_filter.doc.html), - orderBy: [TableauUserSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauusersortorder.doc.html) - ): [[TableauUser](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauuser.doc.html)!] - # Workbook owners (authors) connected downstream from the field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [TableauUser_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauuser_filter.doc.html), - orderBy: [TableauUserSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauusersortorder.doc.html) - ): [TableauUsersConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauusersconnection.doc.html) - # Tables connected upstream from the field - # - # 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/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DatabaseTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable.doc.html)!]! - # Tables connected upstream from the field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabaseTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesconnection.doc.html) - # Virtual connection tables upstream of this field - # - # 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/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnectionTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable.doc.html)!]! - # Virtual connection tables upstream of this field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnectionTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesconnection.doc.html) - # Virtual connections upstream of this field - # - # 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. - upstreamVirtualConnections( - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection.doc.html)!]! - # Virtual connections upstream of this field - # - # 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. - upstreamVirtualConnectionsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsconnection.doc.html) - # Databases connected upstream from the field - # - # 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/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Database](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html)!]! - # Databases connected upstream from the field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Database_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabasesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesconnection.doc.html) - # Flows connected upstream from the field - # - # 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/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Flow](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow.doc.html)!]! - # Flows connected upstream from the field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Flow_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FlowsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsconnection.doc.html) - # Datasources connected upstream from the field - # - # 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/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[PublishedDatasource](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource.doc.html)!]! - # Datasources connected upstream from the field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [PublishedDatasource_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [PublishedDatasourcesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesconnection.doc.html) - # The field that references this field - # - # 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. - referencedByFields( - filter: [FieldReferencingField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield_filter.doc.html), - orderBy: [FieldReferencingFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[FieldReferencingField](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield.doc.html)] - # The field that references this field - # - # 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. - referencedByFieldsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [FieldReferencingField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield_filter.doc.html), - orderBy: [FieldReferencingFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FieldReferencingFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfieldsconnection.doc.html) - # Data source that contains this field - datasource: [Datasource](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasource.doc.html) - # Metric definitions that reference this data source field. - # - # 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. - metricDefinitions( - filter: [MetricDefinition_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinition_filter.doc.html), - orderBy: [MetricDefinitionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[MetricDefinition](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinition.doc.html)] - # Metric definitions that reference this data source field. - # - # 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. - metricDefinitionsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [MetricDefinition_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinition_filter.doc.html), - orderBy: [MetricDefinitionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [MetricDefinitionsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsconnection.doc.html) - # The data source filters that include this field - # - # 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. - referencedByFilters( - filter: [DatasourceFilter_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefilter_filter.doc.html), - orderBy: [DatasourceFilterSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefiltersortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DatasourceFilter](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefilter.doc.html)] - # The data source filters that include this field - # - # 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. - referencedByFiltersConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DatasourceFilter_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefilter_filter.doc.html), - orderBy: [DatasourceFilterSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefiltersortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatasourceFiltersConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefiltersconnection.doc.html) - # The bin field that references this field - # - # 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. - referencedByBins( - filter: [BinField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/binfield_filter.doc.html), - orderBy: [BinFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/binfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[BinField](https://help.tableau.com/current/api/metadata_api/en-us/reference/binfield.doc.html)] - # The bin field that references this field - # - # 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. - referencedByBinsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [BinField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/binfield_filter.doc.html), - orderBy: [BinFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/binfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [BinFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/binfieldsconnection.doc.html) - # The calculated field that references this field - # - # 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. - referencedByCalculations( - filter: [CalculatedField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/calculatedfield_filter.doc.html), - orderBy: [CalculatedFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/calculatedfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[CalculatedField](https://help.tableau.com/current/api/metadata_api/en-us/reference/calculatedfield.doc.html)] - # The calculated field that references this field - # - # 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. - referencedByCalculationsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [CalculatedField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/calculatedfield_filter.doc.html), - orderBy: [CalculatedFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/calculatedfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [CalculatedFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/calculatedfieldsconnection.doc.html) - # The combined field that references this field - # - # 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. - referencedByCombinedFields( - filter: [CombinedField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedfield_filter.doc.html), - orderBy: [CombinedFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[CombinedField](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedfield.doc.html)] - # The combined field that references this field - # - # 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. - referencedByCombinedFieldsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [CombinedField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedfield_filter.doc.html), - orderBy: [CombinedFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [CombinedFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedfieldsconnection.doc.html) - # Thie combined set field that references this field - # - # 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. - referencedByCombinedSets( - filter: [CombinedSetField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedsetfield_filter.doc.html), - orderBy: [CombinedSetFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedsetfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[CombinedSetField](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedsetfield.doc.html)] - # Thie combined set field that references this field - # - # 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. - referencedByCombinedSetsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [CombinedSetField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedsetfield_filter.doc.html), - orderBy: [CombinedSetFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedsetfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [CombinedSetFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedsetfieldsconnection.doc.html) - # The field that references this remote field - # - # 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. - referencedByRemoteFields( - filter: [DatasourceField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefield_filter.doc.html), - orderBy: [DatasourceFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DatasourceField](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefield.doc.html)] - # The field that references this remote field - # - # 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. - referencedByRemoteFieldsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DatasourceField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefield_filter.doc.html), - orderBy: [DatasourceFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatasourceFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefieldsconnection.doc.html) - # The group field that references this field - # - # 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. - referencedByGroups( - filter: [GroupField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/groupfield_filter.doc.html), - orderBy: [GroupFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/groupfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[GroupField](https://help.tableau.com/current/api/metadata_api/en-us/reference/groupfield.doc.html)] - # The group field that references this field - # - # 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. - referencedByGroupsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [GroupField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/groupfield_filter.doc.html), - orderBy: [GroupFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/groupfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [GroupFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/groupfieldsconnection.doc.html) - # The set field that this field references - # - # 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. - referencedBySets( - filter: [SetField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/setfield_filter.doc.html), - orderBy: [SetFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/setfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[SetField](https://help.tableau.com/current/api/metadata_api/en-us/reference/setfield.doc.html)] - # The set field that this field references - # - # 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. - referencedBySetsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [SetField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/setfield_filter.doc.html), - orderBy: [SetFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/setfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [SetFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/setfieldsconnection.doc.html) - # The hierarchy field that references this field - # - # 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. - referencedByHierarchies( - filter: [HierarchyField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/hierarchyfield_filter.doc.html), - orderBy: [HierarchyFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/hierarchyfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[HierarchyField](https://help.tableau.com/current/api/metadata_api/en-us/reference/hierarchyfield.doc.html)] - # The hierarchy field that references this field - # - # 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. - referencedByHierarchiesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [HierarchyField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/hierarchyfield_filter.doc.html), - orderBy: [HierarchyFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/hierarchyfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [HierarchyFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/hierarchyfieldsconnection.doc.html) - # Sheets that reference this data source field - # - # 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. - sheets( - filter: [Sheet_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Sheet](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html)] - # Sheets that reference this data source field - # - # 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. - sheetsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Sheet_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [SheetsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsconnection.doc.html) - # Sheets that reference this field - # - # 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. - directSheets( - filter: [Sheet_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Sheet](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html)] - # Sheets that reference this field - # - # 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. - directSheetsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Sheet_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [SheetsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsconnection.doc.html) - # List of lens fields which are derived from this field - # - # 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. - derivedLensFields( - filter: [LensField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensfield_filter.doc.html), - orderBy: [LensFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[LensField](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensfield.doc.html)] - # List of lens fields which are derived from this field - # - # 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. - derivedLensFieldsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [LensField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensfield_filter.doc.html), - orderBy: [LensFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [LensFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensfieldsconnection.doc.html) - # A flow input field that wraps this field - # - # 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. - referencedByFlowFieldInputField( - filter: [FlowFieldInputField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfield_filter.doc.html), - orderBy: [FlowFieldInputFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfieldsortorder.doc.html) - ): [[FlowFieldInputField](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfield.doc.html)] - # A flow input field that wraps this field - # - # 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. - referencedByFlowFieldInputFieldConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [FlowFieldInputField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfield_filter.doc.html), - orderBy: [FlowFieldInputFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfieldsortorder.doc.html) - ): [FlowFieldInputFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfieldsconnection.doc.html) - # A flow output field that wraps this field - # - # 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. - referencedByFlowFieldOutputField( - filter: [FlowFieldOutputField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfield_filter.doc.html), - orderBy: [FlowFieldOutputFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[FlowFieldOutputField](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfield.doc.html)] - # A flow output field that wraps this field - # - # 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. - referencedByFlowFieldOutputFieldConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [FlowFieldOutputField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfield_filter.doc.html), - orderBy: [FlowFieldOutputFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FlowFieldOutputFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfieldsconnection.doc.html) - # fields that are upstream of this field - # - # 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. - upstreamFields( - filter: [Field_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/field_filter.doc.html), - orderBy: [FieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Field](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.doc.html)]! - # fields that are upstream of this field - # - # 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. - upstreamFieldsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Field_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/field_filter.doc.html), - orderBy: [FieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsconnection.doc.html) - # Metric definitions downstream from this field. - # - # 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/current/api/metadata_api/en-us/reference/metricdefinition_filter.doc.html), - orderBy: [MetricDefinitionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[MetricDefinition](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinition.doc.html)] - # Metric definitions downstream from this field. - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [MetricDefinition_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinition_filter.doc.html), - orderBy: [MetricDefinitionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [MetricDefinitionsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsconnection.doc.html) - # All upstream columns this field references - # - # 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. - upstreamColumns( - filter: [Column_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/column_filter.doc.html), - orderBy: [ColumnSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Column](https://help.tableau.com/current/api/metadata_api/en-us/reference/column.doc.html)]! - # All upstream columns this field references - # - # 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. - upstreamColumnsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Column_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/column_filter.doc.html), - orderBy: [ColumnSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [ColumnsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnsconnection.doc.html) - } ` ## [_link_](#require-by) Require by - [AnalyticsField_Base GraphQL type for a field containing analytics metadata_](https://help.tableau.com/current/api/metadata_api/en-us/reference/analyticsfield.doc.html "AnalyticsField - Base GraphQL type for a field containing analytics metadata") - [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/current/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/current/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") - [ColumnField_ColumnFields are a type of field which directly connects to a column in some type of table._](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/combinedfield.doc.html "CombinedField - GraphQL type for a combined field. Combined fields concatanate fields together into one string.") - [CombinedFieldsConnection_Connection Type for CombinedField_](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedfieldsconnection.doc.html "CombinedFieldsConnection - Connection Type for CombinedField") - [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/current/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") - [DataField_Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField._](https://help.tableau.com/current/api/metadata_api/en-us/reference/datafield.doc.html "DataField - Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField.") - [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/current/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/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [FieldReferencingField_Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula._](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield.doc.html "FieldReferencingField - Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula.") - [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/current/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/current/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") - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/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/current/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") _menu_ Types INPUT\_OBJECT # CombinedField\_Filter Filter by GraphQL field and given value ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input CombinedField_Filter { - # Name shown in server and desktop clients - name: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Name shown in server and desktop clients - nameWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.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/current/api/metadata_api/en-us/reference/id.doc.html) - # Unique identifier used by the metadata API. Not the same as the numeric ID used - # on server - idWithin: [[ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html)] - # True if the field is hidden - isHidden: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) - # True if the field is hidden - isHiddenWithin: [[Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html)] - # Filter the output based on text query. - text: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - } ` ## [_link_](#require-by) Require by - [AnalyticsField_Base GraphQL type for a field containing analytics metadata_](https://help.tableau.com/current/api/metadata_api/en-us/reference/analyticsfield.doc.html "AnalyticsField - Base GraphQL type for a field containing analytics metadata") - [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/current/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/current/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") - [ColumnField_ColumnFields are a type of field which directly connects to a column in some type of table._](https://help.tableau.com/current/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/current/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/current/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") - [DataField_Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField._](https://help.tableau.com/current/api/metadata_api/en-us/reference/datafield.doc.html "DataField - Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField.") - [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/current/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/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [FieldReferencingField_Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula._](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield.doc.html "FieldReferencingField - Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula.") - [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/current/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/current/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") - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/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/current/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") _menu_ Types INPUT\_OBJECT # CombinedField\_Required\_Filter Filter by GraphQL field and given value ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input CombinedField_Required_Filter { - # Name shown in server and desktop clients - name: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Name shown in server and desktop clients - nameWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.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/current/api/metadata_api/en-us/reference/id.doc.html) - # Unique identifier used by the metadata API. Not the same as the numeric ID used - # on server - idWithin: [[ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html)] - } ` ## [_link_](#require-by) Require by This element is not required by anyone _menu_ Types ENUM # CombinedFieldOrderField Enum for fields that can be used for sorting ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - enum CombinedFieldOrderField { - # Sort by downstreamSheets count - DOWNSTREAM_SHEETS_COUNT - # Sort by fields count - FIELDS_COUNT - # Sort by id - ID - # Sort by isHidden - IS_HIDDEN - # Sort by name - NAME - } ` ## [_link_](#require-by) Require by - [CombinedFieldSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedfieldsortorder.doc.html "CombinedFieldSortOrder - 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.") _menu_ Types OBJECT # CombinedFieldsConnection Connection Type for CombinedField ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type CombinedFieldsConnection { - # List of nodes - nodes: [[CombinedField](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedfield.doc.html)!]! - # Information for pagination - pageInfo: [PageInfo](https://help.tableau.com/current/api/metadata_api/en-us/reference/pageinfo.doc.html)! - # Total number of objects in connection - totalCount: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html)! - } ` ## [_link_](#require-by) Require by - [AnalyticsField_Base GraphQL type for a field containing analytics metadata_](https://help.tableau.com/current/api/metadata_api/en-us/reference/analyticsfield.doc.html "AnalyticsField - Base GraphQL type for a field containing analytics metadata") - [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/current/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/current/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") - [ColumnField_ColumnFields are a type of field which directly connects to a column in some type of table._](https://help.tableau.com/current/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/current/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/current/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") - [DataField_Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField._](https://help.tableau.com/current/api/metadata_api/en-us/reference/datafield.doc.html "DataField - Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField.") - [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/current/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/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [FieldReferencingField_Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula._](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield.doc.html "FieldReferencingField - Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula.") - [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/current/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/current/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") - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/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/current/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") _menu_ Types INPUT\_OBJECT # CombinedFieldSortOrder 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. ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input CombinedFieldSortOrder { - # GraphQL field to sort on - field: [CombinedFieldOrderField](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedfieldorderfield.doc.html)! - # Order direction to sort output - direction: [OrderDirection](https://help.tableau.com/current/api/metadata_api/en-us/reference/orderdirection.doc.html)! - } ` ## [_link_](#require-by) Require by - [AnalyticsField_Base GraphQL type for a field containing analytics metadata_](https://help.tableau.com/current/api/metadata_api/en-us/reference/analyticsfield.doc.html "AnalyticsField - Base GraphQL type for a field containing analytics metadata") - [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/current/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/current/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") - [ColumnField_ColumnFields are a type of field which directly connects to a column in some type of table._](https://help.tableau.com/current/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/current/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/current/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") - [DataField_Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField._](https://help.tableau.com/current/api/metadata_api/en-us/reference/datafield.doc.html "DataField - Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField.") - [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/current/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/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [FieldReferencingField_Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula._](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield.doc.html "FieldReferencingField - Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula.") - [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/current/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/current/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") - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/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/current/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") _menu_ Types OBJECT # CombinedSetField GraphQL type for a combined set field. See [https://onlinehelp.tableau.com/current/pro/desktop/en-us/sortgroup\_sets\_create.html#Combine](https://onlinehelp.tableau.com/current/pro/desktop/en-us/sortgroup_sets_create.html#Combine) ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type CombinedSetField implements [Field](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.doc.html), [FieldReferencingField](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield.doc.html), [Node](https://help.tableau.com/current/api/metadata_api/en-us/reference/node.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/current/api/metadata_api/en-us/reference/id.doc.html)! - # Name shown in server and desktop clients - name: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Name internally used to uniquely identify fields - fullyQualifiedName: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Description of field shown in server and desktop clients - description: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # description that is shown in the Tableau UI - # - # Arguments - # **inheritanceType**: Method for selecting inherited value - # **permissionMode**: Option to select how to apply permissions. By - # default it is OBFUSCATE_RESULTS - descriptionInherited( - inheritanceType: [InheritanceType](https://help.tableau.com/current/api/metadata_api/en-us/reference/inheritancetype.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[InheritedStringResult](https://help.tableau.com/current/api/metadata_api/en-us/reference/inheritedstringresult.doc.html)] - # True if the field is hidden - isHidden: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) - # Name of folder if the field is in a folder. See - # https://onlinehelp.tableau.com/current/pro/desktop/en-us/datafields_dwfeatures.html#Organize - folderName: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Delimiter used to separate members of the two sets. Usually ',' or ';' - delimiter: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # How the sets are combined. 'All Members in Both Sets', 'Shared Members in Both - # Sets', or 'Except Shared Members' - combinationType: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # List of fields, if any, that this field references - # - # 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. - fields( - filter: [Field_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/field_filter.doc.html), - orderBy: [FieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Field](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.doc.html)!]! - # List of fields, if any, that this field references - # - # 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. - fieldsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Field_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/field_filter.doc.html), - orderBy: [FieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsconnection.doc.html) - # Columns downstream of this field - # - # 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. - downstreamColumns( - filter: [Column_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/column_filter.doc.html), - orderBy: [ColumnSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Column](https://help.tableau.com/current/api/metadata_api/en-us/reference/column.doc.html)!]! - # Columns downstream of this field - # - # 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. - downstreamColumnsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Column_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/column_filter.doc.html), - orderBy: [ColumnSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [ColumnsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnsconnection.doc.html) - # Tables downstream of this field - # - # 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. - downstreamTables( - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DatabaseTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable.doc.html)!]! - # Tables downstream of this field - # - # 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. - downstreamTablesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabaseTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesconnection.doc.html) - # Virtual connection tables downstream of this field - # - # 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/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnectionTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable.doc.html)!]! - # Virtual connection tables downstream of this field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnectionTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesconnection.doc.html) - # Virtual connections downstream of this field - # - # 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. - downstreamVirtualConnections( - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection.doc.html)!]! - # Virtual connections downstream of this field - # - # 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. - downstreamVirtualConnectionsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsconnection.doc.html) - # Databases downstream of this field - # - # 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. - downstreamDatabases( - filter: [Database_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Database](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html)!]! - # Databases downstream of this field - # - # 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. - downstreamDatabasesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Database_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabasesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesconnection.doc.html) - # Flows downstream of this field - # - # 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/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Flow](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow.doc.html)!]! - # Flows downstream of this field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Flow_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FlowsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsconnection.doc.html) - # downstream fields that reference this field - # - # 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. - downstreamFields( - filter: [Field_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/field_filter.doc.html), - orderBy: [FieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Field](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.doc.html)!]! - # downstream fields that reference this field - # - # 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. - downstreamFieldsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Field_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/field_filter.doc.html), - orderBy: [FieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsconnection.doc.html) - # Datasources connected downstream from this field - # - # 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/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[PublishedDatasource](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource.doc.html)!] - # Datasources connected downstream from this field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [PublishedDatasource_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [PublishedDatasourcesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesconnection.doc.html) - # Lenses connected downstream from this field - # - # 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/current/api/metadata_api/en-us/reference/lens_filter.doc.html), - orderBy: [LensSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/lenssortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Lens](https://help.tableau.com/current/api/metadata_api/en-us/reference/lens.doc.html)!] - # Lenses connected downstream from this field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Lens_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/lens_filter.doc.html), - orderBy: [LensSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/lenssortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [LensesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensesconnection.doc.html) - # Sheets connected downstream from the field - # - # 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/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Sheet](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html)!]! - # Sheets connected downstream from the field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Sheet_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [SheetsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsconnection.doc.html) - # Dashboards connected downstream from the field - # - # 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/current/api/metadata_api/en-us/reference/dashboard_filter.doc.html), - orderBy: [DashboardSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboardsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Dashboard](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard.doc.html)!]! - # Dashboards connected downstream from the field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Dashboard_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard_filter.doc.html), - orderBy: [DashboardSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboardsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DashboardsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboardsconnection.doc.html) - # Workbooks connected downstream from the field - # - # 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/current/api/metadata_api/en-us/reference/workbook_filter.doc.html), - orderBy: [WorkbookSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Workbook](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbook.doc.html)!] - # Workbooks connected downstream from the field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Workbook_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbook_filter.doc.html), - orderBy: [WorkbookSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [WorkbooksConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksconnection.doc.html) - # Metrics connected downstream from the field - # - # 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/current/api/metadata_api/en-us/reference/metric_filter.doc.html), - orderBy: [MetricSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Metric](https://help.tableau.com/current/api/metadata_api/en-us/reference/metric.doc.html)!] - # Metrics connected downstream from the field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Metric_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metric_filter.doc.html), - orderBy: [MetricSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [MetricsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricsconnection.doc.html) - # Workbook owners (authors) connected downstream from the field - # - # 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/current/api/metadata_api/en-us/reference/tableauuser_filter.doc.html), - orderBy: [TableauUserSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauusersortorder.doc.html) - ): [[TableauUser](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauuser.doc.html)!] - # Workbook owners (authors) connected downstream from the field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [TableauUser_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauuser_filter.doc.html), - orderBy: [TableauUserSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauusersortorder.doc.html) - ): [TableauUsersConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauusersconnection.doc.html) - # Tables connected upstream from the field - # - # 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/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DatabaseTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable.doc.html)!]! - # Tables connected upstream from the field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabaseTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesconnection.doc.html) - # Virtual connection tables upstream of this field - # - # 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/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnectionTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable.doc.html)!]! - # Virtual connection tables upstream of this field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnectionTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesconnection.doc.html) - # Virtual connections upstream of this field - # - # 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. - upstreamVirtualConnections( - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection.doc.html)!]! - # Virtual connections upstream of this field - # - # 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. - upstreamVirtualConnectionsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsconnection.doc.html) - # Databases connected upstream from the field - # - # 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/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Database](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html)!]! - # Databases connected upstream from the field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Database_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabasesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesconnection.doc.html) - # Flows connected upstream from the field - # - # 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/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Flow](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow.doc.html)!]! - # Flows connected upstream from the field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Flow_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FlowsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsconnection.doc.html) - # Datasources connected upstream from the field - # - # 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/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[PublishedDatasource](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource.doc.html)!]! - # Datasources connected upstream from the field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [PublishedDatasource_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [PublishedDatasourcesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesconnection.doc.html) - # The field that references this field - # - # 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. - referencedByFields( - filter: [FieldReferencingField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield_filter.doc.html), - orderBy: [FieldReferencingFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[FieldReferencingField](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield.doc.html)] - # The field that references this field - # - # 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. - referencedByFieldsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [FieldReferencingField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield_filter.doc.html), - orderBy: [FieldReferencingFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FieldReferencingFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfieldsconnection.doc.html) - # Data source that contains this field - datasource: [Datasource](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasource.doc.html) - # Metric definitions that reference this data source field. - # - # 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. - metricDefinitions( - filter: [MetricDefinition_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinition_filter.doc.html), - orderBy: [MetricDefinitionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[MetricDefinition](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinition.doc.html)] - # Metric definitions that reference this data source field. - # - # 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. - metricDefinitionsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [MetricDefinition_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinition_filter.doc.html), - orderBy: [MetricDefinitionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [MetricDefinitionsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsconnection.doc.html) - # The data source filters that include this field - # - # 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. - referencedByFilters( - filter: [DatasourceFilter_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefilter_filter.doc.html), - orderBy: [DatasourceFilterSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefiltersortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DatasourceFilter](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefilter.doc.html)] - # The data source filters that include this field - # - # 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. - referencedByFiltersConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DatasourceFilter_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefilter_filter.doc.html), - orderBy: [DatasourceFilterSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefiltersortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatasourceFiltersConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefiltersconnection.doc.html) - # The bin field that references this field - # - # 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. - referencedByBins( - filter: [BinField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/binfield_filter.doc.html), - orderBy: [BinFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/binfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[BinField](https://help.tableau.com/current/api/metadata_api/en-us/reference/binfield.doc.html)] - # The bin field that references this field - # - # 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. - referencedByBinsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [BinField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/binfield_filter.doc.html), - orderBy: [BinFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/binfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [BinFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/binfieldsconnection.doc.html) - # The calculated field that references this field - # - # 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. - referencedByCalculations( - filter: [CalculatedField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/calculatedfield_filter.doc.html), - orderBy: [CalculatedFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/calculatedfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[CalculatedField](https://help.tableau.com/current/api/metadata_api/en-us/reference/calculatedfield.doc.html)] - # The calculated field that references this field - # - # 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. - referencedByCalculationsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [CalculatedField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/calculatedfield_filter.doc.html), - orderBy: [CalculatedFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/calculatedfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [CalculatedFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/calculatedfieldsconnection.doc.html) - # The combined field that references this field - # - # 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. - referencedByCombinedFields( - filter: [CombinedField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedfield_filter.doc.html), - orderBy: [CombinedFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[CombinedField](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedfield.doc.html)] - # The combined field that references this field - # - # 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. - referencedByCombinedFieldsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [CombinedField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedfield_filter.doc.html), - orderBy: [CombinedFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [CombinedFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedfieldsconnection.doc.html) - # Thie combined set field that references this field - # - # 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. - referencedByCombinedSets( - filter: [CombinedSetField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedsetfield_filter.doc.html), - orderBy: [CombinedSetFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedsetfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[CombinedSetField](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedsetfield.doc.html)] - # Thie combined set field that references this field - # - # 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. - referencedByCombinedSetsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [CombinedSetField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedsetfield_filter.doc.html), - orderBy: [CombinedSetFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedsetfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [CombinedSetFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedsetfieldsconnection.doc.html) - # The field that references this remote field - # - # 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. - referencedByRemoteFields( - filter: [DatasourceField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefield_filter.doc.html), - orderBy: [DatasourceFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DatasourceField](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefield.doc.html)] - # The field that references this remote field - # - # 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. - referencedByRemoteFieldsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DatasourceField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefield_filter.doc.html), - orderBy: [DatasourceFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatasourceFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefieldsconnection.doc.html) - # The group field that references this field - # - # 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. - referencedByGroups( - filter: [GroupField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/groupfield_filter.doc.html), - orderBy: [GroupFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/groupfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[GroupField](https://help.tableau.com/current/api/metadata_api/en-us/reference/groupfield.doc.html)] - # The group field that references this field - # - # 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. - referencedByGroupsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [GroupField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/groupfield_filter.doc.html), - orderBy: [GroupFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/groupfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [GroupFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/groupfieldsconnection.doc.html) - # The set field that this field references - # - # 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. - referencedBySets( - filter: [SetField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/setfield_filter.doc.html), - orderBy: [SetFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/setfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[SetField](https://help.tableau.com/current/api/metadata_api/en-us/reference/setfield.doc.html)] - # The set field that this field references - # - # 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. - referencedBySetsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [SetField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/setfield_filter.doc.html), - orderBy: [SetFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/setfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [SetFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/setfieldsconnection.doc.html) - # The hierarchy field that references this field - # - # 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. - referencedByHierarchies( - filter: [HierarchyField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/hierarchyfield_filter.doc.html), - orderBy: [HierarchyFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/hierarchyfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[HierarchyField](https://help.tableau.com/current/api/metadata_api/en-us/reference/hierarchyfield.doc.html)] - # The hierarchy field that references this field - # - # 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. - referencedByHierarchiesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [HierarchyField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/hierarchyfield_filter.doc.html), - orderBy: [HierarchyFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/hierarchyfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [HierarchyFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/hierarchyfieldsconnection.doc.html) - # Sheets that reference this data source field - # - # 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. - sheets( - filter: [Sheet_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Sheet](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html)] - # Sheets that reference this data source field - # - # 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. - sheetsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Sheet_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [SheetsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsconnection.doc.html) - # Sheets that reference this field - # - # 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. - directSheets( - filter: [Sheet_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Sheet](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html)] - # Sheets that reference this field - # - # 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. - directSheetsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Sheet_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [SheetsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsconnection.doc.html) - # List of lens fields which are derived from this field - # - # 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. - derivedLensFields( - filter: [LensField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensfield_filter.doc.html), - orderBy: [LensFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[LensField](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensfield.doc.html)] - # List of lens fields which are derived from this field - # - # 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. - derivedLensFieldsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [LensField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensfield_filter.doc.html), - orderBy: [LensFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [LensFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensfieldsconnection.doc.html) - # A flow input field that wraps this field - # - # 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. - referencedByFlowFieldInputField( - filter: [FlowFieldInputField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfield_filter.doc.html), - orderBy: [FlowFieldInputFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfieldsortorder.doc.html) - ): [[FlowFieldInputField](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfield.doc.html)] - # A flow input field that wraps this field - # - # 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. - referencedByFlowFieldInputFieldConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [FlowFieldInputField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfield_filter.doc.html), - orderBy: [FlowFieldInputFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfieldsortorder.doc.html) - ): [FlowFieldInputFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfieldsconnection.doc.html) - # A flow output field that wraps this field - # - # 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. - referencedByFlowFieldOutputField( - filter: [FlowFieldOutputField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfield_filter.doc.html), - orderBy: [FlowFieldOutputFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[FlowFieldOutputField](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfield.doc.html)] - # A flow output field that wraps this field - # - # 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. - referencedByFlowFieldOutputFieldConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [FlowFieldOutputField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfield_filter.doc.html), - orderBy: [FlowFieldOutputFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FlowFieldOutputFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfieldsconnection.doc.html) - # fields that are upstream of this field - # - # 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. - upstreamFields( - filter: [Field_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/field_filter.doc.html), - orderBy: [FieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Field](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.doc.html)]! - # fields that are upstream of this field - # - # 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. - upstreamFieldsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Field_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/field_filter.doc.html), - orderBy: [FieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsconnection.doc.html) - # Metric definitions downstream from this field. - # - # 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/current/api/metadata_api/en-us/reference/metricdefinition_filter.doc.html), - orderBy: [MetricDefinitionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[MetricDefinition](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinition.doc.html)] - # Metric definitions downstream from this field. - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [MetricDefinition_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinition_filter.doc.html), - orderBy: [MetricDefinitionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [MetricDefinitionsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsconnection.doc.html) - # All upstream columns this field references - # - # 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. - upstreamColumns( - filter: [Column_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/column_filter.doc.html), - orderBy: [ColumnSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Column](https://help.tableau.com/current/api/metadata_api/en-us/reference/column.doc.html)]! - # All upstream columns this field references - # - # 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. - upstreamColumnsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Column_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/column_filter.doc.html), - orderBy: [ColumnSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [ColumnsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnsconnection.doc.html) - } ` ## [_link_](#require-by) Require by - [AnalyticsField_Base GraphQL type for a field containing analytics metadata_](https://help.tableau.com/current/api/metadata_api/en-us/reference/analyticsfield.doc.html "AnalyticsField - Base GraphQL type for a field containing analytics metadata") - [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/current/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/current/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") - [ColumnField_ColumnFields are a type of field which directly connects to a column in some type of table._](https://help.tableau.com/current/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/current/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/current/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") - [CombinedSetFieldsConnection_Connection Type for CombinedSetField_](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedsetfieldsconnection.doc.html "CombinedSetFieldsConnection - Connection Type for CombinedSetField") - [DataField_Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField._](https://help.tableau.com/current/api/metadata_api/en-us/reference/datafield.doc.html "DataField - Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField.") - [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/current/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/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [FieldReferencingField_Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula._](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield.doc.html "FieldReferencingField - Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula.") - [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/current/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/current/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") - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/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/current/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") _menu_ Types INPUT\_OBJECT # CombinedSetField\_Filter Filter by GraphQL field and given value ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input CombinedSetField_Filter { - # Name shown in server and desktop clients - name: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Name shown in server and desktop clients - nameWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.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/current/api/metadata_api/en-us/reference/id.doc.html) - # Unique identifier used by the metadata API. Not the same as the numeric ID used - # on server - idWithin: [[ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html)] - # True if the field is hidden - isHidden: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) - # True if the field is hidden - isHiddenWithin: [[Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html)] - # Filter the output based on text query. - text: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - } ` ## [_link_](#require-by) Require by - [AnalyticsField_Base GraphQL type for a field containing analytics metadata_](https://help.tableau.com/current/api/metadata_api/en-us/reference/analyticsfield.doc.html "AnalyticsField - Base GraphQL type for a field containing analytics metadata") - [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/current/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/current/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") - [ColumnField_ColumnFields are a type of field which directly connects to a column in some type of table._](https://help.tableau.com/current/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/current/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/current/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") - [DataField_Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField._](https://help.tableau.com/current/api/metadata_api/en-us/reference/datafield.doc.html "DataField - Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField.") - [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/current/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/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [FieldReferencingField_Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula._](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield.doc.html "FieldReferencingField - Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula.") - [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/current/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/current/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") - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/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/current/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") _menu_ Types INPUT\_OBJECT # CombinedSetField\_Required\_Filter Filter by GraphQL field and given value ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input CombinedSetField_Required_Filter { - # Name shown in server and desktop clients - name: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Name shown in server and desktop clients - nameWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.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/current/api/metadata_api/en-us/reference/id.doc.html) - # Unique identifier used by the metadata API. Not the same as the numeric ID used - # on server - idWithin: [[ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html)] - } ` ## [_link_](#require-by) Require by This element is not required by anyone _menu_ Types ENUM # CombinedSetFieldOrderField Enum for fields that can be used for sorting ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - enum CombinedSetFieldOrderField { - # Sort by downstreamSheets count - DOWNSTREAM_SHEETS_COUNT - # Sort by fields count - FIELDS_COUNT - # Sort by id - ID - # Sort by isHidden - IS_HIDDEN - # Sort by name - NAME - } ` ## [_link_](#require-by) Require by - [CombinedSetFieldSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedsetfieldsortorder.doc.html "CombinedSetFieldSortOrder - 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.") _menu_ Types OBJECT # CombinedSetFieldsConnection Connection Type for CombinedSetField ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type CombinedSetFieldsConnection { - # List of nodes - nodes: [[CombinedSetField](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedsetfield.doc.html)!]! - # Information for pagination - pageInfo: [PageInfo](https://help.tableau.com/current/api/metadata_api/en-us/reference/pageinfo.doc.html)! - # Total number of objects in connection - totalCount: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html)! - } ` ## [_link_](#require-by) Require by - [AnalyticsField_Base GraphQL type for a field containing analytics metadata_](https://help.tableau.com/current/api/metadata_api/en-us/reference/analyticsfield.doc.html "AnalyticsField - Base GraphQL type for a field containing analytics metadata") - [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/current/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/current/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") - [ColumnField_ColumnFields are a type of field which directly connects to a column in some type of table._](https://help.tableau.com/current/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/current/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/current/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") - [DataField_Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField._](https://help.tableau.com/current/api/metadata_api/en-us/reference/datafield.doc.html "DataField - Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField.") - [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/current/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/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [FieldReferencingField_Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula._](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield.doc.html "FieldReferencingField - Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula.") - [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/current/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/current/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") - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/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/current/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") _menu_ Types INPUT\_OBJECT # CombinedSetFieldSortOrder 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. ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input CombinedSetFieldSortOrder { - # GraphQL field to sort on - field: [CombinedSetFieldOrderField](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedsetfieldorderfield.doc.html)! - # Order direction to sort output - direction: [OrderDirection](https://help.tableau.com/current/api/metadata_api/en-us/reference/orderdirection.doc.html)! - } ` ## [_link_](#require-by) Require by - [AnalyticsField_Base GraphQL type for a field containing analytics metadata_](https://help.tableau.com/current/api/metadata_api/en-us/reference/analyticsfield.doc.html "AnalyticsField - Base GraphQL type for a field containing analytics metadata") - [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/current/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/current/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") - [ColumnField_ColumnFields are a type of field which directly connects to a column in some type of table._](https://help.tableau.com/current/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/current/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/current/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") - [DataField_Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField._](https://help.tableau.com/current/api/metadata_api/en-us/reference/datafield.doc.html "DataField - Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField.") - [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/current/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/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [FieldReferencingField_Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula._](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield.doc.html "FieldReferencingField - Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula.") - [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/current/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/current/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") - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/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/current/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") # Common Errors If a query encounters an error, the query results return an error name and description instead of query results. **In this section** ## Common errors The following errors can occur in your Metadata API query. | Error | Error Type | Details | | --- | --- | --- | | ACCESS\_DENIED | Error | You are not authorized to use the Metadata API. | | BACKFILL\_RUNNING | Warning | Still creating the Metadata API Store. Results from the query may be incomplete at this time. | | FEATURE\_DISABLED | Error | Can’t run the query because the Metadata API has not been enabled yet. Run the ‘tsm maintenance metadata-services enable’ command to enable the Metadata API or contact your Tableau administrator. | | FILTER\_REQUIRED | Error | Can’t run the query because you must be an admin. Alternatively, if you are not an admin, you can rerun the query with a field name filter to return results. | | INHERITANCE\_INCOMPLETE | Warning | When queries run in filter mode, inheritance results might be incomplete. | | INVALID\_ARGUMENT | Error | The query contains an undefined fragment ‘n’. Make sure to define the fragment. | |   | Error | Can’t use nested fragments for shortcut query ‘n’. | |   | Error | Can’t use “after” and “offset” pagination at the same time. Remove one of the arguments from the query. | |   | Error | The query contains an invalid cursor. Make sure to use cursors of the same type. | |   | Error | The query contains an invalid cursor. Make sure to use cursors that belong to the same site. | |   | Error | A text filter can’t contain only the following characters: spaces or a single quotation mark. Replace the invalid characters and try again. | |   | Error | Make sure the query contains the field you want to paginate on. | | LINKED\_RESULTS\_INCOMPLETE | Warning | When queries run in filter mode, linked results might be incomplete. | | MAX\_PAGE\_SIZE\_EXCEEDED | Warning | The value chosen for “first” exceeded the maximum page size, so the query results will be limited to the maximum page size instead of the value chosen for “first”. It is recommended that the value chosen for “first” be smaller than the maximum page size, or incomplete results may be returned. | | NODE\_LIMIT\_EXCEEDED | Warning | Showing partial results. The request exceeded the ‘n’ node limit. Use pagination, additional filtering, or both in the query to adjust results. | | PERMISSIONS\_MODE\_SWITCHED | Error | One or more of attributes used in your filter contain sensitive data. Your results have been automatically filtered to contain only the results you have permissions to see. | | RATE\_EXCEEDED | Error | The rate of API requests exceeded what’s allowed. On Tableau Cloud, the query throttling configuration can’t be changed. On Tableau Server, if Metadata API users are seeing frequent RATE\_EXCEEDED errors, a Tableau Server administrator can adjust or disable throttling. See the [metadata.query.throttling.enabled \[↗\]](https://help.tableau.com/current/server/en-us/cli_configuration-set_tsm.htm#metadata_query_throttling_enabled), [metadata.query.throttling.queryCostCapacity \[↗\]](https://help.tableau.com/current/server/en-us/cli_configuration-set_tsm.htm#metadata_query_throttling_queryCostCapacity), and [metadata.query.throttling.tokenRefilledPerSecond \[↗\]](https://help.tableau.com/current/server/en-us/cli_configuration-set_tsm.htm#metadata_query_throttling_tokenRefilledPerSecond) settings for more information. | | SITE\_DISABLED | Error | The Metadata API is not enabled for this site: ‘n’. | | TIME\_LIMIT\_EXCEEDED | Warning | Can’t show all data because the timeout limit ‘n’ has been exceeded. Use pagination, additional filtering, or both in the query, and try again. | | USER\_VISIBILITY\_IS\_LIMITED | Warning | The attributes used in your sort contain sensitive data so results exclude the sort. | ## Other errors #### Some edge names do not exist on CanHaveLabels interface Starting with Tableau Cloud March 2023 and Tableau Server 2023.1, DataQualityWarning.asset and DataQualityCertification.asset point to the CanHaveLabels interface instead of the Warnable and Certifiable interfaces. Though they share many of the same edge names, some edge names available on the Warnable and Certifiable interfaces do not exist on the CanHaveLabels interface, and queries that use those edges will now produce an error similar to the following: > `Validation error of type FieldUndefined: Field 'dataQualityWarnings' in type` `'CanHaveLabels' is undefined @ 'dataQualityWarnings/asset/dataQualityWarnings'` The following edges will produce an error like the above if referenced through DataQualityWarning.asset or DataQualityCertification.asset: - hasActiveWarning - dataQualityWarnings - dataQualityWarningsConnection - isCertified - dataQualityCertifications - dataQualityCertificationsConnection **Example query that produces an error:** ``` query myQuery { dataQualityWarnings { asset { dataQualityWarnings { message } } } } ``` The above query produces an error because the dataQualityWarnings.asset (which points to the CanHaveLabels interface) does not have a field named dataQualityWarnings. Before Tableau Cloud March 2023 and Tableau Server 2023.1, the query did not produce an error because dataQualityWarnings.asset pointed to the Warnable interface, and that interface did have a field named dataQualityWarnings. The query should be adjusted to either: - Resolution 1: Use the Labels type - Resolution 2: use an [inline fragment \[↗\]](https://graphql.org/learn/queries/#inline-fragments) to match Warnable or Certifiable as required. **Resolution 1: Use the labels edge instead of the dataQualityWarnings edge** ``` query myQuery { dataQualityWarnings { asset { labels { message } } } } ``` **Resolution 2: Use an [inline fragment \[↗\]](https://graphql.org/learn/queries/#inline-fragments) to limit the interfaces to Warnable** ``` query myQuery { dataQualityWarnings { asset { ... on Warnable { dataQualityWarnings { message } } } } } ``` # Connection Types Using the Tableau Metadata API, you can access connection information used by Tableau content like data sources, workbooks, and flows. In some cases you might need to identify the connection type used by the content. When you query a database object or an object that supports the “ConnectionType” property, such as UpstreamDatabases, the query returns the connection type name. **Note:** CustomSQL database object does not support the ConnectionType property. **In this section** ## Map ConnectionType names Use the table below to map the ConnectionType name to the connection name that’s displayed in various places on the Tableau platform. | ConnectionType | Display Name | | --- | --- | | asterncluster | Aster Database | | athena | Amazon Athena | | aurora | Amazon Aurora for MySQL | | awshadoophive | Amazon EMR Hadoop Hive | | azure\_sql\_dw | Azure SQL Data Warehouse | | bigquery | Google BigQuery (ODBC) | | bigsql | IBM BigInsights | | box | Box | | cloudfile:box-excel-direct | Microsoft Excel (Box) | | cloudfile:box-semistructpassivestore-direct | JSON file (Box) | | cloudfile:box-textscan | Text file (Box) | | cloudfile:dropbox-excel-direct | Microsoft Excel (Dropbox) | | cloudfile:dropbox-semistructpassivestore-direct | JSON file (Dropbox) | | cloudfile:dropbox-textscan | Text file (Dropbox) | | cloudfile:googledrive-excel-direct | Microsoft Excel (Google Drive) | | cloudfile:googledrive-semistructpassivestore-direct | JSON file (Google Drive) | | cloudfile:googledrive-textscan | Text file (Google Drive) | | cloudfile:onedrive-excel-direct | Microsoft Excel (OneDrive) | | cloudfile:onedrive-semistructpassivestore-direct | JSON file (OneDrive) | | cloudfile:onedrive-textscan | Text file (OneDrive) | | composite | TIBCO Data Virtualization | | csv | Text File (legacy) | | databricks | Databricks | | dataengine | Tableau Data Engine | | db2 | IBM DB2 | | denodo | Denodo | | denormalized-cube | Denormalized Cube | | drill | Apache Drill | | dropbox | Dropbox | | essbase | Oracle Essbase | | exasolution | Exasol | | excel | Microsoft Excel (legacy) | | excel-direct | Microsoft Excel | | excel-reader | Microsoft Excel Reader | | federated | Federated | | firebird | Firebird | | genericjdbc | Other Databases (JDBC) | | genericodbc | Other Databases (ODBC) | | google-analytics | Google Analytics | | google-sheets | Google Sheets | | googlebigquery | Google BigQuery (JDBC) | | googlecloudsql | Google Cloud SQL | | googledrive | Google Drive | | greenplum | Pivotal Greenplum Database | | hadoophive | Cloudera Hadoop | | hive | Apache Hive | | hortonworkshadoophive | Hortonworks Hadoop Hive | | hyper | Tableau Data Engine | | inmemfederating | In-memory Federating (multi-connection data source) | | jdbc | Other Databases (JDBC) Note: This connectionType might display as “unknown.” | | kognitio | Kognitio | | maprhadoophive | MapR Hadoop Hive | | mariadb | MariaDB | | marklogic | MarkLogic | | memsql | MemSQL | | monetdb | MonetDB | | mongodb | MongoDB BI Connector | | msaccess | Microsoft Access | | msolap | Microsoft Analysis Services | | mysql | MySQL | | mysql\_odbc | unknown | | netezza | IBM PDA (Netezza) | | odata | OData | | odbc | Other Databases (ODBC) Note: This connectionType might display as “unknown.” | | ogr | Spatial File | | ogrdirect | Spatial file | | onedrive | OneDrive | | oracle | Oracle | | paraccel | Actian Matrix | | pdf | PDF file | | pdf-reader | PDF Reader | | postgres | PostgreSQL | | powerpivot | Microsoft PowerPivot | | presto | Presto | | progressopenedge | Progress OpenEdge | | redshift | Amazon Redshift | | remote-domain | Tableau Server | | salesforce | Salesforce | | sapbw | SAP NetWeaver Business Warehouse | | saphana | SAP HANA | | semistructpassivestore | JSON file Note: Sometimes this displays as blank. | | semistructpassivestore-direct | JSON file | | sharepoint | SharePoint Lists | | snowflake | Snowflake | | spark | Spark SQL | | splunk | Splunk | | sqlproxy | Tableau Server | | sqlserver | Microsoft SQL Server | | stat | Statistical File | | stat-direct | Statistical file | | sybasease | SAP Sybase ASE | | sybaseiq | SAP Sybase IQ | | tbio | Teradata OLAP Connector | | teradata | Teradata | | textclean | Text file | | textscan | Text file | | textscan-reader | Text file reader | | vectorwise | Actian Vector | | vertica | Vertica | | vizengine | VizEngine | | webdata | Web Data Connector | | webdata-direct | Web Data Connector | | webdata-direct:anaplan-anaplan | Anaplan | | webdata-direct:google-ads | Google Ads | | webdata-direct:intuit-quickbooks | Intuit QuickBooks Online (9.3-2018.1) | | webdata-direct:intuit-quickbooks-v3 | Intuit QuickBooks Online | | webdata-direct:marketo-marketo | Marketo | | webdata-direct:oracle-eloqua | Oracle Eloqua | | webdata-direct:ServiceNowITSM-ServiceNowITSM | ServiceNow ITSM | # Core Concepts and Definitions This page describes the core concepts and definitions that you’ll see throughout this documentation. These terms and concepts can help you understand the components of the Metadata API, using GraphQL, and how these components relate to what you see and interact with on Tableau Cloud or Tableau Server. **In this section** ## General terms - **Catalog** - a tool that ingests, indexes, and centralizes metadata about your Tableau Cloud or Tableau Server content and their assets. A catalog enables you to build queries to access the metadata. - **Content** - a set of objects (and their metadata) that you can interact with using the Metadata API. Content is typically Tableau-specific objects that you can publish to or create on Tableau Cloud or Tableau Server. Content can include workbooks and projects. - **Assets** - a set of objects (and their attributes) that you can interact with using the Metadata API. Assets are external to Tableau and therefore non-Tableau specific objects. Assets include databases and tables. - **Metadata** - the information about your content and assets that you can query using the Metadata API. - **Lineage** - reveals the origin of an object and its relationship to other related objects in Tableau Cloud or Tableau Server. - **Impact analysis** - using lineage, understand impact of a change through upstream and downstream relationships among objects. - **Metadata model** - the underling rules that Tableau uses to define the roles, relationships, and attributes of a set of related objects. - **GraphQL schema** - describes the functionality available through the Metadata API. - **Query** - a request for data. - **Object** - the item you interact with on Tableau Cloud or Tableau Server. - **Attribute** - a component or characteristic of an object. - **Upstream (object)** - when traversing lineage, whatever information that is above the object you’re evaluating. - **Downstream (object)** - when traversing lineage, whatever information that is below the objects you’re evaluating. - **Shortcut** - a GraphQL field enabled through the Metadata API that queries for common upstream and downstream objects. - **Field description inheritance** - describes field description attributes that can be inherited from upstream objects. - **Linked flow** - a shortcut type that traverses lineage of flows and provides structural metadata about relationships of upstream or downstream flows. ## GraphQL-specific terms - **Graph** - a GraphQL term for a snapshot of the relationship between objects. Graphs are created to get a real-time, real-world shape of your Tableau Cloud or Tableau Server objects. In this documentation, we will refer to a graph as a “query.” - **Root object** - a GraphQL term for the most fundamental type of operation that the GraphQL schema supports. The Metadata API supports a “read” query type. - **Query** - a GraphQL term for a “read” type of a root object. - **Mutation** - a GraphQL term for a “write” type of root object. To add or update metadata, use the Tableau Server REST API. - **Node** - a GraphQL term for an implementation of the catalog. A node is a representation of data. - **Edge** - a GraphQL term for the connection between nodes. An edge represents some type of relationship between two nodes. - **Interface** - A GraphQL term for an implementation of objects that have certain attributes and properties in common. - **Field** - a GraphQL term for an attribute of a node. In this documentation, we will refer to the field as the “object” on which you can query. - **Object type** - a GraphQL term for an attribute of an object. The attributes of an object depend on the object itself and its relationship to other objects. _menu_ Types OBJECT # 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. ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type CustomSQLTable implements [Table](https://help.tableau.com/current/api/metadata_api/en-us/reference/table.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/current/api/metadata_api/en-us/reference/id.doc.html)! - # Name shown in server and desktop clients - name: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # True if the query is unsupported by Tableau Catalog, in which case lineage may - # be incomplete - isUnsupportedCustomSql: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) - # A custom SQL tables is always embedded in Tableau content - isEmbedded: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) - # User modifiable description of this table - description: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Text of the query - query: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Connection type shortname - connectionType: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Columns contained in this table - # - # 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. - columns( - filter: [Column_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/column_filter.doc.html), - orderBy: [ColumnSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Column](https://help.tableau.com/current/api/metadata_api/en-us/reference/column.doc.html)!]! - # Columns contained in this table - # - # 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. - columnsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Column_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/column_filter.doc.html), - orderBy: [ColumnSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [ColumnsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnsconnection.doc.html) - # Actual tables that this query references. - # - # 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: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DatabaseTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable.doc.html)!]! - # Actual tables that this query references. - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabaseTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesconnection.doc.html) - # Database this query is executed on - database: [Database](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html) - # Databases upstream of this table - # - # 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/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Database](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html)!]! - # Databases upstream of this table - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Database_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabasesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesconnection.doc.html) - # Tables upstream of this table - # - # 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/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DatabaseTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable.doc.html)!]! - # Tables upstream of this table - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabaseTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesconnection.doc.html) - # Virtual connection tables upstream of this table - # - # 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. - upstreamVirtualConnections( - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection.doc.html)!]! - # Virtual connection tables upstream of this table - # - # 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. - upstreamVirtualConnectionsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsconnection.doc.html) - # Virtual connection tables upstream of this table - # - # 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/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnectionTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable.doc.html)!]! - # Virtual connection tables upstream of this table - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnectionTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesconnection.doc.html) - # Flows upstream of this table - # - # 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/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Flow](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow.doc.html)!]! - # Flows upstream of this table - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Flow_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FlowsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsconnection.doc.html) - # Datasources upstream of this table - # - # 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/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[PublishedDatasource](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource.doc.html)!]! - # Datasources upstream of this table - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [PublishedDatasource_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [PublishedDatasourcesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesconnection.doc.html) - # Databases downstream of this table - # - # 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. - downstreamDatabases( - filter: [Database_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Database](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html)!]! - # Databases downstream of this table - # - # 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. - downstreamDatabasesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Database_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabasesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesconnection.doc.html) - # Tables downstream of this table - # - # 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. - downstreamTables( - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DatabaseTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable.doc.html)!]! - # Tables downstream of this table - # - # 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. - downstreamTablesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabaseTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesconnection.doc.html) - # Virtual connection tables downstream of this table - # - # 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/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnectionTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable.doc.html)!]! - # Virtual connection tables downstream of this table - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnectionTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesconnection.doc.html) - # Virtual connection downstream of this table - # - # 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. - downstreamVirtualConnections( - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection.doc.html)!]! - # Virtual connection downstream of this table - # - # 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. - downstreamVirtualConnectionsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsconnection.doc.html) - # Flows downstream of this table - # - # 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/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Flow](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow.doc.html)!]! - # Flows downstream of this table - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Flow_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FlowsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsconnection.doc.html) - # Published datasources connected to the table - # - # 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/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[PublishedDatasource](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource.doc.html)!]! - # Published datasources connected to the table - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [PublishedDatasource_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [PublishedDatasourcesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesconnection.doc.html) - # Lenses connected downstream from the table - # - # 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/current/api/metadata_api/en-us/reference/lens_filter.doc.html), - orderBy: [LensSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/lenssortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Lens](https://help.tableau.com/current/api/metadata_api/en-us/reference/lens.doc.html)!]! - # Lenses connected downstream from the table - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Lens_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/lens_filter.doc.html), - orderBy: [LensSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/lenssortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [LensesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensesconnection.doc.html) - # Workbooks connected to the table - # - # 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/current/api/metadata_api/en-us/reference/workbook_filter.doc.html), - orderBy: [WorkbookSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Workbook](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbook.doc.html)!]! - # Workbooks connected to the table - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Workbook_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbook_filter.doc.html), - orderBy: [WorkbookSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [WorkbooksConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksconnection.doc.html) - # Sheets connected to the table - # - # 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/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Sheet](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html)!]! - # Sheets connected to the table - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Sheet_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [SheetsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsconnection.doc.html) - # Dashboards connected to the table - # - # 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/current/api/metadata_api/en-us/reference/dashboard_filter.doc.html), - orderBy: [DashboardSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboardsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Dashboard](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard.doc.html)!]! - # Dashboards connected to the table - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Dashboard_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard_filter.doc.html), - orderBy: [DashboardSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboardsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DashboardsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboardsconnection.doc.html) - # Metrics connected downstream from the table - # - # 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/current/api/metadata_api/en-us/reference/metric_filter.doc.html), - orderBy: [MetricSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Metric](https://help.tableau.com/current/api/metadata_api/en-us/reference/metric.doc.html)!]! - # Metrics connected downstream from the table - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Metric_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metric_filter.doc.html), - orderBy: [MetricSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [MetricsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricsconnection.doc.html) - # Owners of workbooks and published datasources connected to the table - # - # 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/current/api/metadata_api/en-us/reference/tableauuser_filter.doc.html), - orderBy: [TableauUserSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauusersortorder.doc.html) - ): [[TableauUser](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauuser.doc.html)!]! - # Owners of workbooks and published datasources connected to the table - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [TableauUser_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauuser_filter.doc.html), - orderBy: [TableauUserSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauusersortorder.doc.html) - ): [TableauUsersConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauusersconnection.doc.html) - } ` ## [_link_](#require-by) Require by - [CloudFile_A cloud file connection_](https://help.tableau.com/current/api/metadata_api/en-us/reference/cloudfile.doc.html "CloudFile - A cloud file connection") - [CustomSQLTablesConnection_Connection Type for CustomSQLTable_](https://help.tableau.com/current/api/metadata_api/en-us/reference/customsqltablesconnection.doc.html "CustomSQLTablesConnection - Connection Type for CustomSQLTable") - [Database_A database containing tables_](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html "Database - A database containing tables") - [DatabaseServer_A database server connection_](https://help.tableau.com/current/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/current/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.*") - [File_A file connection_](https://help.tableau.com/current/api/metadata_api/en-us/reference/file.doc.html "File - A file connection") - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/api/metadata_api/en-us/reference/query.doc.html "Query - Query root for Metadata GraphQL interface") - [WebDataConnector_A web data connector_](https://help.tableau.com/current/api/metadata_api/en-us/reference/webdataconnector.doc.html "WebDataConnector - A web data connector") _menu_ Types INPUT\_OBJECT # CustomSQLTable\_Filter Filter by GraphQL field and given value ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input CustomSQLTable_Filter { - # Name shown in server and desktop clients - name: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Name shown in server and desktop clients - nameWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.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/current/api/metadata_api/en-us/reference/id.doc.html) - # Unique identifier used by the metadata API. Not the same as the numeric ID used - # on server - idWithin: [[ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html)] - # True if the query is unsupported by Tableau Catalog, in which case lineage may - # be incomplete - isUnsupportedCustomSql: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) - # True if the query is unsupported by Tableau Catalog, in which case lineage may - # be incomplete - isUnsupportedCustomSqlWithin: [[Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html)] - # Filter the output based on text query. - text: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - } ` ## [_link_](#require-by) Require by - [CloudFile_A cloud file connection_](https://help.tableau.com/current/api/metadata_api/en-us/reference/cloudfile.doc.html "CloudFile - A cloud file connection") - [Database_A database containing tables_](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html "Database - A database containing tables") - [DatabaseServer_A database server connection_](https://help.tableau.com/current/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/current/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.*") - [File_A file connection_](https://help.tableau.com/current/api/metadata_api/en-us/reference/file.doc.html "File - A file connection") - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/api/metadata_api/en-us/reference/query.doc.html "Query - Query root for Metadata GraphQL interface") - [WebDataConnector_A web data connector_](https://help.tableau.com/current/api/metadata_api/en-us/reference/webdataconnector.doc.html "WebDataConnector - A web data connector") _menu_ Types ENUM # CustomSQLTableOrderField Enum for fields that can be used for sorting ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - enum CustomSQLTableOrderField { - # Sort by columns count - COLUMNS_COUNT - # Sort by downstreamDashboards count - DOWNSTREAM_DASHBOARDS_COUNT - # Sort by downstreamDatasources count - DOWNSTREAM_DATASOURCES_COUNT - # Sort by downstreamWorkbooks count - DOWNSTREAM_WORKBOOKS_COUNT - # Sort by id - ID - # Sort by isUnsupportedCustomSql - IS_UNSUPPORTED_CUSTOM_SQL - # Sort by name - NAME - } ` ## [_link_](#require-by) Require by - [CustomSQLTableSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/customsqltablesortorder.doc.html "CustomSQLTableSortOrder - 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.") _menu_ Types OBJECT # CustomSQLTablesConnection Connection Type for CustomSQLTable ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type CustomSQLTablesConnection { - # List of nodes - nodes: [[CustomSQLTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/customsqltable.doc.html)!]! - # Information for pagination - pageInfo: [PageInfo](https://help.tableau.com/current/api/metadata_api/en-us/reference/pageinfo.doc.html)! - # Total number of objects in connection - totalCount: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html)! - } ` ## [_link_](#require-by) Require by - [CloudFile_A cloud file connection_](https://help.tableau.com/current/api/metadata_api/en-us/reference/cloudfile.doc.html "CloudFile - A cloud file connection") - [Database_A database containing tables_](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html "Database - A database containing tables") - [DatabaseServer_A database server connection_](https://help.tableau.com/current/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/current/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.*") - [File_A file connection_](https://help.tableau.com/current/api/metadata_api/en-us/reference/file.doc.html "File - A file connection") - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/api/metadata_api/en-us/reference/query.doc.html "Query - Query root for Metadata GraphQL interface") - [WebDataConnector_A web data connector_](https://help.tableau.com/current/api/metadata_api/en-us/reference/webdataconnector.doc.html "WebDataConnector - A web data connector") _menu_ Types INPUT\_OBJECT # CustomSQLTableSortOrder 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. ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input CustomSQLTableSortOrder { - # GraphQL field to sort on - field: [CustomSQLTableOrderField](https://help.tableau.com/current/api/metadata_api/en-us/reference/customsqltableorderfield.doc.html)! - # Order direction to sort output - direction: [OrderDirection](https://help.tableau.com/current/api/metadata_api/en-us/reference/orderdirection.doc.html)! - } ` ## [_link_](#require-by) Require by - [CloudFile_A cloud file connection_](https://help.tableau.com/current/api/metadata_api/en-us/reference/cloudfile.doc.html "CloudFile - A cloud file connection") - [Database_A database containing tables_](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html "Database - A database containing tables") - [DatabaseServer_A database server connection_](https://help.tableau.com/current/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/current/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.*") - [File_A file connection_](https://help.tableau.com/current/api/metadata_api/en-us/reference/file.doc.html "File - A file connection") - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/api/metadata_api/en-us/reference/query.doc.html "Query - Query root for Metadata GraphQL interface") - [WebDataConnector_A web data connector_](https://help.tableau.com/current/api/metadata_api/en-us/reference/webdataconnector.doc.html "WebDataConnector - A web data connector") _menu_ Types OBJECT # Dashboard A dashboard contained in a published workbook. ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type Dashboard implements [View](https://help.tableau.com/current/api/metadata_api/en-us/reference/view.doc.html), [Taggable](https://help.tableau.com/current/api/metadata_api/en-us/reference/taggable.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/current/api/metadata_api/en-us/reference/id.doc.html)! - # Name shown in server and desktop clients - name: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Unique ID for the dashboard generated for and stored within the workbook, - # survives renames, and is used for internal processes - documentViewId: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Locally unique identifier used for the REST API on the Tableau Server (Blank if - # worksheet is hidden in Workbook) - luid: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)! - # Server path to dashboard - path: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Time the dashboard was created - createdAt: [DateTime](https://help.tableau.com/current/api/metadata_api/en-us/reference/datetime.doc.html)! - # Time the dashboard was updated - updatedAt: [DateTime](https://help.tableau.com/current/api/metadata_api/en-us/reference/datetime.doc.html)! - # Index of view; the order it appears in the workbook - index: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html) - # Tags associated with the view - # - # 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/current/api/metadata_api/en-us/reference/tag_filter.doc.html), orderBy: [TagSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tagsortorder.doc.html)): [[Tag](https://help.tableau.com/current/api/metadata_api/en-us/reference/tag.doc.html)!]! - # Tags associated with the view - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Tag_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/tag_filter.doc.html), - orderBy: [TagSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tagsortorder.doc.html) - ): [TagsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/tagsconnection.doc.html) - # Sheets referenced by this dashboard - # - # 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. - sheets( - filter: [Sheet_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Sheet](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html)!]! - # Sheets referenced by this dashboard - # - # 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. - sheetsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Sheet_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [SheetsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsconnection.doc.html) - # AskDataExtensions that are added into this dashboard - # - # 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. - askDataExtensions( - filter: [AskDataExtension_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/askdataextension_filter.doc.html), - orderBy: [AskDataExtensionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/askdataextensionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[AskDataExtension](https://help.tableau.com/current/api/metadata_api/en-us/reference/askdataextension.doc.html)!]! - # AskDataExtensions that are added into this dashboard - # - # 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. - askDataExtensionsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [AskDataExtension_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/askdataextension_filter.doc.html), - orderBy: [AskDataExtensionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/askdataextensionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [AskDataExtensionsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/askdataextensionsconnection.doc.html) - # Sheet field instances used by the sheets referenced by this dashboard - # - # 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. - upstreamSheetFieldInstances( - filter: [Field_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/field_filter.doc.html), - orderBy: [FieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Field](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.doc.html)] - # Sheet field instances used by the sheets referenced by this dashboard - # - # 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. - upstreamSheetFieldInstancesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Field_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/field_filter.doc.html), - orderBy: [FieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsconnection.doc.html) - # Data quality warnings upstream from this dashboard - # - # 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/current/api/metadata_api/en-us/reference/dataqualitywarning_filter.doc.html), - orderBy: [DataQualityWarningSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarningsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DataQualityWarning](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarning.doc.html)!]! - # Data quality warnings upstream from this dashboard - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DataQualityWarning_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarning_filter.doc.html), - orderBy: [DataQualityWarningSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarningsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DataQualityWarningsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarningsconnection.doc.html) - # Labels upstream from this dashboard 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/current/api/metadata_api/en-us/reference/label_filter.doc.html), - orderBy: [LabelSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/labelsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Label](https://help.tableau.com/current/api/metadata_api/en-us/reference/label.doc.html)!]! - # Labels upstream from this dashboard 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Label_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/label_filter.doc.html), - orderBy: [LabelSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/labelsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [LabelsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/labelsconnection.doc.html) - # The workbook that contains this view - workbook: [Workbook](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbook.doc.html) - # The Metrics that reference this View - # - # 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. - referencedByMetrics( - filter: [Metric_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metric_filter.doc.html), - orderBy: [MetricSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Metric](https://help.tableau.com/current/api/metadata_api/en-us/reference/metric.doc.html)] - # The Metrics that reference this View - # - # 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. - referencedByMetricsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Metric_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metric_filter.doc.html), - orderBy: [MetricSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [MetricsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricsconnection.doc.html) - # The fields that are upstream of this dashboard - # - # 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. - upstreamFields( - filter: [Field_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/field_filter.doc.html), - orderBy: [FieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Field](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.doc.html)] - # The fields that are upstream of this dashboard - # - # 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. - upstreamFieldsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Field_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/field_filter.doc.html), - orderBy: [FieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsconnection.doc.html) - # The data sources that are upstream of this dashboard - # - # 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: [Datasource_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasource_filter.doc.html), - orderBy: [DatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Datasource](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasource.doc.html)] - # The data sources that are upstream of this dashboard - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Datasource_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasource_filter.doc.html), - orderBy: [DatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatasourcesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcesconnection.doc.html) - # The tables that are upstream of this dashboard - # - # 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: [Table_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/table_filter.doc.html), - orderBy: [TableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Table](https://help.tableau.com/current/api/metadata_api/en-us/reference/table.doc.html)] - # The tables that are upstream of this dashboard - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Table_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/table_filter.doc.html), - orderBy: [TableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [TablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/tablesconnection.doc.html) - # The databases that are upstream of this dashboard - # - # 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/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Database](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html)] - # The databases that are upstream of this dashboard - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Database_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabasesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesconnection.doc.html) - # The columns that are upstream of this dashboard - # - # 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. - upstreamColumns( - filter: [Column_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/column_filter.doc.html), - orderBy: [ColumnSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Column](https://help.tableau.com/current/api/metadata_api/en-us/reference/column.doc.html)] - # The columns that are upstream of this dashboard - # - # 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. - upstreamColumnsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Column_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/column_filter.doc.html), - orderBy: [ColumnSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [ColumnsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnsconnection.doc.html) - # The Lenses that are upstream of this dashboard - # - # 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. - upstreamLenses( - filter: [Lens_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/lens_filter.doc.html), - orderBy: [LensSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/lenssortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Lens](https://help.tableau.com/current/api/metadata_api/en-us/reference/lens.doc.html)] - # The Lenses that are upstream of this dashboard - # - # 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. - upstreamLensesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Lens_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/lens_filter.doc.html), - orderBy: [LensSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/lenssortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [LensesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensesconnection.doc.html) - # The flows that are upstream of this dashboard - # - # 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/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Flow](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow.doc.html)] - # The flows that are upstream of this dashboard - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Flow_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FlowsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsconnection.doc.html) - } ` ## [_link_](#require-by) Require by - [AskDataExtension_AskDataExtensions to base Tableau functionality._](https://help.tableau.com/current/api/metadata_api/en-us/reference/askdataextension.doc.html "AskDataExtension - AskDataExtensions to base Tableau functionality.") - [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/current/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/current/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/current/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/current/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/current/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/current/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/current/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/current/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.") - [DashboardsConnection_Connection Type for Dashboard_](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboardsconnection.doc.html "DashboardsConnection - Connection Type for Dashboard") - [Database_A database containing tables_](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html "Database - A database containing tables") - [DatabaseServer_A database server connection_](https://help.tableau.com/current/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/current/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.*") - [Datasource_Root GraphQL type for embedded and published data sources Data sources are a way to represent how Tableau Desktop and Tableau Server model and connect to data. Data sources can be published separately, as a published data source, or may be contained in a workbook as an embedded data source. See https://onlinehelp.tableau.com/current/server/en-us/datasource.htm_](datasource.doc.html "Datasource - Root GraphQL type for embedded and published data sources Data sources are a way to represent how Tableau Desktop and Tableau Server model and connect to data. Data sources can be published separately, as a published data source, or may be contained in a workbook as an embedded data source. See https://onlinehelp.tableau.com/current/server/en-us/datasource.htm") - [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/current/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.") - [EmbeddedDatasource_A data source embedded in a workbook_](https://help.tableau.com/current/api/metadata_api/en-us/reference/embeddeddatasource.doc.html "EmbeddedDatasource - A data source embedded in a workbook") - [Field_Base GraphQL type for a field_](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [File_A file connection_](https://help.tableau.com/current/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/current/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/current/api/metadata_api/en-us/reference/flowcolumnoutputfield.doc.html "FlowColumnOutputField - Column output field implementation") - [FlowFieldOutputField_Field output field implementation_](https://help.tableau.com/current/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/current/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/current/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/current/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.*") - [PublishedDatasource_A Tableau data source that has been published separately to Tableau Server. It can be used by multiple workbooks._](https://help.tableau.com/current/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/current/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/current/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") - [Sheet_A sheet contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html "Sheet - A sheet contained in a published workbook.") - [Table_A table containing columns_](https://help.tableau.com/current/api/metadata_api/en-us/reference/table.doc.html "Table - A table containing columns") - [VirtualConnection_A virtual connection. \*Available in Tableau Cloud March 2022 / Server 2022.1 and later.\*_](virtualconnection.doc.html "VirtualConnection - A virtual connection. *Available in Tableau Cloud March 2022 / Server 2022.1 and later.*") - [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/current/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/current/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).") _menu_ Types INPUT\_OBJECT # Dashboard\_Filter Filter by GraphQL field and given value ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input Dashboard_Filter { - # Server path to dashboard - path: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Server path to dashboard - pathWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)] - # Locally unique identifier used for the REST API on the Tableau Server (Blank if - # worksheet is hidden in Workbook) - luid: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Locally unique identifier used for the REST API on the Tableau Server (Blank if - # worksheet is hidden in Workbook) - luidWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)] - # Unique ID for the dashboard generated for and stored within the workbook, - # survives renames, and is used for internal processes - documentViewId: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Unique ID for the dashboard generated for and stored within the workbook, - # survives renames, and is used for internal processes - documentViewIdWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)] - # Name shown in server and desktop clients - name: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Name shown in server and desktop clients - nameWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.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/current/api/metadata_api/en-us/reference/id.doc.html) - # Unique identifier used by the metadata API. Not the same as the numeric ID used - # on server - idWithin: [[ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.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/current/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/current/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/current/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/current/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/current/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/current/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/current/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/current/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/current/api/metadata_api/en-us/reference/database.doc.html "Database - A database containing tables") - [DatabaseServer_A database server connection_](https://help.tableau.com/current/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/current/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.*") - [Datasource_Root GraphQL type for embedded and published data sources Data sources are a way to represent how Tableau Desktop and Tableau Server model and connect to data. Data sources can be published separately, as a published data source, or may be contained in a workbook as an embedded data source. See https://onlinehelp.tableau.com/current/server/en-us/datasource.htm_](datasource.doc.html "Datasource - Root GraphQL type for embedded and published data sources Data sources are a way to represent how Tableau Desktop and Tableau Server model and connect to data. Data sources can be published separately, as a published data source, or may be contained in a workbook as an embedded data source. See https://onlinehelp.tableau.com/current/server/en-us/datasource.htm") - [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/current/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.") - [EmbeddedDatasource_A data source embedded in a workbook_](https://help.tableau.com/current/api/metadata_api/en-us/reference/embeddeddatasource.doc.html "EmbeddedDatasource - A data source embedded in a workbook") - [Field_Base GraphQL type for a field_](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [File_A file connection_](https://help.tableau.com/current/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/current/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/current/api/metadata_api/en-us/reference/flowcolumnoutputfield.doc.html "FlowColumnOutputField - Column output field implementation") - [FlowFieldOutputField_Field output field implementation_](https://help.tableau.com/current/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/current/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/current/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/current/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.*") - [PublishedDatasource_A Tableau data source that has been published separately to Tableau Server. It can be used by multiple workbooks._](https://help.tableau.com/current/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/current/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/current/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") - [Sheet_A sheet contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html "Sheet - A sheet contained in a published workbook.") - [Table_A table containing columns_](https://help.tableau.com/current/api/metadata_api/en-us/reference/table.doc.html "Table - A table containing columns") - [VirtualConnection_A virtual connection. \*Available in Tableau Cloud March 2022 / Server 2022.1 and later.\*_](virtualconnection.doc.html "VirtualConnection - A virtual connection. *Available in Tableau Cloud March 2022 / Server 2022.1 and later.*") - [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/current/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/current/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).") _menu_ Types ENUM # DashboardOrderField Enum for fields that can be used for sorting ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - enum DashboardOrderField { - # Sort by documentViewId - DOCUMENT_VIEW_ID - # Sort by id - ID - # Sort by luid - LUID - # Sort by name - NAME - # Sort by path - PATH - } ` ## [_link_](#require-by) Require by - [DashboardSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboardsortorder.doc.html "DashboardSortOrder - 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.") _menu_ Types OBJECT # DashboardsConnection Connection Type for Dashboard ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type DashboardsConnection { - # List of nodes - nodes: [[Dashboard](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard.doc.html)!]! - # Information for pagination - pageInfo: [PageInfo](https://help.tableau.com/current/api/metadata_api/en-us/reference/pageinfo.doc.html)! - # Total number of objects in connection - totalCount: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.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/current/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/current/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/current/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/current/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/current/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/current/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/current/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/current/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/current/api/metadata_api/en-us/reference/database.doc.html "Database - A database containing tables") - [DatabaseServer_A database server connection_](https://help.tableau.com/current/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/current/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.*") - [Datasource_Root GraphQL type for embedded and published data sources Data sources are a way to represent how Tableau Desktop and Tableau Server model and connect to data. Data sources can be published separately, as a published data source, or may be contained in a workbook as an embedded data source. See https://onlinehelp.tableau.com/current/server/en-us/datasource.htm_](datasource.doc.html "Datasource - Root GraphQL type for embedded and published data sources Data sources are a way to represent how Tableau Desktop and Tableau Server model and connect to data. Data sources can be published separately, as a published data source, or may be contained in a workbook as an embedded data source. See https://onlinehelp.tableau.com/current/server/en-us/datasource.htm") - [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/current/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.") - [EmbeddedDatasource_A data source embedded in a workbook_](https://help.tableau.com/current/api/metadata_api/en-us/reference/embeddeddatasource.doc.html "EmbeddedDatasource - A data source embedded in a workbook") - [Field_Base GraphQL type for a field_](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [File_A file connection_](https://help.tableau.com/current/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/current/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/current/api/metadata_api/en-us/reference/flowcolumnoutputfield.doc.html "FlowColumnOutputField - Column output field implementation") - [FlowFieldOutputField_Field output field implementation_](https://help.tableau.com/current/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/current/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/current/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/current/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.*") - [PublishedDatasource_A Tableau data source that has been published separately to Tableau Server. It can be used by multiple workbooks._](https://help.tableau.com/current/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/current/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/current/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") - [Sheet_A sheet contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html "Sheet - A sheet contained in a published workbook.") - [Table_A table containing columns_](https://help.tableau.com/current/api/metadata_api/en-us/reference/table.doc.html "Table - A table containing columns") - [VirtualConnection_A virtual connection. \*Available in Tableau Cloud March 2022 / Server 2022.1 and later.\*_](virtualconnection.doc.html "VirtualConnection - A virtual connection. *Available in Tableau Cloud March 2022 / Server 2022.1 and later.*") - [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/current/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/current/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).") _menu_ Types INPUT\_OBJECT # DashboardSortOrder 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. ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input DashboardSortOrder { - # GraphQL field to sort on - field: [DashboardOrderField](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboardorderfield.doc.html)! - # Order direction to sort output - direction: [OrderDirection](https://help.tableau.com/current/api/metadata_api/en-us/reference/orderdirection.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/current/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/current/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/current/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/current/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/current/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/current/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/current/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/current/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/current/api/metadata_api/en-us/reference/database.doc.html "Database - A database containing tables") - [DatabaseServer_A database server connection_](https://help.tableau.com/current/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/current/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.*") - [Datasource_Root GraphQL type for embedded and published data sources Data sources are a way to represent how Tableau Desktop and Tableau Server model and connect to data. Data sources can be published separately, as a published data source, or may be contained in a workbook as an embedded data source. See https://onlinehelp.tableau.com/current/server/en-us/datasource.htm_](datasource.doc.html "Datasource - Root GraphQL type for embedded and published data sources Data sources are a way to represent how Tableau Desktop and Tableau Server model and connect to data. Data sources can be published separately, as a published data source, or may be contained in a workbook as an embedded data source. See https://onlinehelp.tableau.com/current/server/en-us/datasource.htm") - [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/current/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.") - [EmbeddedDatasource_A data source embedded in a workbook_](https://help.tableau.com/current/api/metadata_api/en-us/reference/embeddeddatasource.doc.html "EmbeddedDatasource - A data source embedded in a workbook") - [Field_Base GraphQL type for a field_](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [File_A file connection_](https://help.tableau.com/current/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/current/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/current/api/metadata_api/en-us/reference/flowcolumnoutputfield.doc.html "FlowColumnOutputField - Column output field implementation") - [FlowFieldOutputField_Field output field implementation_](https://help.tableau.com/current/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/current/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/current/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/current/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.*") - [PublishedDatasource_A Tableau data source that has been published separately to Tableau Server. It can be used by multiple workbooks._](https://help.tableau.com/current/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/current/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/current/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") - [Sheet_A sheet contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html "Sheet - A sheet contained in a published workbook.") - [Table_A table containing columns_](https://help.tableau.com/current/api/metadata_api/en-us/reference/table.doc.html "Table - A table containing columns") - [VirtualConnection_A virtual connection. \*Available in Tableau Cloud March 2022 / Server 2022.1 and later.\*_](virtualconnection.doc.html "VirtualConnection - A virtual connection. *Available in Tableau Cloud March 2022 / Server 2022.1 and later.*") - [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/current/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/current/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).") _menu_ Types INTERFACE # Database A database containing tables ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - interface Database { - # Unique identifier used by the Metadata API. Not the same as the numeric ID used - # on server - id: [ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html)! - # Vizportal ID of this database, for use in client-to-server communications - vizportalId: [String](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/string.doc.html)! - # Name shown in server and desktop clients - name: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Connection type shortname - connectionType: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # True if this database is embedded in Tableau content, e.g., a packaged workbook - isEmbedded: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) - # User modifiable description of this database - description: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # The ID of the project in which the database is visible. Will be empty if the - # database is not in a project. - projectVizportalUrlId: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # The name of the project in which the database is visible. Will be empty if the - # database is not in a project. - projectName: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Contact for this database - contact: [TableauUser](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauuser.doc.html) - # True if this database contains an active data quality certification - isCertified: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html)! - # True if this database has its permission locked - isControlledPermissionsEnabled: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) - # True if this database has been grouped with other databases - isGrouped: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) - # Notes related to this database being marked as certified - certificationNote: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) @deprecated( reason: "No longer supported. Use 'dataQualityCertifications'" ) - # User who marked this database as certified - certifier: [TableauUser](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauuser.doc.html) @deprecated( reason: "No longer supported. Use 'dataQualityCertifications'" ) - # True if the database has an active data quality warning - hasActiveWarning: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html)! - # The optional data quality warning on a database - dataQualityWarning: [DataQualityWarning](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarning.doc.html) @deprecated( reason: "Use 'dataQualityWarnings'" ) - # The data quality warnings on a 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. - # **permissionMode**: Results filtering mode. - dataQualityWarnings( - filter: [DataQualityWarning_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarning_filter.doc.html), - orderBy: [DataQualityWarningSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarningsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DataQualityWarning](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarning.doc.html)!]! - # The data quality warnings on a 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. - # **permissionMode**: Results filtering mode. - dataQualityWarningsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DataQualityWarning_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarning_filter.doc.html), - orderBy: [DataQualityWarningSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarningsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DataQualityWarningsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarningsconnection.doc.html) - # The data quality certifications on a 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. - # **permissionMode**: Results filtering mode. - dataQualityCertifications( - filter: [DataQualityCertification_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitycertification_filter.doc.html), - orderBy: [DataQualityCertificationSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitycertificationsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DataQualityCertification](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitycertification.doc.html)!]! - # The data quality certifications on a 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. - # **permissionMode**: Results filtering mode. - dataQualityCertificationsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DataQualityCertification_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitycertification_filter.doc.html), - orderBy: [DataQualityCertificationSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitycertificationsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DataQualityCertificationsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitycertificationsconnection.doc.html) - # The labels on a database. 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/current/api/metadata_api/en-us/reference/label_filter.doc.html), - orderBy: [LabelSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/labelsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Label](https://help.tableau.com/current/api/metadata_api/en-us/reference/label.doc.html)!]! - # The labels on a database. 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Label_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/label_filter.doc.html), - orderBy: [LabelSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/labelsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [LabelsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/labelsconnection.doc.html) - # Data quality warnings upstream from this 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. - # **permissionMode**: Results filtering mode. - upstreamDataQualityWarnings( - filter: [DataQualityWarning_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarning_filter.doc.html), - orderBy: [DataQualityWarningSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarningsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DataQualityWarning](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarning.doc.html)!]! - # Data quality warnings upstream from this 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. - # **permissionMode**: Results filtering mode. - upstreamDataQualityWarningsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DataQualityWarning_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarning_filter.doc.html), - orderBy: [DataQualityWarningSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarningsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DataQualityWarningsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarningsconnection.doc.html) - # Labels upstream from this database. 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/current/api/metadata_api/en-us/reference/label_filter.doc.html), - orderBy: [LabelSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/labelsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Label](https://help.tableau.com/current/api/metadata_api/en-us/reference/label.doc.html)!]! - # Labels upstream from this database. 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Label_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/label_filter.doc.html), - orderBy: [LabelSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/labelsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [LabelsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/labelsconnection.doc.html) - # Tags associated with 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. - tags(filter: [Tag_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/tag_filter.doc.html), orderBy: [TagSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tagsortorder.doc.html)): [[Tag](https://help.tableau.com/current/api/metadata_api/en-us/reference/tag.doc.html)!]! - # Tags associated with 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. - tagsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Tag_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/tag_filter.doc.html), - orderBy: [TagSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tagsortorder.doc.html) - ): [TagsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/tagsconnection.doc.html) - # Databases upstream of this 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. - # **permissionMode**: Results filtering mode. - upstreamDatabases( - filter: [Database_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Database](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html)!]! - # Databases upstream of this 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. - # **permissionMode**: Results filtering mode. - upstreamDatabasesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Database_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabasesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesconnection.doc.html) - # Tables upstream of this 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. - # **permissionMode**: Results filtering mode. - upstreamTables( - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DatabaseTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable.doc.html)!]! - # Tables upstream of this 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. - # **permissionMode**: Results filtering mode. - upstreamTablesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabaseTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesconnection.doc.html) - # Virtual connection tables upstream of this 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. - # **permissionMode**: Results filtering mode. - upstreamVirtualConnections( - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection.doc.html)!]! - # Virtual connection tables upstream of this 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. - # **permissionMode**: Results filtering mode. - upstreamVirtualConnectionsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsconnection.doc.html) - # Virtual connection tables upstream of this 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. - # **permissionMode**: Results filtering mode. - upstreamVirtualConnectionTables( - filter: [VirtualConnectionTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnectionTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable.doc.html)!]! - # Virtual connection tables upstream of this 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. - # **permissionMode**: Results filtering mode. - upstreamVirtualConnectionTablesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnectionTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesconnection.doc.html) - # Flows upstream of this 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. - # **permissionMode**: Results filtering mode. - upstreamFlows( - filter: [Flow_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Flow](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow.doc.html)!]! - # Flows upstream of this 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. - # **permissionMode**: Results filtering mode. - upstreamFlowsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Flow_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FlowsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsconnection.doc.html) - # Datasources upstream of this 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. - # **permissionMode**: Results filtering mode. - upstreamDatasources( - filter: [PublishedDatasource_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[PublishedDatasource](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource.doc.html)!]! - # Datasources upstream of this 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. - # **permissionMode**: Results filtering mode. - upstreamDatasourcesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [PublishedDatasource_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [PublishedDatasourcesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesconnection.doc.html) - # Databases downstream of this 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. - # **permissionMode**: Results filtering mode. - downstreamDatabases( - filter: [Database_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Database](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html)!]! - # Databases downstream of this 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. - # **permissionMode**: Results filtering mode. - downstreamDatabasesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Database_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabasesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesconnection.doc.html) - # Tables downstream of this 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. - # **permissionMode**: Results filtering mode. - downstreamTables( - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DatabaseTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable.doc.html)!]! - # Tables downstream of this 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. - # **permissionMode**: Results filtering mode. - downstreamTablesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabaseTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesconnection.doc.html) - # Virtual connection tables downstream of this 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. - # **permissionMode**: Results filtering mode. - downstreamVirtualConnections( - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection.doc.html)!]! - # Virtual connection tables downstream of this 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. - # **permissionMode**: Results filtering mode. - downstreamVirtualConnectionsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsconnection.doc.html) - # Virtual connection tables downstream of this 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. - # **permissionMode**: Results filtering mode. - downstreamVirtualConnectionTables( - filter: [VirtualConnectionTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnectionTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable.doc.html)!]! - # Virtual connection tables downstream of this 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. - # **permissionMode**: Results filtering mode. - downstreamVirtualConnectionTablesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnectionTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesconnection.doc.html) - # Flows downstream of this 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. - # **permissionMode**: Results filtering mode. - downstreamFlows( - filter: [Flow_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Flow](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow.doc.html)!]! - # Flows downstream of this 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. - # **permissionMode**: Results filtering mode. - downstreamFlowsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Flow_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FlowsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsconnection.doc.html) - # Published datasources 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. - # **permissionMode**: Results filtering mode. - downstreamDatasources( - filter: [PublishedDatasource_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[PublishedDatasource](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource.doc.html)!]! - # Published datasources 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. - # **permissionMode**: Results filtering mode. - downstreamDatasourcesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [PublishedDatasource_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [PublishedDatasourcesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesconnection.doc.html) - # Lenses 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. - # **permissionMode**: Results filtering mode. - downstreamLenses( - filter: [Lens_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/lens_filter.doc.html), - orderBy: [LensSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/lenssortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Lens](https://help.tableau.com/current/api/metadata_api/en-us/reference/lens.doc.html)!]! - # Lenses 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. - # **permissionMode**: Results filtering mode. - downstreamLensesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Lens_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/lens_filter.doc.html), - orderBy: [LensSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/lenssortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [LensesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensesconnection.doc.html) - # Workbooks 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. - # **permissionMode**: Results filtering mode. - downstreamWorkbooks( - filter: [Workbook_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbook_filter.doc.html), - orderBy: [WorkbookSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Workbook](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbook.doc.html)!]! - # Workbooks 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. - # **permissionMode**: Results filtering mode. - downstreamWorkbooksConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Workbook_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbook_filter.doc.html), - orderBy: [WorkbookSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [WorkbooksConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksconnection.doc.html) - # Dashboards 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. - # **permissionMode**: Results filtering mode. - downstreamDashboards( - filter: [Dashboard_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard_filter.doc.html), - orderBy: [DashboardSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboardsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Dashboard](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard.doc.html)!]! - # Dashboards 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. - # **permissionMode**: Results filtering mode. - downstreamDashboardsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Dashboard_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard_filter.doc.html), - orderBy: [DashboardSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboardsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DashboardsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboardsconnection.doc.html) - # Sheets 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. - # **permissionMode**: Results filtering mode. - downstreamSheets( - filter: [Sheet_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Sheet](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html)!]! - # Sheets 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. - # **permissionMode**: Results filtering mode. - downstreamSheetsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Sheet_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [SheetsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsconnection.doc.html) - # Metrics 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. - # **permissionMode**: Results filtering mode. - downstreamMetrics( - filter: [Metric_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metric_filter.doc.html), - orderBy: [MetricSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Metric](https://help.tableau.com/current/api/metadata_api/en-us/reference/metric.doc.html)!]! - # Metrics 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. - # **permissionMode**: Results filtering mode. - downstreamMetricsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Metric_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metric_filter.doc.html), - orderBy: [MetricSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [MetricsConnection](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/tableauuser_filter.doc.html), - orderBy: [TableauUserSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauusersortorder.doc.html) - ): [[TableauUser](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [TableauUser_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauuser_filter.doc.html), - orderBy: [TableauUserSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauusersortorder.doc.html) - ): [TableauUsersConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauusersconnection.doc.html) - # The custom SQL queries that reference this 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. - # **permissionMode**: Results filtering mode. - referencedByQueries( - filter: [CustomSQLTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/customsqltable_filter.doc.html), - orderBy: [CustomSQLTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/customsqltablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[CustomSQLTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/customsqltable.doc.html)] - # The custom SQL queries that reference this 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. - # **permissionMode**: Results filtering mode. - referencedByQueriesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [CustomSQLTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/customsqltable_filter.doc.html), - orderBy: [CustomSQLTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/customsqltablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [CustomSQLTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/customsqltablesconnection.doc.html) - # Tables belonging to this 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. - # **permissionMode**: Results filtering mode. - tables( - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DatabaseTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable.doc.html)] - # Tables belonging to this 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. - # **permissionMode**: Results filtering mode. - tablesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabaseTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesconnection.doc.html) - # Metric definitions downstream from this 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. - # **permissionMode**: Results filtering mode. - downstreamMetricDefinitions( - filter: [MetricDefinition_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinition_filter.doc.html), - orderBy: [MetricDefinitionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[MetricDefinition](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinition.doc.html)]! - # Metric definitions downstream from this 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. - # **permissionMode**: Results filtering mode. - downstreamMetricDefinitionsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [MetricDefinition_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinition_filter.doc.html), - orderBy: [MetricDefinitionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [MetricDefinitionsConnection](https://help.tableau.com/current/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/current/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/current/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/current/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/current/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/current/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/current/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/current/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/current/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.") - [Dashboard_A dashboard contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard.doc.html "Dashboard - A dashboard contained in a published workbook.") - [Database_A database containing tables_](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html "Database - A database containing tables") - [DatabasesConnection_Connection Type for Database_](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesconnection.doc.html "DatabasesConnection - Connection Type for Database") - [DatabaseServer_A database server connection_](https://help.tableau.com/current/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/current/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.*") - [Datasource_Root GraphQL type for embedded and published data sources Data sources are a way to represent how Tableau Desktop and Tableau Server model and connect to data. Data sources can be published separately, as a published data source, or may be contained in a workbook as an embedded data source. See https://onlinehelp.tableau.com/current/server/en-us/datasource.htm_](datasource.doc.html "Datasource - Root GraphQL type for embedded and published data sources Data sources are a way to represent how Tableau Desktop and Tableau Server model and connect to data. Data sources can be published separately, as a published data source, or may be contained in a workbook as an embedded data source. See https://onlinehelp.tableau.com/current/server/en-us/datasource.htm") - [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/current/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.") - [EmbeddedDatasource_A data source embedded in a workbook_](https://help.tableau.com/current/api/metadata_api/en-us/reference/embeddeddatasource.doc.html "EmbeddedDatasource - A data source embedded in a workbook") - [Field_Base GraphQL type for a field_](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [FieldReferencingField_Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula._](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield.doc.html "FieldReferencingField - Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula.") - [File_A file connection_](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/flow.doc.html "Flow - Flows are used to prepare data, which can include aggregation, cleaning, preprocessing, etc.") - [FlowColumnInputField_Column input field implementation_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowcolumninputfield.doc.html "FlowColumnInputField - Column input field implementation") - [FlowColumnOutputField_Column output field implementation_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowcolumnoutputfield.doc.html "FlowColumnOutputField - Column output field implementation") - [FlowFieldInputField_Field input field implementation_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfield.doc.html "FlowFieldInputField - Field input field implementation") - [FlowFieldOutputField_Field output field implementation_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfield.doc.html "FlowFieldOutputField - Field output field implementation") - [FlowInputField_A wrapper for an input field contained in a published flow._](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowinputfield.doc.html "FlowInputField - A wrapper for an input field contained in a published flow.") - [FlowOutputField_A wrapper for an output field contained in a published flow._](https://help.tableau.com/current/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/current/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/current/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.*") - [Metric_Metrics are time series data constructed from fields contained in views. \*Retired in Tableau Cloud February 2024 / Server 2024.2.\*_](metric.doc.html "Metric - Metrics are time series data constructed from fields contained in views. *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/current/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/current/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/current/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") - [Sheet_A sheet contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html "Sheet - A sheet contained in a published workbook.") - [Table_A table containing columns_](https://help.tableau.com/current/api/metadata_api/en-us/reference/table.doc.html "Table - A table containing columns") - [TableauUser_User on a site on Tableau server_](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/tag.doc.html "Tag - A tag associated with content items") - [VirtualConnection_A virtual connection. \*Available in Tableau Cloud March 2022 / Server 2022.1 and later.\*_](virtualconnection.doc.html "VirtualConnection - A virtual connection. *Available in Tableau Cloud March 2022 / Server 2022.1 and later.*") - [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/current/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/current/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).") _menu_ Types INPUT\_OBJECT # Database\_Filter Filter by GraphQL field and given value ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input Database_Filter { - # True if the database has an active data quality warning - hasActiveWarning: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) - # True if the database has an active data quality warning - hasActiveWarningWithin: [[Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html)] - # Locally unique identifier used for the REST API on the Tableau Server - luid: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Locally unique identifier used for the REST API on the Tableau Server - luidWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)] - # True if this database contains an active data quality certification - isCertified: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) - # True if this database contains an active data quality certification - isCertifiedWithin: [[Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html)] - # Name shown in server and desktop clients - name: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Name shown in server and desktop clients - nameWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)] - # True if this database is embedded in Tableau content, e.g., a packaged workbook - isEmbedded: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) - # True if this database is embedded in Tableau content, e.g., a packaged workbook - isEmbeddedWithin: [[Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.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/current/api/metadata_api/en-us/reference/id.doc.html) - # Unique identifier used by the Metadata API. Not the same as the numeric ID used - # on server - idWithin: [[ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html)] - # The name of the project in which the database is visible. Will be empty if the - # database is not in a project. - projectName: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # The name of the project in which the database is visible. Will be empty if the - # database is not in a project. - projectNameWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)] - # Connection type shortname - connectionType: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Connection type shortname - connectionTypeWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)] - # Filter the output based on text query. - text: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.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/current/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/current/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/current/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/current/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/current/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/current/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/current/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/current/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.") - [Dashboard_A dashboard contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard.doc.html "Dashboard - A dashboard contained in a published workbook.") - [Database_A database containing tables_](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html "Database - A database containing tables") - [DatabaseServer_A database server connection_](https://help.tableau.com/current/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/current/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.*") - [Datasource_Root GraphQL type for embedded and published data sources Data sources are a way to represent how Tableau Desktop and Tableau Server model and connect to data. Data sources can be published separately, as a published data source, or may be contained in a workbook as an embedded data source. See https://onlinehelp.tableau.com/current/server/en-us/datasource.htm_](datasource.doc.html "Datasource - Root GraphQL type for embedded and published data sources Data sources are a way to represent how Tableau Desktop and Tableau Server model and connect to data. Data sources can be published separately, as a published data source, or may be contained in a workbook as an embedded data source. See https://onlinehelp.tableau.com/current/server/en-us/datasource.htm") - [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/current/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.") - [EmbeddedDatasource_A data source embedded in a workbook_](https://help.tableau.com/current/api/metadata_api/en-us/reference/embeddeddatasource.doc.html "EmbeddedDatasource - A data source embedded in a workbook") - [Field_Base GraphQL type for a field_](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [FieldReferencingField_Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula._](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield.doc.html "FieldReferencingField - Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula.") - [File_A file connection_](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/flow.doc.html "Flow - Flows are used to prepare data, which can include aggregation, cleaning, preprocessing, etc.") - [FlowColumnInputField_Column input field implementation_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowcolumninputfield.doc.html "FlowColumnInputField - Column input field implementation") - [FlowColumnOutputField_Column output field implementation_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowcolumnoutputfield.doc.html "FlowColumnOutputField - Column output field implementation") - [FlowFieldInputField_Field input field implementation_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfield.doc.html "FlowFieldInputField - Field input field implementation") - [FlowFieldOutputField_Field output field implementation_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfield.doc.html "FlowFieldOutputField - Field output field implementation") - [FlowInputField_A wrapper for an input field contained in a published flow._](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowinputfield.doc.html "FlowInputField - A wrapper for an input field contained in a published flow.") - [FlowOutputField_A wrapper for an output field contained in a published flow._](https://help.tableau.com/current/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/current/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/current/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.*") - [Metric_Metrics are time series data constructed from fields contained in views. \*Retired in Tableau Cloud February 2024 / Server 2024.2.\*_](metric.doc.html "Metric - Metrics are time series data constructed from fields contained in views. *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/current/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/current/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/current/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") - [Sheet_A sheet contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html "Sheet - A sheet contained in a published workbook.") - [Table_A table containing columns_](https://help.tableau.com/current/api/metadata_api/en-us/reference/table.doc.html "Table - A table containing columns") - [TableauUser_User on a site on Tableau server_](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/tag.doc.html "Tag - A tag associated with content items") - [VirtualConnection_A virtual connection. \*Available in Tableau Cloud March 2022 / Server 2022.1 and later.\*_](virtualconnection.doc.html "VirtualConnection - A virtual connection. *Available in Tableau Cloud March 2022 / Server 2022.1 and later.*") - [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/current/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/current/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).") _menu_ Types ENUM # DatabaseOrderField Enum for fields that can be used for sorting ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - enum DatabaseOrderField { - # Sort by downstreamDatasources count - DOWNSTREAM_DATASOURCES_COUNT - # Sort by downstreamVirtualConnections count - DOWNSTREAM_VIRTUAL_CONNECTIONS_COUNT - # Sort by downstreamWorkbooks count - DOWNSTREAM_WORKBOOKS_COUNT - # Sort by connectionType - CONNECTION_TYPE - # Sort by hasActiveWarning - HAS_ACTIVE_WARNING - # Sort by id - ID - # Sort by isCertified - IS_CERTIFIED - # Sort by isEmbedded - IS_EMBEDDED - # Sort by luid - LUID - # Sort by name - NAME - # Sort by projectName - PROJECT_NAME - } ` ## [_link_](#require-by) Require by - [DatabaseSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html "DatabaseSortOrder - 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.") _menu_ Types OBJECT # DatabasesConnection Connection Type for Database ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type DatabasesConnection { - # List of nodes - nodes: [[Database](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html)!]! - # Information for pagination - pageInfo: [PageInfo](https://help.tableau.com/current/api/metadata_api/en-us/reference/pageinfo.doc.html)! - # Total number of objects in connection - totalCount: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.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/current/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/current/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/current/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/current/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/current/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/current/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/current/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/current/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.") - [Dashboard_A dashboard contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard.doc.html "Dashboard - A dashboard contained in a published workbook.") - [Database_A database containing tables_](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html "Database - A database containing tables") - [DatabaseServer_A database server connection_](https://help.tableau.com/current/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/current/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.*") - [Datasource_Root GraphQL type for embedded and published data sources Data sources are a way to represent how Tableau Desktop and Tableau Server model and connect to data. Data sources can be published separately, as a published data source, or may be contained in a workbook as an embedded data source. See https://onlinehelp.tableau.com/current/server/en-us/datasource.htm_](datasource.doc.html "Datasource - Root GraphQL type for embedded and published data sources Data sources are a way to represent how Tableau Desktop and Tableau Server model and connect to data. Data sources can be published separately, as a published data source, or may be contained in a workbook as an embedded data source. See https://onlinehelp.tableau.com/current/server/en-us/datasource.htm") - [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/current/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.") - [EmbeddedDatasource_A data source embedded in a workbook_](https://help.tableau.com/current/api/metadata_api/en-us/reference/embeddeddatasource.doc.html "EmbeddedDatasource - A data source embedded in a workbook") - [Field_Base GraphQL type for a field_](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [FieldReferencingField_Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula._](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield.doc.html "FieldReferencingField - Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula.") - [File_A file connection_](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/flow.doc.html "Flow - Flows are used to prepare data, which can include aggregation, cleaning, preprocessing, etc.") - [FlowColumnInputField_Column input field implementation_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowcolumninputfield.doc.html "FlowColumnInputField - Column input field implementation") - [FlowColumnOutputField_Column output field implementation_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowcolumnoutputfield.doc.html "FlowColumnOutputField - Column output field implementation") - [FlowFieldInputField_Field input field implementation_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfield.doc.html "FlowFieldInputField - Field input field implementation") - [FlowFieldOutputField_Field output field implementation_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfield.doc.html "FlowFieldOutputField - Field output field implementation") - [FlowInputField_A wrapper for an input field contained in a published flow._](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowinputfield.doc.html "FlowInputField - A wrapper for an input field contained in a published flow.") - [FlowOutputField_A wrapper for an output field contained in a published flow._](https://help.tableau.com/current/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/current/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/current/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.*") - [Metric_Metrics are time series data constructed from fields contained in views. \*Retired in Tableau Cloud February 2024 / Server 2024.2.\*_](metric.doc.html "Metric - Metrics are time series data constructed from fields contained in views. *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/current/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/current/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/current/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") - [Sheet_A sheet contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html "Sheet - A sheet contained in a published workbook.") - [Table_A table containing columns_](https://help.tableau.com/current/api/metadata_api/en-us/reference/table.doc.html "Table - A table containing columns") - [TableauUser_User on a site on Tableau server_](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/tag.doc.html "Tag - A tag associated with content items") - [VirtualConnection_A virtual connection. \*Available in Tableau Cloud March 2022 / Server 2022.1 and later.\*_](virtualconnection.doc.html "VirtualConnection - A virtual connection. *Available in Tableau Cloud March 2022 / Server 2022.1 and later.*") - [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/current/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/current/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).") _menu_ Types OBJECT # DatabaseServer A database server connection ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type DatabaseServer implements [Database](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html), [Warnable](https://help.tableau.com/current/api/metadata_api/en-us/reference/warnable.doc.html), [Certifiable](https://help.tableau.com/current/api/metadata_api/en-us/reference/certifiable.doc.html), [CanHaveLabels](https://help.tableau.com/current/api/metadata_api/en-us/reference/canhavelabels.doc.html), [Taggable](https://help.tableau.com/current/api/metadata_api/en-us/reference/taggable.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/current/api/metadata_api/en-us/reference/id.doc.html)! - # Vizportal ID of this database, for use in client-to-server communications - vizportalId: [String](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/string.doc.html)! - # Name shown in server and desktop clients - name: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Connection type shortname - connectionType: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # optional Extended Connection info for specific connection types, eg hive for - # Cloudera Hadoop - extendedConnectionType: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # A database server is never embedded in Tableau content - isEmbedded: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) - # Hostname of the database - hostName: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Port number of the database connection - port: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html) - # User modifiable description of this database - description: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # The ID of the project in which the database is visible. Will be empty if the - # database is not in a project. - projectVizportalUrlId: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # The name of the project in which the database is visible. Will be empty if the - # database is not in a project. - projectName: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Contact for this database - contact: [TableauUser](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauuser.doc.html) - # True if this database contains an active data quality certification - isCertified: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html)! - # True if this database has its permission locked - isControlledPermissionsEnabled: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) - # True if this database has been grouped with other databases - isGrouped: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) - # Notes related to this database being marked as certified - certificationNote: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) @deprecated( reason: "No longer supported. Use 'dataQualityCertifications'" ) - # User who marked this database as certified - certifier: [TableauUser](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauuser.doc.html) @deprecated( reason: "No longer supported. Use 'dataQualityCertifications'" ) - # True if the database has an active data quality warning - hasActiveWarning: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html)! - # service string for certain datasources eg Oracle - service: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # The optional data quality warning on a database - dataQualityWarning: [DataQualityWarning](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarning.doc.html) @deprecated( reason: "Use 'dataQualityWarnings'" ) - # The data quality warnings on a 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. - # **permissionMode**: Results filtering mode. - dataQualityWarnings( - filter: [DataQualityWarning_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarning_filter.doc.html), - orderBy: [DataQualityWarningSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarningsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DataQualityWarning](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarning.doc.html)!]! - # The data quality warnings on a 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. - # **permissionMode**: Results filtering mode. - dataQualityWarningsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DataQualityWarning_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarning_filter.doc.html), - orderBy: [DataQualityWarningSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarningsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DataQualityWarningsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarningsconnection.doc.html) - # The data quality certifications on a 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. - # **permissionMode**: Results filtering mode. - dataQualityCertifications( - filter: [DataQualityCertification_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitycertification_filter.doc.html), - orderBy: [DataQualityCertificationSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitycertificationsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DataQualityCertification](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitycertification.doc.html)!]! - # The data quality certifications on a 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. - # **permissionMode**: Results filtering mode. - dataQualityCertificationsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DataQualityCertification_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitycertification_filter.doc.html), - orderBy: [DataQualityCertificationSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitycertificationsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DataQualityCertificationsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitycertificationsconnection.doc.html) - # The labels on a database. 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/current/api/metadata_api/en-us/reference/label_filter.doc.html), - orderBy: [LabelSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/labelsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Label](https://help.tableau.com/current/api/metadata_api/en-us/reference/label.doc.html)!]! - # The labels on a database. 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Label_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/label_filter.doc.html), - orderBy: [LabelSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/labelsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [LabelsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/labelsconnection.doc.html) - # Data quality warnings upstream from this 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. - # **permissionMode**: Results filtering mode. - upstreamDataQualityWarnings( - filter: [DataQualityWarning_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarning_filter.doc.html), - orderBy: [DataQualityWarningSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarningsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DataQualityWarning](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarning.doc.html)!]! - # Data quality warnings upstream from this 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. - # **permissionMode**: Results filtering mode. - upstreamDataQualityWarningsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DataQualityWarning_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarning_filter.doc.html), - orderBy: [DataQualityWarningSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarningsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DataQualityWarningsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarningsconnection.doc.html) - # Labels upstream from this database. 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/current/api/metadata_api/en-us/reference/label_filter.doc.html), - orderBy: [LabelSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/labelsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Label](https://help.tableau.com/current/api/metadata_api/en-us/reference/label.doc.html)!]! - # Labels upstream from this database. 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Label_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/label_filter.doc.html), - orderBy: [LabelSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/labelsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [LabelsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/labelsconnection.doc.html) - # Tags associated with 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. - tags(filter: [Tag_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/tag_filter.doc.html), orderBy: [TagSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tagsortorder.doc.html)): [[Tag](https://help.tableau.com/current/api/metadata_api/en-us/reference/tag.doc.html)!]! - # Tags associated with 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. - tagsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Tag_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/tag_filter.doc.html), - orderBy: [TagSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tagsortorder.doc.html) - ): [TagsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/tagsconnection.doc.html) - # Databases upstream of this 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. - # **permissionMode**: Results filtering mode. - upstreamDatabases( - filter: [Database_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Database](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html)!]! - # Databases upstream of this 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. - # **permissionMode**: Results filtering mode. - upstreamDatabasesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Database_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabasesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesconnection.doc.html) - # Tables upstream of this 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. - # **permissionMode**: Results filtering mode. - upstreamTables( - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DatabaseTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable.doc.html)!]! - # Tables upstream of this 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. - # **permissionMode**: Results filtering mode. - upstreamTablesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabaseTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesconnection.doc.html) - # Virtual connection tables upstream of this 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. - # **permissionMode**: Results filtering mode. - upstreamVirtualConnections( - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection.doc.html)!]! - # Virtual connection tables upstream of this 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. - # **permissionMode**: Results filtering mode. - upstreamVirtualConnectionsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsconnection.doc.html) - # Virtual connection tables upstream of this 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. - # **permissionMode**: Results filtering mode. - upstreamVirtualConnectionTables( - filter: [VirtualConnectionTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnectionTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable.doc.html)!]! - # Virtual connection tables upstream of this 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. - # **permissionMode**: Results filtering mode. - upstreamVirtualConnectionTablesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnectionTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesconnection.doc.html) - # Flows upstream of this 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. - # **permissionMode**: Results filtering mode. - upstreamFlows( - filter: [Flow_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Flow](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow.doc.html)!]! - # Flows upstream of this 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. - # **permissionMode**: Results filtering mode. - upstreamFlowsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Flow_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FlowsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsconnection.doc.html) - # Datasources upstream of this 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. - # **permissionMode**: Results filtering mode. - upstreamDatasources( - filter: [PublishedDatasource_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[PublishedDatasource](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource.doc.html)!]! - # Datasources upstream of this 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. - # **permissionMode**: Results filtering mode. - upstreamDatasourcesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [PublishedDatasource_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [PublishedDatasourcesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesconnection.doc.html) - # Databases downstream of this 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. - # **permissionMode**: Results filtering mode. - downstreamDatabases( - filter: [Database_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Database](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html)!]! - # Databases downstream of this 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. - # **permissionMode**: Results filtering mode. - downstreamDatabasesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Database_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabasesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesconnection.doc.html) - # Tables downstream of this 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. - # **permissionMode**: Results filtering mode. - downstreamTables( - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DatabaseTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable.doc.html)!]! - # Tables downstream of this 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. - # **permissionMode**: Results filtering mode. - downstreamTablesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabaseTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesconnection.doc.html) - # Virtual connection tables downstream of this 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. - # **permissionMode**: Results filtering mode. - downstreamVirtualConnections( - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection.doc.html)!]! - # Virtual connection tables downstream of this 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. - # **permissionMode**: Results filtering mode. - downstreamVirtualConnectionsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsconnection.doc.html) - # Virtual connection tables downstream of this 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. - # **permissionMode**: Results filtering mode. - downstreamVirtualConnectionTables( - filter: [VirtualConnectionTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnectionTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable.doc.html)!]! - # Virtual connection tables downstream of this 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. - # **permissionMode**: Results filtering mode. - downstreamVirtualConnectionTablesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnectionTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesconnection.doc.html) - # Flows downstream of this 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. - # **permissionMode**: Results filtering mode. - downstreamFlows( - filter: [Flow_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Flow](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow.doc.html)!]! - # Flows downstream of this 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. - # **permissionMode**: Results filtering mode. - downstreamFlowsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Flow_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FlowsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsconnection.doc.html) - # Published datasources 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. - # **permissionMode**: Results filtering mode. - downstreamDatasources( - filter: [PublishedDatasource_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[PublishedDatasource](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource.doc.html)!]! - # Published datasources 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. - # **permissionMode**: Results filtering mode. - downstreamDatasourcesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [PublishedDatasource_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [PublishedDatasourcesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesconnection.doc.html) - # Lenses 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. - # **permissionMode**: Results filtering mode. - downstreamLenses( - filter: [Lens_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/lens_filter.doc.html), - orderBy: [LensSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/lenssortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Lens](https://help.tableau.com/current/api/metadata_api/en-us/reference/lens.doc.html)!]! - # Lenses 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. - # **permissionMode**: Results filtering mode. - downstreamLensesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Lens_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/lens_filter.doc.html), - orderBy: [LensSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/lenssortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [LensesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensesconnection.doc.html) - # Workbooks 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. - # **permissionMode**: Results filtering mode. - downstreamWorkbooks( - filter: [Workbook_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbook_filter.doc.html), - orderBy: [WorkbookSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Workbook](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbook.doc.html)!]! - # Workbooks 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. - # **permissionMode**: Results filtering mode. - downstreamWorkbooksConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Workbook_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbook_filter.doc.html), - orderBy: [WorkbookSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [WorkbooksConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksconnection.doc.html) - # Dashboards 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. - # **permissionMode**: Results filtering mode. - downstreamDashboards( - filter: [Dashboard_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard_filter.doc.html), - orderBy: [DashboardSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboardsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Dashboard](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard.doc.html)!]! - # Dashboards 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. - # **permissionMode**: Results filtering mode. - downstreamDashboardsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Dashboard_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard_filter.doc.html), - orderBy: [DashboardSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboardsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DashboardsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboardsconnection.doc.html) - # Sheets 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. - # **permissionMode**: Results filtering mode. - downstreamSheets( - filter: [Sheet_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Sheet](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html)!]! - # Sheets 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. - # **permissionMode**: Results filtering mode. - downstreamSheetsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Sheet_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [SheetsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsconnection.doc.html) - # Metrics 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. - # **permissionMode**: Results filtering mode. - downstreamMetrics( - filter: [Metric_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metric_filter.doc.html), - orderBy: [MetricSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Metric](https://help.tableau.com/current/api/metadata_api/en-us/reference/metric.doc.html)!]! - # Metrics 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. - # **permissionMode**: Results filtering mode. - downstreamMetricsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Metric_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metric_filter.doc.html), - orderBy: [MetricSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [MetricsConnection](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/tableauuser_filter.doc.html), - orderBy: [TableauUserSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauusersortorder.doc.html) - ): [[TableauUser](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [TableauUser_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauuser_filter.doc.html), - orderBy: [TableauUserSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauusersortorder.doc.html) - ): [TableauUsersConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauusersconnection.doc.html) - # The custom SQL queries that reference this 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. - # **permissionMode**: Results filtering mode. - referencedByQueries( - filter: [CustomSQLTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/customsqltable_filter.doc.html), - orderBy: [CustomSQLTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/customsqltablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[CustomSQLTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/customsqltable.doc.html)] - # The custom SQL queries that reference this 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. - # **permissionMode**: Results filtering mode. - referencedByQueriesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [CustomSQLTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/customsqltable_filter.doc.html), - orderBy: [CustomSQLTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/customsqltablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [CustomSQLTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/customsqltablesconnection.doc.html) - # Tables belonging to this 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. - # **permissionMode**: Results filtering mode. - tables( - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DatabaseTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable.doc.html)] - # Tables belonging to this 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. - # **permissionMode**: Results filtering mode. - tablesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabaseTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesconnection.doc.html) - # Metric definitions downstream from this 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. - # **permissionMode**: Results filtering mode. - downstreamMetricDefinitions( - filter: [MetricDefinition_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinition_filter.doc.html), - orderBy: [MetricDefinitionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[MetricDefinition](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinition.doc.html)]! - # Metric definitions downstream from this 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. - # **permissionMode**: Results filtering mode. - downstreamMetricDefinitionsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [MetricDefinition_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinition_filter.doc.html), - orderBy: [MetricDefinitionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [MetricDefinitionsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsconnection.doc.html) - } ` ## [_link_](#require-by) Require by - [DatabaseServersConnection_Connection Type for DatabaseServer_](https://help.tableau.com/current/api/metadata_api/en-us/reference/databaseserversconnection.doc.html "DatabaseServersConnection - Connection Type for DatabaseServer") - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/api/metadata_api/en-us/reference/query.doc.html "Query - Query root for Metadata GraphQL interface") _menu_ Types INPUT\_OBJECT # DatabaseServer\_Filter Filter by GraphQL field and given value ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input DatabaseServer_Filter { - # Hostname of the database - hostName: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Hostname of the database - hostNameWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)] - # True if the database has an active data quality warning - hasActiveWarning: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) - # True if the database has an active data quality warning - hasActiveWarningWithin: [[Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html)] - # Locally unique identifier used for the REST API on the Tableau Server - luid: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Locally unique identifier used for the REST API on the Tableau Server - luidWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)] - # True if this database contains an active data quality certification - isCertified: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) - # True if this database contains an active data quality certification - isCertifiedWithin: [[Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html)] - # Name shown in server and desktop clients - name: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Name shown in server and desktop clients - nameWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)] - # A database server is never embedded in Tableau content - isEmbedded: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) - # A database server is never embedded in Tableau content - isEmbeddedWithin: [[Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.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/current/api/metadata_api/en-us/reference/id.doc.html) - # Unique identifier used by the Metadata API. Not the same as the numeric ID used - # on server - idWithin: [[ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html)] - # The name of the project in which the database is visible. Will be empty if the - # database is not in a project. - projectName: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # The name of the project in which the database is visible. Will be empty if the - # database is not in a project. - projectNameWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)] - # Connection type shortname - connectionType: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Connection type shortname - connectionTypeWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)] - # Filter the output based on text query. - text: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - } ` ## [_link_](#require-by) Require by - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/api/metadata_api/en-us/reference/query.doc.html "Query - Query root for Metadata GraphQL interface") _menu_ Types ENUM # DatabaseServerOrderField Enum for fields that can be used for sorting ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - enum DatabaseServerOrderField { - # Sort by downstreamDatasources count - DOWNSTREAM_DATASOURCES_COUNT - # Sort by downstreamVirtualConnections count - DOWNSTREAM_VIRTUAL_CONNECTIONS_COUNT - # Sort by downstreamWorkbooks count - DOWNSTREAM_WORKBOOKS_COUNT - # Sort by connectionType - CONNECTION_TYPE - # Sort by hasActiveWarning - HAS_ACTIVE_WARNING - # Sort by hostName - HOST_NAME - # Sort by id - ID - # Sort by isCertified - IS_CERTIFIED - # Sort by isEmbedded - IS_EMBEDDED - # Sort by luid - LUID - # Sort by name - NAME - # Sort by projectName - PROJECT_NAME - } ` ## [_link_](#require-by) Require by - [DatabaseServerSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/databaseserversortorder.doc.html "DatabaseServerSortOrder - 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.") _menu_ Types OBJECT # DatabaseServersConnection Connection Type for DatabaseServer ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type DatabaseServersConnection { - # List of nodes - nodes: [[DatabaseServer](https://help.tableau.com/current/api/metadata_api/en-us/reference/databaseserver.doc.html)!]! - # Information for pagination - pageInfo: [PageInfo](https://help.tableau.com/current/api/metadata_api/en-us/reference/pageinfo.doc.html)! - # Total number of objects in connection - totalCount: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html)! - } ` ## [_link_](#require-by) Require by - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/api/metadata_api/en-us/reference/query.doc.html "Query - Query root for Metadata GraphQL interface") _menu_ Types INPUT\_OBJECT # DatabaseServerSortOrder 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. ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input DatabaseServerSortOrder { - # GraphQL field to sort on - field: [DatabaseServerOrderField](https://help.tableau.com/current/api/metadata_api/en-us/reference/databaseserverorderfield.doc.html)! - # Order direction to sort output - direction: [OrderDirection](https://help.tableau.com/current/api/metadata_api/en-us/reference/orderdirection.doc.html)! - } ` ## [_link_](#require-by) Require by - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/api/metadata_api/en-us/reference/query.doc.html "Query - Query root for Metadata GraphQL interface") _menu_ Types INPUT\_OBJECT # DatabaseSortOrder 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. ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input DatabaseSortOrder { - # GraphQL field to sort on - field: [DatabaseOrderField](https://help.tableau.com/current/api/metadata_api/en-us/reference/databaseorderfield.doc.html)! - # Order direction to sort output - direction: [OrderDirection](https://help.tableau.com/current/api/metadata_api/en-us/reference/orderdirection.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/current/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/current/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/current/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/current/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/current/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/current/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/current/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/current/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.") - [Dashboard_A dashboard contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard.doc.html "Dashboard - A dashboard contained in a published workbook.") - [Database_A database containing tables_](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html "Database - A database containing tables") - [DatabaseServer_A database server connection_](https://help.tableau.com/current/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/current/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.*") - [Datasource_Root GraphQL type for embedded and published data sources Data sources are a way to represent how Tableau Desktop and Tableau Server model and connect to data. Data sources can be published separately, as a published data source, or may be contained in a workbook as an embedded data source. See https://onlinehelp.tableau.com/current/server/en-us/datasource.htm_](datasource.doc.html "Datasource - Root GraphQL type for embedded and published data sources Data sources are a way to represent how Tableau Desktop and Tableau Server model and connect to data. Data sources can be published separately, as a published data source, or may be contained in a workbook as an embedded data source. See https://onlinehelp.tableau.com/current/server/en-us/datasource.htm") - [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/current/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.") - [EmbeddedDatasource_A data source embedded in a workbook_](https://help.tableau.com/current/api/metadata_api/en-us/reference/embeddeddatasource.doc.html "EmbeddedDatasource - A data source embedded in a workbook") - [Field_Base GraphQL type for a field_](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [FieldReferencingField_Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula._](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield.doc.html "FieldReferencingField - Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula.") - [File_A file connection_](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/flow.doc.html "Flow - Flows are used to prepare data, which can include aggregation, cleaning, preprocessing, etc.") - [FlowColumnInputField_Column input field implementation_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowcolumninputfield.doc.html "FlowColumnInputField - Column input field implementation") - [FlowColumnOutputField_Column output field implementation_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowcolumnoutputfield.doc.html "FlowColumnOutputField - Column output field implementation") - [FlowFieldInputField_Field input field implementation_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfield.doc.html "FlowFieldInputField - Field input field implementation") - [FlowFieldOutputField_Field output field implementation_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfield.doc.html "FlowFieldOutputField - Field output field implementation") - [FlowInputField_A wrapper for an input field contained in a published flow._](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowinputfield.doc.html "FlowInputField - A wrapper for an input field contained in a published flow.") - [FlowOutputField_A wrapper for an output field contained in a published flow._](https://help.tableau.com/current/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/current/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/current/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.*") - [Metric_Metrics are time series data constructed from fields contained in views. \*Retired in Tableau Cloud February 2024 / Server 2024.2.\*_](metric.doc.html "Metric - Metrics are time series data constructed from fields contained in views. *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/current/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/current/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/current/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") - [Sheet_A sheet contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html "Sheet - A sheet contained in a published workbook.") - [Table_A table containing columns_](https://help.tableau.com/current/api/metadata_api/en-us/reference/table.doc.html "Table - A table containing columns") - [TableauUser_User on a site on Tableau server_](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/tag.doc.html "Tag - A tag associated with content items") - [VirtualConnection_A virtual connection. \*Available in Tableau Cloud March 2022 / Server 2022.1 and later.\*_](virtualconnection.doc.html "VirtualConnection - A virtual connection. *Available in Tableau Cloud March 2022 / Server 2022.1 and later.*") - [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/current/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/current/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).") _menu_ Types OBJECT # DatabaseTable A table that is contained in a database ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type DatabaseTable implements [Table](https://help.tableau.com/current/api/metadata_api/en-us/reference/table.doc.html), [Warnable](https://help.tableau.com/current/api/metadata_api/en-us/reference/warnable.doc.html), [Certifiable](https://help.tableau.com/current/api/metadata_api/en-us/reference/certifiable.doc.html), [CanHaveLabels](https://help.tableau.com/current/api/metadata_api/en-us/reference/canhavelabels.doc.html), [Taggable](https://help.tableau.com/current/api/metadata_api/en-us/reference/taggable.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/current/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/current/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/current/api/metadata_api/en-us/reference/string.doc.html)! - # Name shown in server and desktop clients - name: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # True if this table is embedded in Tableau content - isEmbedded: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) - # Type of the table - tableType: [TableType](https://help.tableau.com/current/api/metadata_api/en-us/reference/tabletype.doc.html)! - # Name of table schema. - # - # Note: For some databases, such as Amazon Athena and Exasol, the schema attribute - # may not return the correct schema name for the table. For more information, see - # https://help.tableau.com/current/api/metadata_api/en-us/docs/meta_api_model.html#schema_attribute. - schema: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Fully qualified table name - fullName: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Connection type of parent database - connectionType: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # The ID of the project in which the table is visible. Will be empty if the table - # is not in a project. - projectVizportalUrlId: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # The name of the project in which the table is visible. Will be empty if the - # table is not in a project. - projectName: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # User modifiable description of this table - description: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Contact for this table - contact: [TableauUser](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauuser.doc.html) - # True if this table contains an active data quality certification - isCertified: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html)! - # Notes related to the database table being marked as certified - certificationNote: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) @deprecated( reason: "No longer supported. Use 'dataQualityCertifications'" ) - # User who marked this table as certified - certifier: [TableauUser](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauuser.doc.html) @deprecated( reason: "No longer supported. Use 'dataQualityCertifications'" ) - # Tags associated with the table - # - # 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/current/api/metadata_api/en-us/reference/tag_filter.doc.html), orderBy: [TagSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tagsortorder.doc.html)): [[Tag](https://help.tableau.com/current/api/metadata_api/en-us/reference/tag.doc.html)!]! - # Tags associated with the table - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Tag_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/tag_filter.doc.html), - orderBy: [TagSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tagsortorder.doc.html) - ): [TagsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/tagsconnection.doc.html) - # The database to which this table belongs - database: [Database](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html) - # Columns contained in this table - # - # 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. - columns( - filter: [Column_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/column_filter.doc.html), - orderBy: [ColumnSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Column](https://help.tableau.com/current/api/metadata_api/en-us/reference/column.doc.html)!]! - # Columns contained in this table - # - # 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. - columnsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Column_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/column_filter.doc.html), - orderBy: [ColumnSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [ColumnsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnsconnection.doc.html) - # Additional details regarding this table - additionalDetails: [TableAdditionalDetails](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableadditionaldetails.doc.html) - # True if the table has an active data quality warning - hasActiveWarning: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html)! - # The optional data quality warning on a table - dataQualityWarning: [DataQualityWarning](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarning.doc.html) @deprecated( reason: "Use 'dataQualityWarnings'" ) - # The data quality warnings on a table - # - # 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/current/api/metadata_api/en-us/reference/dataqualitywarning_filter.doc.html), - orderBy: [DataQualityWarningSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarningsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DataQualityWarning](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarning.doc.html)!]! - # The data quality warnings on a table - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DataQualityWarning_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarning_filter.doc.html), - orderBy: [DataQualityWarningSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarningsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DataQualityWarningsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarningsconnection.doc.html) - # The data quality certifications on a table - # - # 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/current/api/metadata_api/en-us/reference/dataqualitycertification_filter.doc.html), - orderBy: [DataQualityCertificationSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitycertificationsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DataQualityCertification](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitycertification.doc.html)!]! - # The data quality certifications on a table - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DataQualityCertification_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitycertification_filter.doc.html), - orderBy: [DataQualityCertificationSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitycertificationsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DataQualityCertificationsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitycertificationsconnection.doc.html) - # The labels on a table. 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/current/api/metadata_api/en-us/reference/label_filter.doc.html), - orderBy: [LabelSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/labelsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Label](https://help.tableau.com/current/api/metadata_api/en-us/reference/label.doc.html)!]! - # The labels on a table. 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Label_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/label_filter.doc.html), - orderBy: [LabelSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/labelsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [LabelsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/labelsconnection.doc.html) - # Data quality warnings upstream from this table - # - # 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/current/api/metadata_api/en-us/reference/dataqualitywarning_filter.doc.html), - orderBy: [DataQualityWarningSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarningsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DataQualityWarning](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarning.doc.html)!]! - # Data quality warnings upstream from this table - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DataQualityWarning_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarning_filter.doc.html), - orderBy: [DataQualityWarningSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarningsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DataQualityWarningsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarningsconnection.doc.html) - # Labels upstream from this table. 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/current/api/metadata_api/en-us/reference/label_filter.doc.html), - orderBy: [LabelSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/labelsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Label](https://help.tableau.com/current/api/metadata_api/en-us/reference/label.doc.html)!]! - # Labels upstream from this table. 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Label_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/label_filter.doc.html), - orderBy: [LabelSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/labelsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [LabelsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/labelsconnection.doc.html) - # Databases upstream of this table - # - # 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/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Database](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html)!]! - # Databases upstream of this table - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Database_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabasesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesconnection.doc.html) - # Tables upstream of this table - # - # 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/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DatabaseTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable.doc.html)!]! - # Tables upstream of this table - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabaseTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesconnection.doc.html) - # Virtual connections upstream from this table - # - # 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. - upstreamVirtualConnections( - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection.doc.html)!]! - # Virtual connections upstream from this table - # - # 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. - upstreamVirtualConnectionsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsconnection.doc.html) - # Virtual connection tables upstream from this table - # - # 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/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnectionTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable.doc.html)!]! - # Virtual connection tables upstream from this table - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnectionTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesconnection.doc.html) - # Flows upstream of this table - # - # 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/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Flow](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow.doc.html)!]! - # Flows upstream of this table - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Flow_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FlowsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsconnection.doc.html) - # Datasources upstream of this table - # - # 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/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[PublishedDatasource](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource.doc.html)!]! - # Datasources upstream of this table - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [PublishedDatasource_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [PublishedDatasourcesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesconnection.doc.html) - # Databases downstream of this table - # - # 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. - downstreamDatabases( - filter: [Database_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Database](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html)!]! - # Databases downstream of this table - # - # 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. - downstreamDatabasesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Database_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabasesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesconnection.doc.html) - # Tables downstream of this table - # - # 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. - downstreamTables( - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DatabaseTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable.doc.html)!]! - # Tables downstream of this table - # - # 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. - downstreamTablesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabaseTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesconnection.doc.html) - # Virtual connection tables downstream from this table - # - # 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/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnectionTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable.doc.html)!]! - # Virtual connection tables downstream from this table - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnectionTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesconnection.doc.html) - # Virtual connections downstream from this table - # - # 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. - downstreamVirtualConnections( - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection.doc.html)!]! - # Virtual connections downstream from this table - # - # 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. - downstreamVirtualConnectionsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsconnection.doc.html) - # Flows downstream of this table - # - # 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/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Flow](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow.doc.html)!]! - # Flows downstream of this table - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Flow_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FlowsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsconnection.doc.html) - # Published datasources connected to the table - # - # 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/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[PublishedDatasource](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource.doc.html)!]! - # Published datasources connected to the table - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [PublishedDatasource_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [PublishedDatasourcesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesconnection.doc.html) - # Lenses connected downstream from the table - # - # 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/current/api/metadata_api/en-us/reference/lens_filter.doc.html), - orderBy: [LensSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/lenssortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Lens](https://help.tableau.com/current/api/metadata_api/en-us/reference/lens.doc.html)!]! - # Lenses connected downstream from the table - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Lens_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/lens_filter.doc.html), - orderBy: [LensSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/lenssortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [LensesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensesconnection.doc.html) - # Sheets connected to the table - # - # 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/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Sheet](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html)!]! - # Sheets connected to the table - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Sheet_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [SheetsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsconnection.doc.html) - # Dashboards connected downstream from the table - # - # 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/current/api/metadata_api/en-us/reference/dashboard_filter.doc.html), - orderBy: [DashboardSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboardsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Dashboard](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard.doc.html)!]! - # Dashboards connected downstream from the table - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Dashboard_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard_filter.doc.html), - orderBy: [DashboardSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboardsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DashboardsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboardsconnection.doc.html) - # Metrics connected downstream from the table - # - # 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/current/api/metadata_api/en-us/reference/metric_filter.doc.html), - orderBy: [MetricSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Metric](https://help.tableau.com/current/api/metadata_api/en-us/reference/metric.doc.html)!]! - # Metrics connected downstream from the table - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Metric_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metric_filter.doc.html), - orderBy: [MetricSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [MetricsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricsconnection.doc.html) - # Workbooks connected to the table - # - # 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/current/api/metadata_api/en-us/reference/workbook_filter.doc.html), - orderBy: [WorkbookSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Workbook](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbook.doc.html)!]! - # Workbooks connected to the table - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Workbook_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbook_filter.doc.html), - orderBy: [WorkbookSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [WorkbooksConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksconnection.doc.html) - # Owners of workbooks and published datasources connected to the table - # - # 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/current/api/metadata_api/en-us/reference/tableauuser_filter.doc.html), - orderBy: [TableauUserSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauusersortorder.doc.html) - ): [[TableauUser](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauuser.doc.html)!]! - # Owners of workbooks and published datasources connected to the table - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [TableauUser_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauuser_filter.doc.html), - orderBy: [TableauUserSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauusersortorder.doc.html) - ): [TableauUsersConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauusersconnection.doc.html) - # The custom SQL queries that reference this table - # - # 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. - referencedByQueries( - filter: [CustomSQLTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/customsqltable_filter.doc.html), - orderBy: [CustomSQLTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/customsqltablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[CustomSQLTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/customsqltable.doc.html)] - # The custom SQL queries that reference this table - # - # 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. - referencedByQueriesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [CustomSQLTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/customsqltable_filter.doc.html), - orderBy: [CustomSQLTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/customsqltablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [CustomSQLTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/customsqltablesconnection.doc.html) - # Metric definitions downstream from this databaseTable. - # - # 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/current/api/metadata_api/en-us/reference/metricdefinition_filter.doc.html), - orderBy: [MetricDefinitionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[MetricDefinition](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinition.doc.html)]! - # Metric definitions downstream from this databaseTable. - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [MetricDefinition_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinition_filter.doc.html), - orderBy: [MetricDefinitionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [MetricDefinitionsConnection](https://help.tableau.com/current/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/current/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/current/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/current/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/current/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/current/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/current/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/current/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/current/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/current/api/metadata_api/en-us/reference/database.doc.html "Database - A database containing tables") - [DatabaseServer_A database server connection_](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/databasetable.doc.html "DatabaseTable - A table that is contained in a database") - [DatabaseTablesConnection_Connection Type for DatabaseTable_](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesconnection.doc.html "DatabaseTablesConnection - Connection Type for DatabaseTable") - [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.*") - [Datasource_Root GraphQL type for embedded and published data sources Data sources are a way to represent how Tableau Desktop and Tableau Server model and connect to data. Data sources can be published separately, as a published data source, or may be contained in a workbook as an embedded data source. See https://onlinehelp.tableau.com/current/server/en-us/datasource.htm_](datasource.doc.html "Datasource - Root GraphQL type for embedded and published data sources Data sources are a way to represent how Tableau Desktop and Tableau Server model and connect to data. Data sources can be published separately, as a published data source, or may be contained in a workbook as an embedded data source. See https://onlinehelp.tableau.com/current/server/en-us/datasource.htm") - [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/current/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.") - [EmbeddedDatasource_A data source embedded in a workbook_](https://help.tableau.com/current/api/metadata_api/en-us/reference/embeddeddatasource.doc.html "EmbeddedDatasource - A data source embedded in a workbook") - [Field_Base GraphQL type for a field_](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [FieldReferencingField_Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula._](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield.doc.html "FieldReferencingField - Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula.") - [File_A file connection_](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/flow.doc.html "Flow - Flows are used to prepare data, which can include aggregation, cleaning, preprocessing, etc.") - [FlowColumnInputField_Column input field implementation_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowcolumninputfield.doc.html "FlowColumnInputField - Column input field implementation") - [FlowColumnOutputField_Column output field implementation_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowcolumnoutputfield.doc.html "FlowColumnOutputField - Column output field implementation") - [FlowFieldInputField_Field input field implementation_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfield.doc.html "FlowFieldInputField - Field input field implementation") - [FlowFieldOutputField_Field output field implementation_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfield.doc.html "FlowFieldOutputField - Field output field implementation") - [FlowInputField_A wrapper for an input field contained in a published flow._](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowinputfield.doc.html "FlowInputField - A wrapper for an input field contained in a published flow.") - [FlowOutputField_A wrapper for an output field contained in a published flow._](https://help.tableau.com/current/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/current/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/current/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") - [Metric_Metrics are time series data constructed from fields contained in views. \*Retired in Tableau Cloud February 2024 / Server 2024.2.\*_](metric.doc.html "Metric - Metrics are time series data constructed from fields contained in views. *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/current/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/current/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/current/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/current/api/metadata_api/en-us/reference/table.doc.html "Table - A table containing columns") - [TableAdditionalDetails_Additional details for the DatabaseTable type \*Available in Tableau Cloud February 2024 / Server 2024.2 and later.\*_](tableadditionaldetails.doc.html "TableAdditionalDetails - Additional details for the DatabaseTable type *Available in Tableau Cloud February 2024 / Server 2024.2 and later.*") - [TableauUser_User on a site on Tableau server_](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/tag.doc.html "Tag - A tag associated with content items") - [VirtualConnection_A virtual connection. \*Available in Tableau Cloud March 2022 / Server 2022.1 and later.\*_](virtualconnection.doc.html "VirtualConnection - A virtual connection. *Available in Tableau Cloud March 2022 / Server 2022.1 and later.*") - [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/current/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/current/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).") _menu_ Types INPUT\_OBJECT # DatabaseTable\_Filter Filter by GraphQL field and given value ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input DatabaseTable_Filter { - # Name of table schema. - # - # Note: For some databases, such as Amazon Athena and Exasol, the schema attribute - # may not return the correct schema name for the table. For more information, see - # https://help.tableau.com/current/api/metadata_api/en-us/docs/meta_api_model.html#schema_attribute. - schema: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Name of table schema. - # - # Note: For some databases, such as Amazon Athena and Exasol, the schema attribute - # may not return the correct schema name for the table. For more information, see - # https://help.tableau.com/current/api/metadata_api/en-us/docs/meta_api_model.html#schema_attribute. - schemaWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)] - # True if the table has an active data quality warning - hasActiveWarning: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) - # True if the table has an active data quality warning - hasActiveWarningWithin: [[Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html)] - # Locally unique identifier used for the REST API on the Tableau Server - luid: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Locally unique identifier used for the REST API on the Tableau Server - luidWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)] - # True if this table contains an active data quality certification - isCertified: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) - # True if this table contains an active data quality certification - isCertifiedWithin: [[Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html)] - # Name shown in server and desktop clients - name: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Name shown in server and desktop clients - nameWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)] - # Fully qualified table name - fullName: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Fully qualified table name - fullNameWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)] - # True if this table is embedded in Tableau content - isEmbedded: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) - # True if this table is embedded in Tableau content - isEmbeddedWithin: [[Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.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/current/api/metadata_api/en-us/reference/id.doc.html) - # Unique identifier used by the metadata API. Not the same as the numeric ID used - # on server - idWithin: [[ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html)] - # The name of the project in which the table is visible. Will be empty if the - # table is not in a project. - projectName: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # The name of the project in which the table is visible. Will be empty if the - # table is not in a project. - projectNameWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)] - # Connection type of parent database - connectionType: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Connection type of parent database - connectionTypeWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)] - # Filter the output based on text query. - text: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.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/current/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/current/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/current/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/current/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/current/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/current/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/current/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/current/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/current/api/metadata_api/en-us/reference/database.doc.html "Database - A database containing tables") - [DatabaseServer_A database server connection_](https://help.tableau.com/current/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/current/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.*") - [Datasource_Root GraphQL type for embedded and published data sources Data sources are a way to represent how Tableau Desktop and Tableau Server model and connect to data. Data sources can be published separately, as a published data source, or may be contained in a workbook as an embedded data source. See https://onlinehelp.tableau.com/current/server/en-us/datasource.htm_](datasource.doc.html "Datasource - Root GraphQL type for embedded and published data sources Data sources are a way to represent how Tableau Desktop and Tableau Server model and connect to data. Data sources can be published separately, as a published data source, or may be contained in a workbook as an embedded data source. See https://onlinehelp.tableau.com/current/server/en-us/datasource.htm") - [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/current/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.") - [EmbeddedDatasource_A data source embedded in a workbook_](https://help.tableau.com/current/api/metadata_api/en-us/reference/embeddeddatasource.doc.html "EmbeddedDatasource - A data source embedded in a workbook") - [Field_Base GraphQL type for a field_](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [FieldReferencingField_Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula._](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield.doc.html "FieldReferencingField - Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula.") - [File_A file connection_](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/flow.doc.html "Flow - Flows are used to prepare data, which can include aggregation, cleaning, preprocessing, etc.") - [FlowColumnInputField_Column input field implementation_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowcolumninputfield.doc.html "FlowColumnInputField - Column input field implementation") - [FlowColumnOutputField_Column output field implementation_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowcolumnoutputfield.doc.html "FlowColumnOutputField - Column output field implementation") - [FlowFieldInputField_Field input field implementation_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfield.doc.html "FlowFieldInputField - Field input field implementation") - [FlowFieldOutputField_Field output field implementation_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfield.doc.html "FlowFieldOutputField - Field output field implementation") - [FlowInputField_A wrapper for an input field contained in a published flow._](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowinputfield.doc.html "FlowInputField - A wrapper for an input field contained in a published flow.") - [FlowOutputField_A wrapper for an output field contained in a published flow._](https://help.tableau.com/current/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/current/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/current/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") - [Metric_Metrics are time series data constructed from fields contained in views. \*Retired in Tableau Cloud February 2024 / Server 2024.2.\*_](metric.doc.html "Metric - Metrics are time series data constructed from fields contained in views. *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/current/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/current/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/current/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/current/api/metadata_api/en-us/reference/table.doc.html "Table - A table containing columns") - [TableAdditionalDetails_Additional details for the DatabaseTable type \*Available in Tableau Cloud February 2024 / Server 2024.2 and later.\*_](tableadditionaldetails.doc.html "TableAdditionalDetails - Additional details for the DatabaseTable type *Available in Tableau Cloud February 2024 / Server 2024.2 and later.*") - [TableauUser_User on a site on Tableau server_](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/tag.doc.html "Tag - A tag associated with content items") - [VirtualConnection_A virtual connection. \*Available in Tableau Cloud March 2022 / Server 2022.1 and later.\*_](virtualconnection.doc.html "VirtualConnection - A virtual connection. *Available in Tableau Cloud March 2022 / Server 2022.1 and later.*") - [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/current/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/current/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).") _menu_ Types ENUM # DatabaseTableOrderField Enum for fields that can be used for sorting ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - enum DatabaseTableOrderField { - # Sort by columns count - COLUMNS_COUNT - # Sort by downstreamDashboards count - DOWNSTREAM_DASHBOARDS_COUNT - # Sort by downstreamDatasources count - DOWNSTREAM_DATASOURCES_COUNT - # Sort by downstreamVirtualConnections count - DOWNSTREAM_VIRTUAL_CONNECTIONS_COUNT - # Sort by downstreamWorkbooks count - DOWNSTREAM_WORKBOOKS_COUNT - # Sort by connectionType - CONNECTION_TYPE - # Sort by fullName - FULL_NAME - # Sort by hasActiveWarning - HAS_ACTIVE_WARNING - # Sort by id - ID - # Sort by isCertified - IS_CERTIFIED - # Sort by isEmbedded - IS_EMBEDDED - # Sort by luid - LUID - # Sort by name - NAME - # Sort by projectName - PROJECT_NAME - # Sort by schema - SCHEMA - } ` ## [_link_](#require-by) Require by - [DatabaseTableSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html "DatabaseTableSortOrder - 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.") _menu_ Types OBJECT # DatabaseTablesConnection Connection Type for DatabaseTable ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type DatabaseTablesConnection { - # List of nodes - nodes: [[DatabaseTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable.doc.html)!]! - # Information for pagination - pageInfo: [PageInfo](https://help.tableau.com/current/api/metadata_api/en-us/reference/pageinfo.doc.html)! - # Total number of objects in connection - totalCount: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.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/current/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/current/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/current/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/current/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/current/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/current/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/current/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/current/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/current/api/metadata_api/en-us/reference/database.doc.html "Database - A database containing tables") - [DatabaseServer_A database server connection_](https://help.tableau.com/current/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/current/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.*") - [Datasource_Root GraphQL type for embedded and published data sources Data sources are a way to represent how Tableau Desktop and Tableau Server model and connect to data. Data sources can be published separately, as a published data source, or may be contained in a workbook as an embedded data source. See https://onlinehelp.tableau.com/current/server/en-us/datasource.htm_](datasource.doc.html "Datasource - Root GraphQL type for embedded and published data sources Data sources are a way to represent how Tableau Desktop and Tableau Server model and connect to data. Data sources can be published separately, as a published data source, or may be contained in a workbook as an embedded data source. See https://onlinehelp.tableau.com/current/server/en-us/datasource.htm") - [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/current/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.") - [EmbeddedDatasource_A data source embedded in a workbook_](https://help.tableau.com/current/api/metadata_api/en-us/reference/embeddeddatasource.doc.html "EmbeddedDatasource - A data source embedded in a workbook") - [Field_Base GraphQL type for a field_](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [FieldReferencingField_Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula._](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield.doc.html "FieldReferencingField - Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula.") - [File_A file connection_](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/flow.doc.html "Flow - Flows are used to prepare data, which can include aggregation, cleaning, preprocessing, etc.") - [FlowColumnInputField_Column input field implementation_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowcolumninputfield.doc.html "FlowColumnInputField - Column input field implementation") - [FlowColumnOutputField_Column output field implementation_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowcolumnoutputfield.doc.html "FlowColumnOutputField - Column output field implementation") - [FlowFieldInputField_Field input field implementation_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfield.doc.html "FlowFieldInputField - Field input field implementation") - [FlowFieldOutputField_Field output field implementation_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfield.doc.html "FlowFieldOutputField - Field output field implementation") - [FlowInputField_A wrapper for an input field contained in a published flow._](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowinputfield.doc.html "FlowInputField - A wrapper for an input field contained in a published flow.") - [FlowOutputField_A wrapper for an output field contained in a published flow._](https://help.tableau.com/current/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/current/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/current/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") - [Metric_Metrics are time series data constructed from fields contained in views. \*Retired in Tableau Cloud February 2024 / Server 2024.2.\*_](metric.doc.html "Metric - Metrics are time series data constructed from fields contained in views. *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/current/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/current/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/current/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/current/api/metadata_api/en-us/reference/table.doc.html "Table - A table containing columns") - [TableAdditionalDetails_Additional details for the DatabaseTable type \*Available in Tableau Cloud February 2024 / Server 2024.2 and later.\*_](tableadditionaldetails.doc.html "TableAdditionalDetails - Additional details for the DatabaseTable type *Available in Tableau Cloud February 2024 / Server 2024.2 and later.*") - [TableauUser_User on a site on Tableau server_](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/tag.doc.html "Tag - A tag associated with content items") - [VirtualConnection_A virtual connection. \*Available in Tableau Cloud March 2022 / Server 2022.1 and later.\*_](virtualconnection.doc.html "VirtualConnection - A virtual connection. *Available in Tableau Cloud March 2022 / Server 2022.1 and later.*") - [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/current/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/current/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).") _menu_ Types INPUT\_OBJECT # DatabaseTableSortOrder 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. ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input DatabaseTableSortOrder { - # GraphQL field to sort on - field: [DatabaseTableOrderField](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetableorderfield.doc.html)! - # Order direction to sort output - direction: [OrderDirection](https://help.tableau.com/current/api/metadata_api/en-us/reference/orderdirection.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/current/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/current/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/current/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/current/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/current/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/current/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/current/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/current/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/current/api/metadata_api/en-us/reference/database.doc.html "Database - A database containing tables") - [DatabaseServer_A database server connection_](https://help.tableau.com/current/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/current/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.*") - [Datasource_Root GraphQL type for embedded and published data sources Data sources are a way to represent how Tableau Desktop and Tableau Server model and connect to data. Data sources can be published separately, as a published data source, or may be contained in a workbook as an embedded data source. See https://onlinehelp.tableau.com/current/server/en-us/datasource.htm_](datasource.doc.html "Datasource - Root GraphQL type for embedded and published data sources Data sources are a way to represent how Tableau Desktop and Tableau Server model and connect to data. Data sources can be published separately, as a published data source, or may be contained in a workbook as an embedded data source. See https://onlinehelp.tableau.com/current/server/en-us/datasource.htm") - [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/current/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.") - [EmbeddedDatasource_A data source embedded in a workbook_](https://help.tableau.com/current/api/metadata_api/en-us/reference/embeddeddatasource.doc.html "EmbeddedDatasource - A data source embedded in a workbook") - [Field_Base GraphQL type for a field_](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [FieldReferencingField_Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula._](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield.doc.html "FieldReferencingField - Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula.") - [File_A file connection_](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/flow.doc.html "Flow - Flows are used to prepare data, which can include aggregation, cleaning, preprocessing, etc.") - [FlowColumnInputField_Column input field implementation_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowcolumninputfield.doc.html "FlowColumnInputField - Column input field implementation") - [FlowColumnOutputField_Column output field implementation_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowcolumnoutputfield.doc.html "FlowColumnOutputField - Column output field implementation") - [FlowFieldInputField_Field input field implementation_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfield.doc.html "FlowFieldInputField - Field input field implementation") - [FlowFieldOutputField_Field output field implementation_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfield.doc.html "FlowFieldOutputField - Field output field implementation") - [FlowInputField_A wrapper for an input field contained in a published flow._](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowinputfield.doc.html "FlowInputField - A wrapper for an input field contained in a published flow.") - [FlowOutputField_A wrapper for an output field contained in a published flow._](https://help.tableau.com/current/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/current/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/current/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") - [Metric_Metrics are time series data constructed from fields contained in views. \*Retired in Tableau Cloud February 2024 / Server 2024.2.\*_](metric.doc.html "Metric - Metrics are time series data constructed from fields contained in views. *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/current/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/current/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/current/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/current/api/metadata_api/en-us/reference/table.doc.html "Table - A table containing columns") - [TableAdditionalDetails_Additional details for the DatabaseTable type \*Available in Tableau Cloud February 2024 / Server 2024.2 and later.\*_](tableadditionaldetails.doc.html "TableAdditionalDetails - Additional details for the DatabaseTable type *Available in Tableau Cloud February 2024 / Server 2024.2 and later.*") - [TableauUser_User on a site on Tableau server_](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/tag.doc.html "Tag - A tag associated with content items") - [VirtualConnection_A virtual connection. \*Available in Tableau Cloud March 2022 / Server 2022.1 and later.\*_](virtualconnection.doc.html "VirtualConnection - A virtual connection. *Available in Tableau Cloud March 2022 / Server 2022.1 and later.*") - [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/current/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/current/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).") _menu_ Types OBJECT # DataCloud A Data Cloud connection _Available in Tableau Cloud February 2024 / Server 2024.2 and later._ ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type DataCloud implements [Database](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html), [Warnable](https://help.tableau.com/current/api/metadata_api/en-us/reference/warnable.doc.html), [Certifiable](https://help.tableau.com/current/api/metadata_api/en-us/reference/certifiable.doc.html), [CanHaveLabels](https://help.tableau.com/current/api/metadata_api/en-us/reference/canhavelabels.doc.html), [Taggable](https://help.tableau.com/current/api/metadata_api/en-us/reference/taggable.doc.html) { - # Unique identifier used with the Metadata API. Not the same as the locally - # unique identifier used with the REST API. - id: [ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html)! - # Vizportal ID of this database, for use in client-to-server communications - vizportalId: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)! - # Locally unique identifier used with the REST API. - luid: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)! - # Name shown in server and desktop clients - name: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Connection type shortname - connectionType: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # True if this database is embedded in Tableau content, e.g., a packaged workbook - isEmbedded: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) - # User modifiable description of this database - description: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # The ID of the project in which the database is visible. Will be empty if the - # database is not in a project. - projectVizportalUrlId: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # The name of the project in which the database is visible. Will be empty if the - # database is not in a project. - projectName: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Contact for this database - contact: [TableauUser](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauuser.doc.html) - # True if this database contains an active data quality certification - isCertified: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html)! - # True if this database has its permission locked - isControlledPermissionsEnabled: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) - # True if this database has been grouped with other databases - isGrouped: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) - # Notes related to this database being marked as certified - certificationNote: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) @deprecated( reason: "No longer supported. Use 'dataQualityCertifications'" ) - # User who marked this database as certified - certifier: [TableauUser](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauuser.doc.html) @deprecated( reason: "No longer supported. Use 'dataQualityCertifications'" ) - # True if the database has an active data quality warning - hasActiveWarning: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html)! - # The optional data quality warning on a database - dataQualityWarning: [DataQualityWarning](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarning.doc.html) @deprecated( reason: "Use 'dataQualityWarnings'" ) - # The data quality warnings on a 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. - # **permissionMode**: Results filtering mode. - dataQualityWarnings( - filter: [DataQualityWarning_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarning_filter.doc.html), - orderBy: [DataQualityWarningSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarningsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DataQualityWarning](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarning.doc.html)!]! - # The data quality warnings on a 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. - # **permissionMode**: Results filtering mode. - dataQualityWarningsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DataQualityWarning_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarning_filter.doc.html), - orderBy: [DataQualityWarningSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarningsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DataQualityWarningsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarningsconnection.doc.html) - # The data quality certifications on a 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. - # **permissionMode**: Results filtering mode. - dataQualityCertifications( - filter: [DataQualityCertification_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitycertification_filter.doc.html), - orderBy: [DataQualityCertificationSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitycertificationsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DataQualityCertification](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitycertification.doc.html)!]! - # The data quality certifications on a 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. - # **permissionMode**: Results filtering mode. - dataQualityCertificationsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DataQualityCertification_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitycertification_filter.doc.html), - orderBy: [DataQualityCertificationSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitycertificationsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DataQualityCertificationsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitycertificationsconnection.doc.html) - # The labels on a database. 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/current/api/metadata_api/en-us/reference/label_filter.doc.html), - orderBy: [LabelSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/labelsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Label](https://help.tableau.com/current/api/metadata_api/en-us/reference/label.doc.html)!]! - # The labels on a database. 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Label_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/label_filter.doc.html), - orderBy: [LabelSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/labelsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [LabelsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/labelsconnection.doc.html) - # Data quality warnings upstream from this 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. - # **permissionMode**: Results filtering mode. - upstreamDataQualityWarnings( - filter: [DataQualityWarning_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarning_filter.doc.html), - orderBy: [DataQualityWarningSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarningsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DataQualityWarning](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarning.doc.html)!]! - # Data quality warnings upstream from this 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. - # **permissionMode**: Results filtering mode. - upstreamDataQualityWarningsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DataQualityWarning_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarning_filter.doc.html), - orderBy: [DataQualityWarningSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarningsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DataQualityWarningsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarningsconnection.doc.html) - # Labels upstream from this database. 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/current/api/metadata_api/en-us/reference/label_filter.doc.html), - orderBy: [LabelSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/labelsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Label](https://help.tableau.com/current/api/metadata_api/en-us/reference/label.doc.html)!]! - # Labels upstream from this database. 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Label_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/label_filter.doc.html), - orderBy: [LabelSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/labelsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [LabelsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/labelsconnection.doc.html) - # Tags associated with 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. - tags(filter: [Tag_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/tag_filter.doc.html), orderBy: [TagSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tagsortorder.doc.html)): [[Tag](https://help.tableau.com/current/api/metadata_api/en-us/reference/tag.doc.html)!]! - # Tags associated with 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. - tagsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Tag_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/tag_filter.doc.html), - orderBy: [TagSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tagsortorder.doc.html) - ): [TagsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/tagsconnection.doc.html) - # Databases upstream of this 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. - # **permissionMode**: Results filtering mode. - upstreamDatabases( - filter: [Database_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Database](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html)!]! - # Databases upstream of this 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. - # **permissionMode**: Results filtering mode. - upstreamDatabasesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Database_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabasesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesconnection.doc.html) - # Tables upstream of this 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. - # **permissionMode**: Results filtering mode. - upstreamTables( - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DatabaseTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable.doc.html)!]! - # Tables upstream of this 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. - # **permissionMode**: Results filtering mode. - upstreamTablesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabaseTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesconnection.doc.html) - # Virtual connection tables upstream of this 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. - # **permissionMode**: Results filtering mode. - upstreamVirtualConnections( - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection.doc.html)!]! - # Virtual connection tables upstream of this 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. - # **permissionMode**: Results filtering mode. - upstreamVirtualConnectionsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsconnection.doc.html) - # Virtual connection tables upstream of this 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. - # **permissionMode**: Results filtering mode. - upstreamVirtualConnectionTables( - filter: [VirtualConnectionTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnectionTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable.doc.html)!]! - # Virtual connection tables upstream of this 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. - # **permissionMode**: Results filtering mode. - upstreamVirtualConnectionTablesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnectionTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesconnection.doc.html) - # Flows upstream of this 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. - # **permissionMode**: Results filtering mode. - upstreamFlows( - filter: [Flow_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Flow](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow.doc.html)!]! - # Flows upstream of this 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. - # **permissionMode**: Results filtering mode. - upstreamFlowsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Flow_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FlowsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsconnection.doc.html) - # Datasources upstream of this 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. - # **permissionMode**: Results filtering mode. - upstreamDatasources( - filter: [PublishedDatasource_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[PublishedDatasource](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource.doc.html)!]! - # Datasources upstream of this 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. - # **permissionMode**: Results filtering mode. - upstreamDatasourcesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [PublishedDatasource_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [PublishedDatasourcesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesconnection.doc.html) - # Databases downstream of this 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. - # **permissionMode**: Results filtering mode. - downstreamDatabases( - filter: [Database_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Database](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html)!]! - # Databases downstream of this 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. - # **permissionMode**: Results filtering mode. - downstreamDatabasesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Database_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabasesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesconnection.doc.html) - # Tables downstream of this 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. - # **permissionMode**: Results filtering mode. - downstreamTables( - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DatabaseTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable.doc.html)!]! - # Tables downstream of this 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. - # **permissionMode**: Results filtering mode. - downstreamTablesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabaseTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesconnection.doc.html) - # Virtual connection tables downstream of this 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. - # **permissionMode**: Results filtering mode. - downstreamVirtualConnections( - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection.doc.html)!]! - # Virtual connection tables downstream of this 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. - # **permissionMode**: Results filtering mode. - downstreamVirtualConnectionsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsconnection.doc.html) - # Virtual connection tables downstream of this 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. - # **permissionMode**: Results filtering mode. - downstreamVirtualConnectionTables( - filter: [VirtualConnectionTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnectionTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable.doc.html)!]! - # Virtual connection tables downstream of this 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. - # **permissionMode**: Results filtering mode. - downstreamVirtualConnectionTablesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnectionTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesconnection.doc.html) - # Flows downstream of this 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. - # **permissionMode**: Results filtering mode. - downstreamFlows( - filter: [Flow_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Flow](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow.doc.html)!]! - # Flows downstream of this 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. - # **permissionMode**: Results filtering mode. - downstreamFlowsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Flow_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FlowsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsconnection.doc.html) - # Published datasources 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. - # **permissionMode**: Results filtering mode. - downstreamDatasources( - filter: [PublishedDatasource_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[PublishedDatasource](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource.doc.html)!]! - # Published datasources 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. - # **permissionMode**: Results filtering mode. - downstreamDatasourcesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [PublishedDatasource_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [PublishedDatasourcesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesconnection.doc.html) - # Lenses 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. - # **permissionMode**: Results filtering mode. - downstreamLenses( - filter: [Lens_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/lens_filter.doc.html), - orderBy: [LensSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/lenssortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Lens](https://help.tableau.com/current/api/metadata_api/en-us/reference/lens.doc.html)!]! - # Lenses 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. - # **permissionMode**: Results filtering mode. - downstreamLensesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Lens_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/lens_filter.doc.html), - orderBy: [LensSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/lenssortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [LensesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensesconnection.doc.html) - # Workbooks 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. - # **permissionMode**: Results filtering mode. - downstreamWorkbooks( - filter: [Workbook_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbook_filter.doc.html), - orderBy: [WorkbookSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Workbook](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbook.doc.html)!]! - # Workbooks 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. - # **permissionMode**: Results filtering mode. - downstreamWorkbooksConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Workbook_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbook_filter.doc.html), - orderBy: [WorkbookSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [WorkbooksConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksconnection.doc.html) - # Dashboards 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. - # **permissionMode**: Results filtering mode. - downstreamDashboards( - filter: [Dashboard_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard_filter.doc.html), - orderBy: [DashboardSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboardsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Dashboard](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard.doc.html)!]! - # Dashboards 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. - # **permissionMode**: Results filtering mode. - downstreamDashboardsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Dashboard_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard_filter.doc.html), - orderBy: [DashboardSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboardsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DashboardsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboardsconnection.doc.html) - # Sheets 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. - # **permissionMode**: Results filtering mode. - downstreamSheets( - filter: [Sheet_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Sheet](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html)!]! - # Sheets 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. - # **permissionMode**: Results filtering mode. - downstreamSheetsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Sheet_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [SheetsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsconnection.doc.html) - # Metrics 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. - # **permissionMode**: Results filtering mode. - downstreamMetrics( - filter: [Metric_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metric_filter.doc.html), - orderBy: [MetricSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Metric](https://help.tableau.com/current/api/metadata_api/en-us/reference/metric.doc.html)!]! - # Metrics 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. - # **permissionMode**: Results filtering mode. - downstreamMetricsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Metric_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metric_filter.doc.html), - orderBy: [MetricSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [MetricsConnection](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/tableauuser_filter.doc.html), - orderBy: [TableauUserSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauusersortorder.doc.html) - ): [[TableauUser](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [TableauUser_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauuser_filter.doc.html), - orderBy: [TableauUserSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauusersortorder.doc.html) - ): [TableauUsersConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauusersconnection.doc.html) - # The custom SQL queries that reference this 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. - # **permissionMode**: Results filtering mode. - referencedByQueries( - filter: [CustomSQLTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/customsqltable_filter.doc.html), - orderBy: [CustomSQLTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/customsqltablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[CustomSQLTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/customsqltable.doc.html)] - # The custom SQL queries that reference this 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. - # **permissionMode**: Results filtering mode. - referencedByQueriesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [CustomSQLTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/customsqltable_filter.doc.html), - orderBy: [CustomSQLTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/customsqltablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [CustomSQLTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/customsqltablesconnection.doc.html) - # Tables belonging to this 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. - # **permissionMode**: Results filtering mode. - tables( - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DatabaseTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable.doc.html)] - # Tables belonging to this 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. - # **permissionMode**: Results filtering mode. - tablesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabaseTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesconnection.doc.html) - # Metric definitions downstream from this 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. - # **permissionMode**: Results filtering mode. - downstreamMetricDefinitions( - filter: [MetricDefinition_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinition_filter.doc.html), - orderBy: [MetricDefinitionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[MetricDefinition](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinition.doc.html)]! - # Metric definitions downstream from this 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. - # **permissionMode**: Results filtering mode. - downstreamMetricDefinitionsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [MetricDefinition_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinition_filter.doc.html), - orderBy: [MetricDefinitionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [MetricDefinitionsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsconnection.doc.html) - } ` ## [_link_](#require-by) Require by - [DataCloudsConnection_Connection Type for DataCloud_](https://help.tableau.com/current/api/metadata_api/en-us/reference/datacloudsconnection.doc.html "DataCloudsConnection - Connection Type for DataCloud") - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/api/metadata_api/en-us/reference/query.doc.html "Query - Query root for Metadata GraphQL interface") _menu_ Types INPUT\_OBJECT # DataCloud\_Filter Filter by GraphQL field and given value ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input DataCloud_Filter { - # True if the database has an active data quality warning - hasActiveWarning: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) - # True if the database has an active data quality warning - hasActiveWarningWithin: [[Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html)] - # Locally unique identifier used with the REST API. - luid: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Locally unique identifier used with the REST API. - luidWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)] - # True if this database contains an active data quality certification - isCertified: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) - # True if this database contains an active data quality certification - isCertifiedWithin: [[Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html)] - # Name shown in server and desktop clients - name: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Name shown in server and desktop clients - nameWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)] - # True if this database is embedded in Tableau content, e.g., a packaged workbook - isEmbedded: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) - # True if this database is embedded in Tableau content, e.g., a packaged workbook - isEmbeddedWithin: [[Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html)] - # Unique identifier used with the Metadata API. Not the same as the locally - # unique identifier used with the REST API. - id: [ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html) - # Unique identifier used with the Metadata API. Not the same as the locally - # unique identifier used with the REST API. - idWithin: [[ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html)] - # The name of the project in which the database is visible. Will be empty if the - # database is not in a project. - projectName: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # The name of the project in which the database is visible. Will be empty if the - # database is not in a project. - projectNameWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)] - # Connection type shortname - connectionType: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Connection type shortname - connectionTypeWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)] - # Filter the output based on text query. - text: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - } ` ## [_link_](#require-by) Require by - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/api/metadata_api/en-us/reference/query.doc.html "Query - Query root for Metadata GraphQL interface") _menu_ Types ENUM # DataCloudOrderField Enum for fields that can be used for sorting ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - enum DataCloudOrderField { - # Sort by downstreamDatasources count - DOWNSTREAM_DATASOURCES_COUNT - # Sort by downstreamVirtualConnections count - DOWNSTREAM_VIRTUAL_CONNECTIONS_COUNT - # Sort by downstreamWorkbooks count - DOWNSTREAM_WORKBOOKS_COUNT - # Sort by connectionType - CONNECTION_TYPE - # Sort by hasActiveWarning - HAS_ACTIVE_WARNING - # Sort by id - ID - # Sort by isCertified - IS_CERTIFIED - # Sort by isEmbedded - IS_EMBEDDED - # Sort by luid - LUID - # Sort by name - NAME - # Sort by projectName - PROJECT_NAME - } ` ## [_link_](#require-by) Require by - [DataCloudSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/datacloudsortorder.doc.html "DataCloudSortOrder - 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.") _menu_ Types OBJECT # DataCloudsConnection Connection Type for DataCloud ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type DataCloudsConnection { - # List of nodes - nodes: [[DataCloud](https://help.tableau.com/current/api/metadata_api/en-us/reference/datacloud.doc.html)!]! - # Information for pagination - pageInfo: [PageInfo](https://help.tableau.com/current/api/metadata_api/en-us/reference/pageinfo.doc.html)! - # Total number of objects in connection - totalCount: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html)! - } ` ## [_link_](#require-by) Require by - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/api/metadata_api/en-us/reference/query.doc.html "Query - Query root for Metadata GraphQL interface") _menu_ Types INPUT\_OBJECT # DataCloudSortOrder 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. ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input DataCloudSortOrder { - # GraphQL field to sort on - field: [DataCloudOrderField](https://help.tableau.com/current/api/metadata_api/en-us/reference/datacloudorderfield.doc.html)! - # Order direction to sort output - direction: [OrderDirection](https://help.tableau.com/current/api/metadata_api/en-us/reference/orderdirection.doc.html)! - } ` ## [_link_](#require-by) Require by - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/api/metadata_api/en-us/reference/query.doc.html "Query - Query root for Metadata GraphQL interface") _menu_ Types INTERFACE # DataField Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField. ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - interface DataField { - # Data category of the field - dataCategory: [FieldRoleCategory](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldrolecategory.doc.html) - # Role of the field: 'dimension', 'measure' or 'unknown' - role: [FieldRole](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldrole.doc.html) - # Type of the data in the field. See - # https://onlinehelp.tableau.com/current/pro/desktop/en-us/datafields_typesandroles_datatypes.html - dataType: [FieldDataType](https://help.tableau.com/current/api/metadata_api/en-us/reference/fielddatatype.doc.html) - # The bin field that references this field - # - # 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. - referencedByBins( - filter: [BinField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/binfield_filter.doc.html), - orderBy: [BinFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/binfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[BinField](https://help.tableau.com/current/api/metadata_api/en-us/reference/binfield.doc.html)] - # The bin field that references this field - # - # 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. - referencedByBinsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [BinField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/binfield_filter.doc.html), - orderBy: [BinFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/binfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [BinFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/binfieldsconnection.doc.html) - # Sheets that reference this field - # - # 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. - directSheets( - filter: [Sheet_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Sheet](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html)] - # Sheets that reference this field - # - # 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. - directSheetsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Sheet_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [SheetsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsconnection.doc.html) - # The set field that this field references - # - # 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. - referencedBySets( - filter: [SetField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/setfield_filter.doc.html), - orderBy: [SetFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/setfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[SetField](https://help.tableau.com/current/api/metadata_api/en-us/reference/setfield.doc.html)] - # The set field that this field references - # - # 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. - referencedBySetsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [SetField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/setfield_filter.doc.html), - orderBy: [SetFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/setfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [SetFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/setfieldsconnection.doc.html) - # The field that references this remote field - # - # 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. - referencedByRemoteFields( - filter: [DatasourceField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefield_filter.doc.html), - orderBy: [DatasourceFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DatasourceField](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefield.doc.html)] - # The field that references this remote field - # - # 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. - referencedByRemoteFieldsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DatasourceField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefield_filter.doc.html), - orderBy: [DatasourceFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatasourceFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefieldsconnection.doc.html) - # The hierarchy field that references this field - # - # 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. - referencedByHierarchies( - filter: [HierarchyField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/hierarchyfield_filter.doc.html), - orderBy: [HierarchyFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/hierarchyfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[HierarchyField](https://help.tableau.com/current/api/metadata_api/en-us/reference/hierarchyfield.doc.html)] - # The hierarchy field that references this field - # - # 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. - referencedByHierarchiesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [HierarchyField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/hierarchyfield_filter.doc.html), - orderBy: [HierarchyFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/hierarchyfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [HierarchyFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/hierarchyfieldsconnection.doc.html) - # The field that references this field - # - # 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. - referencedByFields( - filter: [FieldReferencingField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield_filter.doc.html), - orderBy: [FieldReferencingFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[FieldReferencingField](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield.doc.html)] - # The field that references this field - # - # 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. - referencedByFieldsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [FieldReferencingField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield_filter.doc.html), - orderBy: [FieldReferencingFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FieldReferencingFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfieldsconnection.doc.html) - # The data source filters that include this field - # - # 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. - referencedByFilters( - filter: [DatasourceFilter_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefilter_filter.doc.html), - orderBy: [DatasourceFilterSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefiltersortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DatasourceFilter](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefilter.doc.html)] - # The data source filters that include this field - # - # 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. - referencedByFiltersConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DatasourceFilter_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefilter_filter.doc.html), - orderBy: [DatasourceFilterSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefiltersortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatasourceFiltersConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefiltersconnection.doc.html) - # Thie combined set field that references this field - # - # 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. - referencedByCombinedSets( - filter: [CombinedSetField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedsetfield_filter.doc.html), - orderBy: [CombinedSetFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedsetfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[CombinedSetField](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedsetfield.doc.html)] - # Thie combined set field that references this field - # - # 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. - referencedByCombinedSetsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [CombinedSetField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedsetfield_filter.doc.html), - orderBy: [CombinedSetFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedsetfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [CombinedSetFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedsetfieldsconnection.doc.html) - # Sheets that reference this data source field - # - # 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. - sheets( - filter: [Sheet_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Sheet](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html)] - # Sheets that reference this data source field - # - # 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. - sheetsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Sheet_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [SheetsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsconnection.doc.html) - # A flow output field that wraps this field - # - # 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. - referencedByFlowFieldOutputField( - filter: [FlowFieldOutputField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfield_filter.doc.html), - orderBy: [FlowFieldOutputFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[FlowFieldOutputField](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfield.doc.html)] - # A flow output field that wraps this field - # - # 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. - referencedByFlowFieldOutputFieldConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [FlowFieldOutputField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfield_filter.doc.html), - orderBy: [FlowFieldOutputFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FlowFieldOutputFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfieldsconnection.doc.html) - # The calculated field that references this field - # - # 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. - referencedByCalculations( - filter: [CalculatedField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/calculatedfield_filter.doc.html), - orderBy: [CalculatedFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/calculatedfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[CalculatedField](https://help.tableau.com/current/api/metadata_api/en-us/reference/calculatedfield.doc.html)] - # The calculated field that references this field - # - # 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. - referencedByCalculationsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [CalculatedField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/calculatedfield_filter.doc.html), - orderBy: [CalculatedFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/calculatedfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [CalculatedFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/calculatedfieldsconnection.doc.html) - # A flow input field that wraps this field - # - # 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. - referencedByFlowFieldInputField( - filter: [FlowFieldInputField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfield_filter.doc.html), - orderBy: [FlowFieldInputFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfieldsortorder.doc.html) - ): [[FlowFieldInputField](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfield.doc.html)] - # A flow input field that wraps this field - # - # 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. - referencedByFlowFieldInputFieldConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [FlowFieldInputField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfield_filter.doc.html), - orderBy: [FlowFieldInputFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfieldsortorder.doc.html) - ): [FlowFieldInputFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfieldsconnection.doc.html) - # Data source that contains this field - datasource: [Datasource](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasource.doc.html) - # Metric definitions that reference this data source field. - # - # 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. - metricDefinitions( - filter: [MetricDefinition_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinition_filter.doc.html), - orderBy: [MetricDefinitionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[MetricDefinition](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinition.doc.html)] - # Metric definitions that reference this data source field. - # - # 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. - metricDefinitionsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [MetricDefinition_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinition_filter.doc.html), - orderBy: [MetricDefinitionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [MetricDefinitionsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsconnection.doc.html) - # The group field that references this field - # - # 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. - referencedByGroups( - filter: [GroupField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/groupfield_filter.doc.html), - orderBy: [GroupFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/groupfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[GroupField](https://help.tableau.com/current/api/metadata_api/en-us/reference/groupfield.doc.html)] - # The group field that references this field - # - # 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. - referencedByGroupsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [GroupField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/groupfield_filter.doc.html), - orderBy: [GroupFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/groupfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [GroupFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/groupfieldsconnection.doc.html) - # The combined field that references this field - # - # 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. - referencedByCombinedFields( - filter: [CombinedField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedfield_filter.doc.html), - orderBy: [CombinedFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[CombinedField](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedfield.doc.html)] - # The combined field that references this field - # - # 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. - referencedByCombinedFieldsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [CombinedField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedfield_filter.doc.html), - orderBy: [CombinedFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [CombinedFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedfieldsconnection.doc.html) - # List of lens fields which are derived from this field - # - # 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. - derivedLensFields( - filter: [LensField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensfield_filter.doc.html), - orderBy: [LensFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[LensField](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensfield.doc.html)] - # List of lens fields which are derived from this field - # - # 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. - derivedLensFieldsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [LensField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensfield_filter.doc.html), - orderBy: [LensFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [LensFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensfieldsconnection.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/current/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/current/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") - [ColumnField_ColumnFields are a type of field which directly connects to a column in some type of table._](https://help.tableau.com/current/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.") - [DataFieldsConnection_Connection Type for DataField_](https://help.tableau.com/current/api/metadata_api/en-us/reference/datafieldsconnection.doc.html "DataFieldsConnection - Connection Type for DataField") - [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/current/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") _menu_ Types INPUT\_OBJECT # DataField\_Filter Filter by GraphQL field and given value ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input DataField_Filter { - # Unique Identifier of object to retrieve - id: [ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html) - # Unique Identifier of object to retrieve - idWithin: [[ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html)] - } ` ## [_link_](#require-by) Require by This element is not required by anyone _menu_ Types ENUM # DataFieldOrderField Enum for fields that can be used for sorting ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - enum DataFieldOrderField { - # Sort by dataCategory - DATA_CATEGORY - # Sort by dataType - DATA_TYPE - # Sort by id - ID - # Sort by role - ROLE - } ` ## [_link_](#require-by) Require by - [DataFieldSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/datafieldsortorder.doc.html "DataFieldSortOrder - 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.") _menu_ Types OBJECT # DataFieldsConnection Connection Type for DataField ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type DataFieldsConnection { - # List of nodes - nodes: [[DataField](https://help.tableau.com/current/api/metadata_api/en-us/reference/datafield.doc.html)!]! - # Information for pagination - pageInfo: [PageInfo](https://help.tableau.com/current/api/metadata_api/en-us/reference/pageinfo.doc.html)! - # Total number of objects in connection - totalCount: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html)! - } ` ## [_link_](#require-by) Require by This element is not required by anyone _menu_ Types INPUT\_OBJECT # DataFieldSortOrder 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. ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input DataFieldSortOrder { - # GraphQL field to sort on - field: [DataFieldOrderField](https://help.tableau.com/current/api/metadata_api/en-us/reference/datafieldorderfield.doc.html)! - # Order direction to sort output - direction: [OrderDirection](https://help.tableau.com/current/api/metadata_api/en-us/reference/orderdirection.doc.html)! - } ` ## [_link_](#require-by) Require by This element is not required by anyone _menu_ Types OBJECT # DataQualityCertification A data quality certification associated with a content item ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type DataQualityCertification implements [Label](https://help.tableau.com/current/api/metadata_api/en-us/reference/label.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/current/api/metadata_api/en-us/reference/id.doc.html)! - # User who last updated this data quality certification - author: [TableauUser](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauuser.doc.html) - # Name of the user who last updated this data quality certification - authorDisplayName: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Vizportal ID of this data quality certifcation, for use in client-to-server - # communications - vizportalId: [String](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/string.doc.html)! - # True if the data quality certification is active - isActive: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html)! - # True if the data quality certification is elevated - isElevated: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html)! - # Value of the label - value: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)! - # Category of the label - category: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)! - # Message of the data quality certification - message: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Time the data quality certification was created - createdAt: [DateTime](https://help.tableau.com/current/api/metadata_api/en-us/reference/datetime.doc.html)! - # Time the data quality certification was last updated - updatedAt: [DateTime](https://help.tableau.com/current/api/metadata_api/en-us/reference/datetime.doc.html)! - # The asset that contains the data quality certification - asset: [CanHaveLabels](https://help.tableau.com/current/api/metadata_api/en-us/reference/canhavelabels.doc.html) - } ` ## [_link_](#require-by) Require by - [Certifiable_A content item that can be certified_](https://help.tableau.com/current/api/metadata_api/en-us/reference/certifiable.doc.html "Certifiable - A content item that can be certified") - [CloudFile_A cloud file connection_](https://help.tableau.com/current/api/metadata_api/en-us/reference/cloudfile.doc.html "CloudFile - A cloud file connection") - [Database_A database containing tables_](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html "Database - A database containing tables") - [DatabaseServer_A database server connection_](https://help.tableau.com/current/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/current/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.*") - [DataQualityCertificationsConnection_Connection Type for DataQualityCertification_](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitycertificationsconnection.doc.html "DataQualityCertificationsConnection - Connection Type for DataQualityCertification") - [File_A file connection_](https://help.tableau.com/current/api/metadata_api/en-us/reference/file.doc.html "File - A file connection") - [PublishedDatasource_A Tableau data source that has been published separately to Tableau Server. It can be used by multiple workbooks._](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/query.doc.html "Query - Query root for Metadata GraphQL interface") - [TableauUser_User on a site on Tableau server_](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauuser.doc.html "TableauUser - User on a site on Tableau server") - [VirtualConnection_A virtual connection. \*Available in Tableau Cloud March 2022 / Server 2022.1 and later.\*_](virtualconnection.doc.html "VirtualConnection - A virtual connection. *Available in Tableau Cloud March 2022 / Server 2022.1 and later.*") - [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/current/api/metadata_api/en-us/reference/webdataconnector.doc.html "WebDataConnector - A web data connector") _menu_ Types INPUT\_OBJECT # DataQualityCertification\_Filter Filter by GraphQL field and given value ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input DataQualityCertification_Filter { - # True if the data quality certification is elevated - isElevated: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) - # True if the data quality certification is elevated - isElevatedWithin: [[Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html)] - # Locally unique identifier used for the REST API on the Tableau Server - luid: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Locally unique identifier used for the REST API on the Tableau Server - luidWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.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/current/api/metadata_api/en-us/reference/id.doc.html) - # Unique identifier used by the metadata API. Not the same as the numeric ID used - # on server - idWithin: [[ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html)] - # True if the data quality certification is active - isActive: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) - # True if the data quality certification is active - isActiveWithin: [[Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html)] - # Category of the label - category: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Category of the label - categoryWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)] - # Value of the label - value: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Value of the label - valueWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)] - } ` ## [_link_](#require-by) Require by - [Certifiable_A content item that can be certified_](https://help.tableau.com/current/api/metadata_api/en-us/reference/certifiable.doc.html "Certifiable - A content item that can be certified") - [CloudFile_A cloud file connection_](https://help.tableau.com/current/api/metadata_api/en-us/reference/cloudfile.doc.html "CloudFile - A cloud file connection") - [Database_A database containing tables_](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html "Database - A database containing tables") - [DatabaseServer_A database server connection_](https://help.tableau.com/current/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/current/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.*") - [File_A file connection_](https://help.tableau.com/current/api/metadata_api/en-us/reference/file.doc.html "File - A file connection") - [PublishedDatasource_A Tableau data source that has been published separately to Tableau Server. It can be used by multiple workbooks._](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/query.doc.html "Query - Query root for Metadata GraphQL interface") - [TableauUser_User on a site on Tableau server_](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauuser.doc.html "TableauUser - User on a site on Tableau server") - [VirtualConnection_A virtual connection. \*Available in Tableau Cloud March 2022 / Server 2022.1 and later.\*_](virtualconnection.doc.html "VirtualConnection - A virtual connection. *Available in Tableau Cloud March 2022 / Server 2022.1 and later.*") - [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/current/api/metadata_api/en-us/reference/webdataconnector.doc.html "WebDataConnector - A web data connector") _menu_ Types ENUM # DataQualityCertificationOrderField Enum for fields that can be used for sorting ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - enum DataQualityCertificationOrderField { - # Sort by category - CATEGORY - # Sort by id - ID - # Sort by isActive - IS_ACTIVE - # Sort by isElevated - IS_ELEVATED - # Sort by luid - LUID - # Sort by value - VALUE - } ` ## [_link_](#require-by) Require by - [DataQualityCertificationSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitycertificationsortorder.doc.html "DataQualityCertificationSortOrder - 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.") _menu_ Types OBJECT # DataQualityCertificationsConnection Connection Type for DataQualityCertification ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type DataQualityCertificationsConnection { - # List of nodes - nodes: [[DataQualityCertification](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitycertification.doc.html)!]! - # Information for pagination - pageInfo: [PageInfo](https://help.tableau.com/current/api/metadata_api/en-us/reference/pageinfo.doc.html)! - # Total number of objects in connection - totalCount: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html)! - } ` ## [_link_](#require-by) Require by - [Certifiable_A content item that can be certified_](https://help.tableau.com/current/api/metadata_api/en-us/reference/certifiable.doc.html "Certifiable - A content item that can be certified") - [CloudFile_A cloud file connection_](https://help.tableau.com/current/api/metadata_api/en-us/reference/cloudfile.doc.html "CloudFile - A cloud file connection") - [Database_A database containing tables_](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html "Database - A database containing tables") - [DatabaseServer_A database server connection_](https://help.tableau.com/current/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/current/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.*") - [File_A file connection_](https://help.tableau.com/current/api/metadata_api/en-us/reference/file.doc.html "File - A file connection") - [PublishedDatasource_A Tableau data source that has been published separately to Tableau Server. It can be used by multiple workbooks._](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/query.doc.html "Query - Query root for Metadata GraphQL interface") - [TableauUser_User on a site on Tableau server_](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauuser.doc.html "TableauUser - User on a site on Tableau server") - [VirtualConnection_A virtual connection. \*Available in Tableau Cloud March 2022 / Server 2022.1 and later.\*_](virtualconnection.doc.html "VirtualConnection - A virtual connection. *Available in Tableau Cloud March 2022 / Server 2022.1 and later.*") - [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/current/api/metadata_api/en-us/reference/webdataconnector.doc.html "WebDataConnector - A web data connector") _menu_ Types INPUT\_OBJECT # DataQualityCertificationSortOrder 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. ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input DataQualityCertificationSortOrder { - # GraphQL field to sort on - field: [DataQualityCertificationOrderField](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitycertificationorderfield.doc.html)! - # Order direction to sort output - direction: [OrderDirection](https://help.tableau.com/current/api/metadata_api/en-us/reference/orderdirection.doc.html)! - } ` ## [_link_](#require-by) Require by - [Certifiable_A content item that can be certified_](https://help.tableau.com/current/api/metadata_api/en-us/reference/certifiable.doc.html "Certifiable - A content item that can be certified") - [CloudFile_A cloud file connection_](https://help.tableau.com/current/api/metadata_api/en-us/reference/cloudfile.doc.html "CloudFile - A cloud file connection") - [Database_A database containing tables_](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html "Database - A database containing tables") - [DatabaseServer_A database server connection_](https://help.tableau.com/current/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/current/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.*") - [File_A file connection_](https://help.tableau.com/current/api/metadata_api/en-us/reference/file.doc.html "File - A file connection") - [PublishedDatasource_A Tableau data source that has been published separately to Tableau Server. It can be used by multiple workbooks._](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/query.doc.html "Query - Query root for Metadata GraphQL interface") - [TableauUser_User on a site on Tableau server_](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauuser.doc.html "TableauUser - User on a site on Tableau server") - [VirtualConnection_A virtual connection. \*Available in Tableau Cloud March 2022 / Server 2022.1 and later.\*_](virtualconnection.doc.html "VirtualConnection - A virtual connection. *Available in Tableau Cloud March 2022 / Server 2022.1 and later.*") - [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/current/api/metadata_api/en-us/reference/webdataconnector.doc.html "WebDataConnector - A web data connector") _menu_ Types OBJECT # DataQualityWarning A data quality warning associated with a content item ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type DataQualityWarning implements [Label](https://help.tableau.com/current/api/metadata_api/en-us/reference/label.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/current/api/metadata_api/en-us/reference/id.doc.html)! - # User who last updated this data quality warning - author: [TableauUser](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauuser.doc.html) - # Name of the user who last updated this data quality warning - authorDisplayName: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Vizportal ID of this data quality warning, for use in client-to-server - # communications - vizportalId: [String](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/string.doc.html)! - # True if the data quality warning is active - isActive: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html)! - # Synonymous with isElevated - isSevere: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html)! @deprecated( reason: "Use 'isElevated'" ) - # True if the data quality warning is elevated - isElevated: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html)! - # Synonymous with value - warningType: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)! @deprecated( reason: "Use 'value'" ) - # Value of the label - value: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)! - # Category of the label - category: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)! - # Message of the data quality warning - message: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Time the data quality warning was created - createdAt: [DateTime](https://help.tableau.com/current/api/metadata_api/en-us/reference/datetime.doc.html)! - # Time the data quality warning was last updated - updatedAt: [DateTime](https://help.tableau.com/current/api/metadata_api/en-us/reference/datetime.doc.html)! - # The asset that contains the data quality warning - asset: [CanHaveLabels](https://help.tableau.com/current/api/metadata_api/en-us/reference/canhavelabels.doc.html) - } ` ## [_link_](#require-by) Require by - [CloudFile_A cloud file connection_](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/column.doc.html "Column - GraphQL type for a table column") - [Dashboard_A dashboard contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard.doc.html "Dashboard - A dashboard contained in a published workbook.") - [Database_A database containing tables_](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html "Database - A database containing tables") - [DatabaseServer_A database server connection_](https://help.tableau.com/current/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/current/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.*") - [DataQualityWarningsConnection_Connection Type for DataQualityWarning_](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarningsconnection.doc.html "DataQualityWarningsConnection - Connection Type for DataQualityWarning") - [EmbeddedDatasource_A data source embedded in a workbook_](https://help.tableau.com/current/api/metadata_api/en-us/reference/embeddeddatasource.doc.html "EmbeddedDatasource - A data source embedded in a workbook") - [File_A file connection_](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/flow.doc.html "Flow - Flows are used to prepare data, which can include aggregation, cleaning, preprocessing, etc.") - [Metric_Metrics are time series data constructed from fields contained in views. \*Retired in Tableau Cloud February 2024 / Server 2024.2.\*_](metric.doc.html "Metric - Metrics are time series data constructed from fields contained in views. *Retired in Tableau Cloud February 2024 / Server 2024.2.*") - [PublishedDatasource_A Tableau data source that has been published separately to Tableau Server. It can be used by multiple workbooks._](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/query.doc.html "Query - Query root for Metadata GraphQL interface") - [Sheet_A sheet contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html "Sheet - A sheet contained in a published workbook.") - [TableauUser_User on a site on Tableau server_](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauuser.doc.html "TableauUser - User on a site on Tableau server") - [View_A view contained in a published workbook. Views can be sheets or dashboards._](https://help.tableau.com/current/api/metadata_api/en-us/reference/view.doc.html "View - A view contained in a published workbook. Views can be sheets or dashboards.") - [VirtualConnection_A virtual connection. \*Available in Tableau Cloud March 2022 / Server 2022.1 and later.\*_](virtualconnection.doc.html "VirtualConnection - A virtual connection. *Available in Tableau Cloud March 2022 / Server 2022.1 and later.*") - [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.*") - [Warnable_A content item that can have data quality warnings_](https://help.tableau.com/current/api/metadata_api/en-us/reference/warnable.doc.html "Warnable - A content item that can have data quality warnings") - [WebDataConnector_A web data connector_](https://help.tableau.com/current/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/current/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).") _menu_ Types INPUT\_OBJECT # DataQualityWarning\_Filter Filter by GraphQL field and given value ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input DataQualityWarning_Filter { - # True if the data quality warning is elevated - isElevated: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) - # True if the data quality warning is elevated - isElevatedWithin: [[Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html)] - # Synonymous with value - warningType: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Synonymous with value - warningTypeWithin: [[String](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/string.doc.html) - # Locally unique identifier used for the REST API on the Tableau Server - luidWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.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/current/api/metadata_api/en-us/reference/id.doc.html) - # Unique identifier used by the metadata API. Not the same as the numeric ID used - # on server - idWithin: [[ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html)] - # True if the data quality warning is active - isActive: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) - # True if the data quality warning is active - isActiveWithin: [[Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html)] - # Category of the label - category: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Category of the label - categoryWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)] - # Value of the label - value: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Value of the label - valueWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)] - # Synonymous with isElevated - isSevere: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) - # Synonymous with isElevated - isSevereWithin: [[Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html)] - } ` ## [_link_](#require-by) Require by - [CloudFile_A cloud file connection_](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/column.doc.html "Column - GraphQL type for a table column") - [Dashboard_A dashboard contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard.doc.html "Dashboard - A dashboard contained in a published workbook.") - [Database_A database containing tables_](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html "Database - A database containing tables") - [DatabaseServer_A database server connection_](https://help.tableau.com/current/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/current/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.*") - [EmbeddedDatasource_A data source embedded in a workbook_](https://help.tableau.com/current/api/metadata_api/en-us/reference/embeddeddatasource.doc.html "EmbeddedDatasource - A data source embedded in a workbook") - [File_A file connection_](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/flow.doc.html "Flow - Flows are used to prepare data, which can include aggregation, cleaning, preprocessing, etc.") - [Metric_Metrics are time series data constructed from fields contained in views. \*Retired in Tableau Cloud February 2024 / Server 2024.2.\*_](metric.doc.html "Metric - Metrics are time series data constructed from fields contained in views. *Retired in Tableau Cloud February 2024 / Server 2024.2.*") - [PublishedDatasource_A Tableau data source that has been published separately to Tableau Server. It can be used by multiple workbooks._](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/query.doc.html "Query - Query root for Metadata GraphQL interface") - [Sheet_A sheet contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html "Sheet - A sheet contained in a published workbook.") - [TableauUser_User on a site on Tableau server_](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauuser.doc.html "TableauUser - User on a site on Tableau server") - [View_A view contained in a published workbook. Views can be sheets or dashboards._](https://help.tableau.com/current/api/metadata_api/en-us/reference/view.doc.html "View - A view contained in a published workbook. Views can be sheets or dashboards.") - [VirtualConnection_A virtual connection. \*Available in Tableau Cloud March 2022 / Server 2022.1 and later.\*_](virtualconnection.doc.html "VirtualConnection - A virtual connection. *Available in Tableau Cloud March 2022 / Server 2022.1 and later.*") - [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.*") - [Warnable_A content item that can have data quality warnings_](https://help.tableau.com/current/api/metadata_api/en-us/reference/warnable.doc.html "Warnable - A content item that can have data quality warnings") - [WebDataConnector_A web data connector_](https://help.tableau.com/current/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/current/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).") _menu_ Types ENUM # DataQualityWarningOrderField Enum for fields that can be used for sorting ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - enum DataQualityWarningOrderField { - # Sort by category - CATEGORY - # Sort by id - ID - # Sort by isActive - IS_ACTIVE - # Sort by isElevated - IS_ELEVATED - # Sort by isSevere - IS_SEVERE - # Sort by luid - LUID - # Sort by value - VALUE - # Sort by warningType - WARNING_TYPE - } ` ## [_link_](#require-by) Require by - [DataQualityWarningSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarningsortorder.doc.html "DataQualityWarningSortOrder - 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.") _menu_ Types OBJECT # DataQualityWarningsConnection Connection Type for DataQualityWarning ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type DataQualityWarningsConnection { - # List of nodes - nodes: [[DataQualityWarning](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarning.doc.html)!]! - # Information for pagination - pageInfo: [PageInfo](https://help.tableau.com/current/api/metadata_api/en-us/reference/pageinfo.doc.html)! - # Total number of objects in connection - totalCount: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html)! - } ` ## [_link_](#require-by) Require by - [CloudFile_A cloud file connection_](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/column.doc.html "Column - GraphQL type for a table column") - [Dashboard_A dashboard contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard.doc.html "Dashboard - A dashboard contained in a published workbook.") - [Database_A database containing tables_](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html "Database - A database containing tables") - [DatabaseServer_A database server connection_](https://help.tableau.com/current/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/current/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.*") - [EmbeddedDatasource_A data source embedded in a workbook_](https://help.tableau.com/current/api/metadata_api/en-us/reference/embeddeddatasource.doc.html "EmbeddedDatasource - A data source embedded in a workbook") - [File_A file connection_](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/flow.doc.html "Flow - Flows are used to prepare data, which can include aggregation, cleaning, preprocessing, etc.") - [Metric_Metrics are time series data constructed from fields contained in views. \*Retired in Tableau Cloud February 2024 / Server 2024.2.\*_](metric.doc.html "Metric - Metrics are time series data constructed from fields contained in views. *Retired in Tableau Cloud February 2024 / Server 2024.2.*") - [PublishedDatasource_A Tableau data source that has been published separately to Tableau Server. It can be used by multiple workbooks._](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/query.doc.html "Query - Query root for Metadata GraphQL interface") - [Sheet_A sheet contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html "Sheet - A sheet contained in a published workbook.") - [TableauUser_User on a site on Tableau server_](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauuser.doc.html "TableauUser - User on a site on Tableau server") - [View_A view contained in a published workbook. Views can be sheets or dashboards._](https://help.tableau.com/current/api/metadata_api/en-us/reference/view.doc.html "View - A view contained in a published workbook. Views can be sheets or dashboards.") - [VirtualConnection_A virtual connection. \*Available in Tableau Cloud March 2022 / Server 2022.1 and later.\*_](virtualconnection.doc.html "VirtualConnection - A virtual connection. *Available in Tableau Cloud March 2022 / Server 2022.1 and later.*") - [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.*") - [Warnable_A content item that can have data quality warnings_](https://help.tableau.com/current/api/metadata_api/en-us/reference/warnable.doc.html "Warnable - A content item that can have data quality warnings") - [WebDataConnector_A web data connector_](https://help.tableau.com/current/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/current/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).") _menu_ Types INPUT\_OBJECT # DataQualityWarningSortOrder 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. ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input DataQualityWarningSortOrder { - # GraphQL field to sort on - field: [DataQualityWarningOrderField](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarningorderfield.doc.html)! - # Order direction to sort output - direction: [OrderDirection](https://help.tableau.com/current/api/metadata_api/en-us/reference/orderdirection.doc.html)! - } ` ## [_link_](#require-by) Require by - [CloudFile_A cloud file connection_](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/column.doc.html "Column - GraphQL type for a table column") - [Dashboard_A dashboard contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard.doc.html "Dashboard - A dashboard contained in a published workbook.") - [Database_A database containing tables_](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html "Database - A database containing tables") - [DatabaseServer_A database server connection_](https://help.tableau.com/current/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/current/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.*") - [EmbeddedDatasource_A data source embedded in a workbook_](https://help.tableau.com/current/api/metadata_api/en-us/reference/embeddeddatasource.doc.html "EmbeddedDatasource - A data source embedded in a workbook") - [File_A file connection_](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/flow.doc.html "Flow - Flows are used to prepare data, which can include aggregation, cleaning, preprocessing, etc.") - [Metric_Metrics are time series data constructed from fields contained in views. \*Retired in Tableau Cloud February 2024 / Server 2024.2.\*_](metric.doc.html "Metric - Metrics are time series data constructed from fields contained in views. *Retired in Tableau Cloud February 2024 / Server 2024.2.*") - [PublishedDatasource_A Tableau data source that has been published separately to Tableau Server. It can be used by multiple workbooks._](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/query.doc.html "Query - Query root for Metadata GraphQL interface") - [Sheet_A sheet contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html "Sheet - A sheet contained in a published workbook.") - [TableauUser_User on a site on Tableau server_](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauuser.doc.html "TableauUser - User on a site on Tableau server") - [View_A view contained in a published workbook. Views can be sheets or dashboards._](https://help.tableau.com/current/api/metadata_api/en-us/reference/view.doc.html "View - A view contained in a published workbook. Views can be sheets or dashboards.") - [VirtualConnection_A virtual connection. \*Available in Tableau Cloud March 2022 / Server 2022.1 and later.\*_](virtualconnection.doc.html "VirtualConnection - A virtual connection. *Available in Tableau Cloud March 2022 / Server 2022.1 and later.*") - [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.*") - [Warnable_A content item that can have data quality warnings_](https://help.tableau.com/current/api/metadata_api/en-us/reference/warnable.doc.html "Warnable - A content item that can have data quality warnings") - [WebDataConnector_A web data connector_](https://help.tableau.com/current/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/current/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).") _menu_ Types INTERFACE # Datasource Root GraphQL type for embedded and published data sources Data sources are a way to represent how Tableau Desktop and Tableau Server model and connect to data. Data sources can be published separately, as a published data source, or may be contained in a workbook as an embedded data source. See [https://onlinehelp.tableau.com/current/server/en-us/datasource.htm](https://onlinehelp.tableau.com/current/server/en-us/datasource.htm) ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - interface Datasource { - # Unique identifier used by the metadata API. Not the same as the numeric ID used - # on server - id: [ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html)! - # Name shown in server and desktop clients - name: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # True if data source contains a formula that involves a user function (for - # example, USERNAME or ISMEMBEROF) - hasUserReference: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) - # True if datasource contains extracted data - hasExtracts: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) - # True if the datasource contains unsupported custom SQL, in which case lineage - # may be incomplete - containsUnsupportedCustomSql: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) - # Time an extract was last fully refreshed - extractLastRefreshTime: [DateTime](https://help.tableau.com/current/api/metadata_api/en-us/reference/datetime.doc.html) - # Time an extract was last incrementally updated - extractLastIncrementalUpdateTime: [DateTime](https://help.tableau.com/current/api/metadata_api/en-us/reference/datetime.doc.html) - # Time an extract was last updated by either a full refresh, incremental update, - # or creation - extractLastUpdateTime: [DateTime](https://help.tableau.com/current/api/metadata_api/en-us/reference/datetime.doc.html) - # Fields usable in workbooks connected to this data source - # - # 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. - fields( - filter: [Field_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/field_filter.doc.html), - orderBy: [FieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Field](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.doc.html)!]! - # Fields usable in workbooks connected to this data source - # - # 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. - fieldsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Field_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/field_filter.doc.html), - orderBy: [FieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsconnection.doc.html) - # Data source filters contained in this data source - # - # 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. - datasourceFilters( - filter: [DatasourceFilter_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefilter_filter.doc.html), - orderBy: [DatasourceFilterSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefiltersortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DatasourceFilter](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefilter.doc.html)!]! - # Data source filters contained in this data source - # - # 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. - datasourceFiltersConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DatasourceFilter_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefilter_filter.doc.html), - orderBy: [DatasourceFilterSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefiltersortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatasourceFiltersConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefiltersconnection.doc.html) - # Sheets downstream from this data source - # - # 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/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Sheet](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html)!]! - # Sheets downstream from this data source - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Sheet_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [SheetsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsconnection.doc.html) - # Dashboards downstream from this data source - # - # 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/current/api/metadata_api/en-us/reference/dashboard_filter.doc.html), - orderBy: [DashboardSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboardsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Dashboard](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard.doc.html)!]! - # Dashboards downstream from this data source - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Dashboard_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard_filter.doc.html), - orderBy: [DashboardSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboardsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DashboardsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboardsconnection.doc.html) - # Workbooks downstream from this data source - # - # 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/current/api/metadata_api/en-us/reference/workbook_filter.doc.html), - orderBy: [WorkbookSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Workbook](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbook.doc.html)!]! - # Workbooks downstream from this data source - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Workbook_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbook_filter.doc.html), - orderBy: [WorkbookSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [WorkbooksConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksconnection.doc.html) - # Workbook owners downstream from this data source - # - # 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/current/api/metadata_api/en-us/reference/tableauuser_filter.doc.html), - orderBy: [TableauUserSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauusersortorder.doc.html) - ): [[TableauUser](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauuser.doc.html)!]! - # Workbook owners downstream from this data source - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [TableauUser_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauuser_filter.doc.html), - orderBy: [TableauUserSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauusersortorder.doc.html) - ): [TableauUsersConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauusersconnection.doc.html) - # Tables upstream from this data source - # - # 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/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DatabaseTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable.doc.html)!]! - # Tables upstream from this data source - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabaseTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesconnection.doc.html) - # Databases upstream from this data source - # - # 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/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Database](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html)!]! - # Databases upstream from this data source - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Database_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabasesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesconnection.doc.html) - # Time the datasource was created. Available in Tableau Cloud June 2022 / Server - # 2022.3 and later. - createdAt: [DateTime](https://help.tableau.com/current/api/metadata_api/en-us/reference/datetime.doc.html) - # Time the datasource was last updated. Available in Tableau Cloud June 2022 / - # Server 2022.3 and later. - updatedAt: [DateTime](https://help.tableau.com/current/api/metadata_api/en-us/reference/datetime.doc.html) - # The lenses derived from this datasource - # - # 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. - lenses( - filter: [Lens_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/lens_filter.doc.html), - orderBy: [LensSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/lenssortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Lens](https://help.tableau.com/current/api/metadata_api/en-us/reference/lens.doc.html)] - # The lenses derived from this datasource - # - # 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. - lensesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Lens_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/lens_filter.doc.html), - orderBy: [LensSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/lenssortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [LensesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensesconnection.doc.html) - } ` ## [_link_](#require-by) Require by - [AnalyticsField_Base GraphQL type for a field containing analytics metadata_](https://help.tableau.com/current/api/metadata_api/en-us/reference/analyticsfield.doc.html "AnalyticsField - Base GraphQL type for a field containing analytics metadata") - [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/current/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/current/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") - [ColumnField_ColumnFields are a type of field which directly connects to a column in some type of table._](https://help.tableau.com/current/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/current/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/current/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") - [Dashboard_A dashboard contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard.doc.html "Dashboard - A dashboard contained in a published workbook.") - [DataField_Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField._](https://help.tableau.com/current/api/metadata_api/en-us/reference/datafield.doc.html "DataField - Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField.") - [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/current/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.") - [DatasourceFilter_Data source filters include/exclude certain values from a single field to filter out rows of data from this data source. For data security reasons, we don't track the values used in the filter in this schema, but you can see the field used in the filter. See https://onlinehelp.tableau.com/current/pro/desktop/en-us/filtering\_datasource.html_](datasourcefilter.doc.html "DatasourceFilter - Data source filters include/exclude certain values from a single field to filter out rows of data from this data source. For data security reasons, we don't track the values used in the filter in this schema, but you can see the field used in the filter. See https://onlinehelp.tableau.com/current/pro/desktop/en-us/filtering_datasource.html") - [DatasourcesConnection_Connection Type for Datasource_](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcesconnection.doc.html "DatasourcesConnection - Connection Type for Datasource") - [EmbeddedDatasource_A data source embedded in a workbook_](https://help.tableau.com/current/api/metadata_api/en-us/reference/embeddeddatasource.doc.html "EmbeddedDatasource - A data source embedded in a workbook") - [Field_Base GraphQL type for a field_](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [FieldReferencingField_Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula._](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield.doc.html "FieldReferencingField - Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula.") - [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/current/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/current/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.*") - [PublishedDatasource_A Tableau data source that has been published separately to Tableau Server. It can be used by multiple workbooks._](https://help.tableau.com/current/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/current/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/current/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") - [Sheet_A sheet contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html "Sheet - A sheet contained in a published workbook.") _menu_ Types INPUT\_OBJECT # Datasource\_Filter Filter by GraphQL field and given value ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input Datasource_Filter { - # True if the datasource contains unsupported custom SQL, in which case lineage - # may be incomplete - containsUnsupportedCustomSql: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) - # True if the datasource contains unsupported custom SQL, in which case lineage - # may be incomplete - containsUnsupportedCustomSqlWithin: [[Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html)] - # Name shown in server and desktop clients - name: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Name shown in server and desktop clients - nameWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.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/current/api/metadata_api/en-us/reference/id.doc.html) - # Unique identifier used by the metadata API. Not the same as the numeric ID used - # on server - idWithin: [[ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html)] - } ` ## [_link_](#require-by) Require by - [Dashboard_A dashboard contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard.doc.html "Dashboard - A dashboard contained in a published workbook.") - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/api/metadata_api/en-us/reference/query.doc.html "Query - Query root for Metadata GraphQL interface") - [Sheet_A sheet contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html "Sheet - A sheet contained in a published workbook.") _menu_ Types OBJECT # 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. ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type DatasourceField implements [Field](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.doc.html), [Node](https://help.tableau.com/current/api/metadata_api/en-us/reference/node.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/current/api/metadata_api/en-us/reference/id.doc.html)! - # Name shown in server and desktop clients - name: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Name internally used to uniquely identify fields - fullyQualifiedName: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Description of field shown in server and desktop clients - description: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # description that is shown in the Tableau UI - # - # Arguments - # **inheritanceType**: Method for selecting inherited value - # **permissionMode**: Option to select how to apply permissions. By - # default it is OBFUSCATE_RESULTS - descriptionInherited( - inheritanceType: [InheritanceType](https://help.tableau.com/current/api/metadata_api/en-us/reference/inheritancetype.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[InheritedStringResult](https://help.tableau.com/current/api/metadata_api/en-us/reference/inheritedstringresult.doc.html)] - # True if the field is hidden - isHidden: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) - # Name of folder if the field is in a folder. See - # https://onlinehelp.tableau.com/current/pro/desktop/en-us/datafields_dwfeatures.html#Organize - folderName: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Reference to a field from a published data source. This property only exists on - # Fields that are in an embedded data source with a connection to a published data - # source. - remoteField: [Field](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.doc.html) - # Columns downstream of this field - # - # 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. - downstreamColumns( - filter: [Column_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/column_filter.doc.html), - orderBy: [ColumnSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Column](https://help.tableau.com/current/api/metadata_api/en-us/reference/column.doc.html)!]! - # Columns downstream of this field - # - # 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. - downstreamColumnsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Column_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/column_filter.doc.html), - orderBy: [ColumnSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [ColumnsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnsconnection.doc.html) - # Tables downstream of this field - # - # 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. - downstreamTables( - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DatabaseTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable.doc.html)!]! - # Tables downstream of this field - # - # 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. - downstreamTablesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabaseTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesconnection.doc.html) - # Virtual connection tables downstream of this field - # - # 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/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnectionTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable.doc.html)!]! - # Virtual connection tables downstream of this field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnectionTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesconnection.doc.html) - # Virtual connections downstream of this field - # - # 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. - downstreamVirtualConnections( - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection.doc.html)!]! - # Virtual connections downstream of this field - # - # 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. - downstreamVirtualConnectionsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsconnection.doc.html) - # Databases downstream of this field - # - # 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. - downstreamDatabases( - filter: [Database_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Database](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html)!]! - # Databases downstream of this field - # - # 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. - downstreamDatabasesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Database_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabasesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesconnection.doc.html) - # Flows downstream of this field - # - # 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/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Flow](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow.doc.html)!]! - # Flows downstream of this field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Flow_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FlowsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsconnection.doc.html) - # downstream fields that reference this field - # - # 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. - downstreamFields( - filter: [Field_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/field_filter.doc.html), - orderBy: [FieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Field](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.doc.html)!]! - # downstream fields that reference this field - # - # 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. - downstreamFieldsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Field_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/field_filter.doc.html), - orderBy: [FieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsconnection.doc.html) - # Datasources connected downstream from this field - # - # 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/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[PublishedDatasource](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource.doc.html)!] - # Datasources connected downstream from this field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [PublishedDatasource_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [PublishedDatasourcesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesconnection.doc.html) - # Lenses connected downstream from this field - # - # 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/current/api/metadata_api/en-us/reference/lens_filter.doc.html), - orderBy: [LensSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/lenssortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Lens](https://help.tableau.com/current/api/metadata_api/en-us/reference/lens.doc.html)!] - # Lenses connected downstream from this field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Lens_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/lens_filter.doc.html), - orderBy: [LensSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/lenssortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [LensesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensesconnection.doc.html) - # Sheets connected downstream from the field - # - # 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/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Sheet](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html)!]! - # Sheets connected downstream from the field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Sheet_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [SheetsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsconnection.doc.html) - # Dashboards connected downstream from the field - # - # 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/current/api/metadata_api/en-us/reference/dashboard_filter.doc.html), - orderBy: [DashboardSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboardsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Dashboard](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard.doc.html)!]! - # Dashboards connected downstream from the field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Dashboard_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard_filter.doc.html), - orderBy: [DashboardSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboardsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DashboardsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboardsconnection.doc.html) - # Workbooks connected downstream from the field - # - # 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/current/api/metadata_api/en-us/reference/workbook_filter.doc.html), - orderBy: [WorkbookSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Workbook](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbook.doc.html)!] - # Workbooks connected downstream from the field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Workbook_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbook_filter.doc.html), - orderBy: [WorkbookSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [WorkbooksConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksconnection.doc.html) - # Metrics connected downstream from the field - # - # 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/current/api/metadata_api/en-us/reference/metric_filter.doc.html), - orderBy: [MetricSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Metric](https://help.tableau.com/current/api/metadata_api/en-us/reference/metric.doc.html)!] - # Metrics connected downstream from the field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Metric_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metric_filter.doc.html), - orderBy: [MetricSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [MetricsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricsconnection.doc.html) - # Workbook owners (authors) connected downstream from the field - # - # 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/current/api/metadata_api/en-us/reference/tableauuser_filter.doc.html), - orderBy: [TableauUserSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauusersortorder.doc.html) - ): [[TableauUser](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauuser.doc.html)!] - # Workbook owners (authors) connected downstream from the field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [TableauUser_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauuser_filter.doc.html), - orderBy: [TableauUserSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauusersortorder.doc.html) - ): [TableauUsersConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauusersconnection.doc.html) - # Tables connected upstream from the field - # - # 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/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DatabaseTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable.doc.html)!]! - # Tables connected upstream from the field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabaseTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesconnection.doc.html) - # Virtual connection tables upstream of this field - # - # 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/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnectionTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable.doc.html)!]! - # Virtual connection tables upstream of this field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnectionTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesconnection.doc.html) - # Virtual connections upstream of this field - # - # 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. - upstreamVirtualConnections( - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection.doc.html)!]! - # Virtual connections upstream of this field - # - # 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. - upstreamVirtualConnectionsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsconnection.doc.html) - # Databases connected upstream from the field - # - # 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/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Database](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html)!]! - # Databases connected upstream from the field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Database_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabasesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesconnection.doc.html) - # Flows connected upstream from the field - # - # 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/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Flow](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow.doc.html)!]! - # Flows connected upstream from the field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Flow_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FlowsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsconnection.doc.html) - # Datasources connected upstream from the field - # - # 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/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[PublishedDatasource](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource.doc.html)!]! - # Datasources connected upstream from the field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [PublishedDatasource_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [PublishedDatasourcesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesconnection.doc.html) - # The field that references this field - # - # 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. - referencedByFields( - filter: [FieldReferencingField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield_filter.doc.html), - orderBy: [FieldReferencingFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[FieldReferencingField](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield.doc.html)] - # The field that references this field - # - # 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. - referencedByFieldsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [FieldReferencingField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield_filter.doc.html), - orderBy: [FieldReferencingFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FieldReferencingFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfieldsconnection.doc.html) - # Data source that contains this field - datasource: [Datasource](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasource.doc.html) - # Metric definitions that reference this data source field. - # - # 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. - metricDefinitions( - filter: [MetricDefinition_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinition_filter.doc.html), - orderBy: [MetricDefinitionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[MetricDefinition](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinition.doc.html)] - # Metric definitions that reference this data source field. - # - # 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. - metricDefinitionsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [MetricDefinition_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinition_filter.doc.html), - orderBy: [MetricDefinitionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [MetricDefinitionsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsconnection.doc.html) - # The data source filters that include this field - # - # 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. - referencedByFilters( - filter: [DatasourceFilter_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefilter_filter.doc.html), - orderBy: [DatasourceFilterSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefiltersortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DatasourceFilter](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefilter.doc.html)] - # The data source filters that include this field - # - # 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. - referencedByFiltersConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DatasourceFilter_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefilter_filter.doc.html), - orderBy: [DatasourceFilterSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefiltersortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatasourceFiltersConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefiltersconnection.doc.html) - # The bin field that references this field - # - # 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. - referencedByBins( - filter: [BinField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/binfield_filter.doc.html), - orderBy: [BinFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/binfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[BinField](https://help.tableau.com/current/api/metadata_api/en-us/reference/binfield.doc.html)] - # The bin field that references this field - # - # 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. - referencedByBinsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [BinField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/binfield_filter.doc.html), - orderBy: [BinFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/binfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [BinFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/binfieldsconnection.doc.html) - # The calculated field that references this field - # - # 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. - referencedByCalculations( - filter: [CalculatedField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/calculatedfield_filter.doc.html), - orderBy: [CalculatedFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/calculatedfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[CalculatedField](https://help.tableau.com/current/api/metadata_api/en-us/reference/calculatedfield.doc.html)] - # The calculated field that references this field - # - # 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. - referencedByCalculationsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [CalculatedField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/calculatedfield_filter.doc.html), - orderBy: [CalculatedFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/calculatedfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [CalculatedFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/calculatedfieldsconnection.doc.html) - # The combined field that references this field - # - # 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. - referencedByCombinedFields( - filter: [CombinedField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedfield_filter.doc.html), - orderBy: [CombinedFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[CombinedField](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedfield.doc.html)] - # The combined field that references this field - # - # 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. - referencedByCombinedFieldsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [CombinedField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedfield_filter.doc.html), - orderBy: [CombinedFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [CombinedFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedfieldsconnection.doc.html) - # Thie combined set field that references this field - # - # 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. - referencedByCombinedSets( - filter: [CombinedSetField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedsetfield_filter.doc.html), - orderBy: [CombinedSetFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedsetfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[CombinedSetField](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedsetfield.doc.html)] - # Thie combined set field that references this field - # - # 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. - referencedByCombinedSetsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [CombinedSetField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedsetfield_filter.doc.html), - orderBy: [CombinedSetFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedsetfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [CombinedSetFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedsetfieldsconnection.doc.html) - # The field that references this remote field - # - # 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. - referencedByRemoteFields( - filter: [DatasourceField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefield_filter.doc.html), - orderBy: [DatasourceFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DatasourceField](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefield.doc.html)] - # The field that references this remote field - # - # 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. - referencedByRemoteFieldsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DatasourceField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefield_filter.doc.html), - orderBy: [DatasourceFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatasourceFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefieldsconnection.doc.html) - # The group field that references this field - # - # 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. - referencedByGroups( - filter: [GroupField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/groupfield_filter.doc.html), - orderBy: [GroupFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/groupfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[GroupField](https://help.tableau.com/current/api/metadata_api/en-us/reference/groupfield.doc.html)] - # The group field that references this field - # - # 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. - referencedByGroupsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [GroupField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/groupfield_filter.doc.html), - orderBy: [GroupFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/groupfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [GroupFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/groupfieldsconnection.doc.html) - # The set field that this field references - # - # 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. - referencedBySets( - filter: [SetField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/setfield_filter.doc.html), - orderBy: [SetFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/setfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[SetField](https://help.tableau.com/current/api/metadata_api/en-us/reference/setfield.doc.html)] - # The set field that this field references - # - # 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. - referencedBySetsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [SetField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/setfield_filter.doc.html), - orderBy: [SetFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/setfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [SetFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/setfieldsconnection.doc.html) - # The hierarchy field that references this field - # - # 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. - referencedByHierarchies( - filter: [HierarchyField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/hierarchyfield_filter.doc.html), - orderBy: [HierarchyFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/hierarchyfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[HierarchyField](https://help.tableau.com/current/api/metadata_api/en-us/reference/hierarchyfield.doc.html)] - # The hierarchy field that references this field - # - # 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. - referencedByHierarchiesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [HierarchyField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/hierarchyfield_filter.doc.html), - orderBy: [HierarchyFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/hierarchyfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [HierarchyFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/hierarchyfieldsconnection.doc.html) - # Sheets that reference this data source field - # - # 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. - sheets( - filter: [Sheet_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Sheet](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html)] - # Sheets that reference this data source field - # - # 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. - sheetsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Sheet_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [SheetsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsconnection.doc.html) - # Sheets that reference this field - # - # 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. - directSheets( - filter: [Sheet_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Sheet](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html)] - # Sheets that reference this field - # - # 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. - directSheetsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Sheet_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [SheetsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsconnection.doc.html) - # List of lens fields which are derived from this field - # - # 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. - derivedLensFields( - filter: [LensField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensfield_filter.doc.html), - orderBy: [LensFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[LensField](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensfield.doc.html)] - # List of lens fields which are derived from this field - # - # 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. - derivedLensFieldsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [LensField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensfield_filter.doc.html), - orderBy: [LensFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [LensFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensfieldsconnection.doc.html) - # A flow input field that wraps this field - # - # 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. - referencedByFlowFieldInputField( - filter: [FlowFieldInputField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfield_filter.doc.html), - orderBy: [FlowFieldInputFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfieldsortorder.doc.html) - ): [[FlowFieldInputField](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfield.doc.html)] - # A flow input field that wraps this field - # - # 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. - referencedByFlowFieldInputFieldConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [FlowFieldInputField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfield_filter.doc.html), - orderBy: [FlowFieldInputFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfieldsortorder.doc.html) - ): [FlowFieldInputFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfieldsconnection.doc.html) - # A flow output field that wraps this field - # - # 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. - referencedByFlowFieldOutputField( - filter: [FlowFieldOutputField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfield_filter.doc.html), - orderBy: [FlowFieldOutputFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[FlowFieldOutputField](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfield.doc.html)] - # A flow output field that wraps this field - # - # 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. - referencedByFlowFieldOutputFieldConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [FlowFieldOutputField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfield_filter.doc.html), - orderBy: [FlowFieldOutputFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FlowFieldOutputFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfieldsconnection.doc.html) - # fields that are upstream of this field - # - # 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. - upstreamFields( - filter: [Field_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/field_filter.doc.html), - orderBy: [FieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Field](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.doc.html)]! - # fields that are upstream of this field - # - # 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. - upstreamFieldsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Field_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/field_filter.doc.html), - orderBy: [FieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsconnection.doc.html) - # Metric definitions downstream from this field. - # - # 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/current/api/metadata_api/en-us/reference/metricdefinition_filter.doc.html), - orderBy: [MetricDefinitionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[MetricDefinition](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinition.doc.html)] - # Metric definitions downstream from this field. - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [MetricDefinition_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinition_filter.doc.html), - orderBy: [MetricDefinitionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [MetricDefinitionsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsconnection.doc.html) - # All upstream columns this field references - # - # 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. - upstreamColumns( - filter: [Column_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/column_filter.doc.html), - orderBy: [ColumnSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Column](https://help.tableau.com/current/api/metadata_api/en-us/reference/column.doc.html)]! - # All upstream columns this field references - # - # 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. - upstreamColumnsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Column_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/column_filter.doc.html), - orderBy: [ColumnSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [ColumnsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnsconnection.doc.html) - } ` ## [_link_](#require-by) Require by - [AnalyticsField_Base GraphQL type for a field containing analytics metadata_](https://help.tableau.com/current/api/metadata_api/en-us/reference/analyticsfield.doc.html "AnalyticsField - Base GraphQL type for a field containing analytics metadata") - [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/current/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/current/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") - [ColumnField_ColumnFields are a type of field which directly connects to a column in some type of table._](https://help.tableau.com/current/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/current/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/current/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") - [DataField_Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField._](https://help.tableau.com/current/api/metadata_api/en-us/reference/datafield.doc.html "DataField - Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField.") - [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/current/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.") - [DatasourceFieldsConnection_Connection Type for DatasourceField_](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefieldsconnection.doc.html "DatasourceFieldsConnection - Connection Type for DatasourceField") - [Field_Base GraphQL type for a field_](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [FieldReferencingField_Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula._](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield.doc.html "FieldReferencingField - Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula.") - [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/current/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/current/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") - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/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/current/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") _menu_ Types INPUT\_OBJECT # DatasourceField\_Filter Filter by GraphQL field and given value ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input DatasourceField_Filter { - # Name shown in server and desktop clients - name: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Name shown in server and desktop clients - nameWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.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/current/api/metadata_api/en-us/reference/id.doc.html) - # Unique identifier used by the metadata API. Not the same as the numeric ID used - # on server - idWithin: [[ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html)] - # True if the field is hidden - isHidden: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) - # True if the field is hidden - isHiddenWithin: [[Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html)] - # Filter the output based on text query. - text: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - } ` ## [_link_](#require-by) Require by - [AnalyticsField_Base GraphQL type for a field containing analytics metadata_](https://help.tableau.com/current/api/metadata_api/en-us/reference/analyticsfield.doc.html "AnalyticsField - Base GraphQL type for a field containing analytics metadata") - [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/current/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/current/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") - [ColumnField_ColumnFields are a type of field which directly connects to a column in some type of table._](https://help.tableau.com/current/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/current/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/current/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") - [DataField_Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField._](https://help.tableau.com/current/api/metadata_api/en-us/reference/datafield.doc.html "DataField - Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField.") - [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/current/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/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [FieldReferencingField_Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula._](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield.doc.html "FieldReferencingField - Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula.") - [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/current/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/current/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") - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/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/current/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") _menu_ Types INPUT\_OBJECT # DatasourceField\_Required\_Filter Filter by GraphQL field and given value ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input DatasourceField_Required_Filter { - # Name shown in server and desktop clients - name: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Name shown in server and desktop clients - nameWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.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/current/api/metadata_api/en-us/reference/id.doc.html) - # Unique identifier used by the metadata API. Not the same as the numeric ID used - # on server - idWithin: [[ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html)] - } ` ## [_link_](#require-by) Require by This element is not required by anyone _menu_ Types ENUM # DatasourceFieldOrderField Enum for fields that can be used for sorting ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - enum DatasourceFieldOrderField { - # Sort by downstreamSheets count - DOWNSTREAM_SHEETS_COUNT - # Sort by id - ID - # Sort by isHidden - IS_HIDDEN - # Sort by name - NAME - } ` ## [_link_](#require-by) Require by - [DatasourceFieldSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefieldsortorder.doc.html "DatasourceFieldSortOrder - 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.") _menu_ Types OBJECT # DatasourceFieldsConnection Connection Type for DatasourceField ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type DatasourceFieldsConnection { - # List of nodes - nodes: [[DatasourceField](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefield.doc.html)!]! - # Information for pagination - pageInfo: [PageInfo](https://help.tableau.com/current/api/metadata_api/en-us/reference/pageinfo.doc.html)! - # Total number of objects in connection - totalCount: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html)! - } ` ## [_link_](#require-by) Require by - [AnalyticsField_Base GraphQL type for a field containing analytics metadata_](https://help.tableau.com/current/api/metadata_api/en-us/reference/analyticsfield.doc.html "AnalyticsField - Base GraphQL type for a field containing analytics metadata") - [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/current/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/current/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") - [ColumnField_ColumnFields are a type of field which directly connects to a column in some type of table._](https://help.tableau.com/current/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/current/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/current/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") - [DataField_Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField._](https://help.tableau.com/current/api/metadata_api/en-us/reference/datafield.doc.html "DataField - Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField.") - [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/current/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/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [FieldReferencingField_Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula._](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield.doc.html "FieldReferencingField - Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula.") - [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/current/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/current/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") - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/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/current/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") _menu_ Types INPUT\_OBJECT # DatasourceFieldSortOrder 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. ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input DatasourceFieldSortOrder { - # GraphQL field to sort on - field: [DatasourceFieldOrderField](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefieldorderfield.doc.html)! - # Order direction to sort output - direction: [OrderDirection](https://help.tableau.com/current/api/metadata_api/en-us/reference/orderdirection.doc.html)! - } ` ## [_link_](#require-by) Require by - [AnalyticsField_Base GraphQL type for a field containing analytics metadata_](https://help.tableau.com/current/api/metadata_api/en-us/reference/analyticsfield.doc.html "AnalyticsField - Base GraphQL type for a field containing analytics metadata") - [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/current/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/current/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") - [ColumnField_ColumnFields are a type of field which directly connects to a column in some type of table._](https://help.tableau.com/current/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/current/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/current/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") - [DataField_Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField._](https://help.tableau.com/current/api/metadata_api/en-us/reference/datafield.doc.html "DataField - Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField.") - [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/current/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/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [FieldReferencingField_Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula._](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield.doc.html "FieldReferencingField - Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula.") - [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/current/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/current/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") - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/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/current/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") _menu_ Types OBJECT # DatasourceFilter Data source filters include/exclude certain values from a single field to filter out rows of data from this data source. For data security reasons, we don't track the values used in the filter in this schema, but you can see the field used in the filter. See [https://onlinehelp.tableau.com/current/pro/desktop/en-us/filtering\_datasource.html](https://onlinehelp.tableau.com/current/pro/desktop/en-us/filtering_datasource.html) ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type DatasourceFilter { - # Unique identifier used by the metadata API. Not the same as the numeric ID used - # on server - id: [ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html)! - # Field used by this filter. - field: [Field](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.doc.html)! - # Data source that contains this datasource filter - datasource: [Datasource](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasource.doc.html) - } ` ## [_link_](#require-by) Require by - [AnalyticsField_Base GraphQL type for a field containing analytics metadata_](https://help.tableau.com/current/api/metadata_api/en-us/reference/analyticsfield.doc.html "AnalyticsField - Base GraphQL type for a field containing analytics metadata") - [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/current/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/current/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") - [ColumnField_ColumnFields are a type of field which directly connects to a column in some type of table._](https://help.tableau.com/current/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/current/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/current/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") - [DataField_Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField._](https://help.tableau.com/current/api/metadata_api/en-us/reference/datafield.doc.html "DataField - Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField.") - [Datasource_Root GraphQL type for embedded and published data sources Data sources are a way to represent how Tableau Desktop and Tableau Server model and connect to data. Data sources can be published separately, as a published data source, or may be contained in a workbook as an embedded data source. See https://onlinehelp.tableau.com/current/server/en-us/datasource.htm_](datasource.doc.html "Datasource - Root GraphQL type for embedded and published data sources Data sources are a way to represent how Tableau Desktop and Tableau Server model and connect to data. Data sources can be published separately, as a published data source, or may be contained in a workbook as an embedded data source. See https://onlinehelp.tableau.com/current/server/en-us/datasource.htm") - [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/current/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.") - [DatasourceFiltersConnection_Connection Type for DatasourceFilter_](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefiltersconnection.doc.html "DatasourceFiltersConnection - Connection Type for DatasourceFilter") - [EmbeddedDatasource_A data source embedded in a workbook_](https://help.tableau.com/current/api/metadata_api/en-us/reference/embeddeddatasource.doc.html "EmbeddedDatasource - A data source embedded in a workbook") - [Field_Base GraphQL type for a field_](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [FieldReferencingField_Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula._](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield.doc.html "FieldReferencingField - Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula.") - [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/current/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/current/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") - [PublishedDatasource_A Tableau data source that has been published separately to Tableau Server. It can be used by multiple workbooks._](https://help.tableau.com/current/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/current/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/current/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") _menu_ Types INPUT\_OBJECT # DatasourceFilter\_Filter Filter by GraphQL field and given value ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input DatasourceFilter_Filter { - # Unique identifier used by the metadata API. Not the same as the numeric ID used - # on server - id: [ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html) - # Unique identifier used by the metadata API. Not the same as the numeric ID used - # on server - idWithin: [[ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html)] - } ` ## [_link_](#require-by) Require by - [AnalyticsField_Base GraphQL type for a field containing analytics metadata_](https://help.tableau.com/current/api/metadata_api/en-us/reference/analyticsfield.doc.html "AnalyticsField - Base GraphQL type for a field containing analytics metadata") - [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/current/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/current/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") - [ColumnField_ColumnFields are a type of field which directly connects to a column in some type of table._](https://help.tableau.com/current/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/current/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/current/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") - [DataField_Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField._](https://help.tableau.com/current/api/metadata_api/en-us/reference/datafield.doc.html "DataField - Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField.") - [Datasource_Root GraphQL type for embedded and published data sources Data sources are a way to represent how Tableau Desktop and Tableau Server model and connect to data. Data sources can be published separately, as a published data source, or may be contained in a workbook as an embedded data source. See https://onlinehelp.tableau.com/current/server/en-us/datasource.htm_](datasource.doc.html "Datasource - Root GraphQL type for embedded and published data sources Data sources are a way to represent how Tableau Desktop and Tableau Server model and connect to data. Data sources can be published separately, as a published data source, or may be contained in a workbook as an embedded data source. See https://onlinehelp.tableau.com/current/server/en-us/datasource.htm") - [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/current/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.") - [EmbeddedDatasource_A data source embedded in a workbook_](https://help.tableau.com/current/api/metadata_api/en-us/reference/embeddeddatasource.doc.html "EmbeddedDatasource - A data source embedded in a workbook") - [Field_Base GraphQL type for a field_](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [FieldReferencingField_Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula._](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield.doc.html "FieldReferencingField - Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula.") - [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/current/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/current/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") - [PublishedDatasource_A Tableau data source that has been published separately to Tableau Server. It can be used by multiple workbooks._](https://help.tableau.com/current/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/current/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/current/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") _menu_ Types ENUM # DatasourceFilterOrderField Enum for fields that can be used for sorting ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - enum DatasourceFilterOrderField { - # Sort by id - ID - } ` ## [_link_](#require-by) Require by - [DatasourceFilterSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefiltersortorder.doc.html "DatasourceFilterSortOrder - 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.") _menu_ Types OBJECT # DatasourceFiltersConnection Connection Type for DatasourceFilter ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type DatasourceFiltersConnection { - # List of nodes - nodes: [[DatasourceFilter](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefilter.doc.html)!]! - # Information for pagination - pageInfo: [PageInfo](https://help.tableau.com/current/api/metadata_api/en-us/reference/pageinfo.doc.html)! - # Total number of objects in connection - totalCount: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html)! - } ` ## [_link_](#require-by) Require by - [AnalyticsField_Base GraphQL type for a field containing analytics metadata_](https://help.tableau.com/current/api/metadata_api/en-us/reference/analyticsfield.doc.html "AnalyticsField - Base GraphQL type for a field containing analytics metadata") - [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/current/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/current/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") - [ColumnField_ColumnFields are a type of field which directly connects to a column in some type of table._](https://help.tableau.com/current/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/current/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/current/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") - [DataField_Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField._](https://help.tableau.com/current/api/metadata_api/en-us/reference/datafield.doc.html "DataField - Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField.") - [Datasource_Root GraphQL type for embedded and published data sources Data sources are a way to represent how Tableau Desktop and Tableau Server model and connect to data. Data sources can be published separately, as a published data source, or may be contained in a workbook as an embedded data source. See https://onlinehelp.tableau.com/current/server/en-us/datasource.htm_](datasource.doc.html "Datasource - Root GraphQL type for embedded and published data sources Data sources are a way to represent how Tableau Desktop and Tableau Server model and connect to data. Data sources can be published separately, as a published data source, or may be contained in a workbook as an embedded data source. See https://onlinehelp.tableau.com/current/server/en-us/datasource.htm") - [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/current/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.") - [EmbeddedDatasource_A data source embedded in a workbook_](https://help.tableau.com/current/api/metadata_api/en-us/reference/embeddeddatasource.doc.html "EmbeddedDatasource - A data source embedded in a workbook") - [Field_Base GraphQL type for a field_](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [FieldReferencingField_Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula._](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield.doc.html "FieldReferencingField - Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula.") - [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/current/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/current/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") - [PublishedDatasource_A Tableau data source that has been published separately to Tableau Server. It can be used by multiple workbooks._](https://help.tableau.com/current/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/current/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/current/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") _menu_ Types INPUT\_OBJECT # DatasourceFilterSortOrder 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. ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input DatasourceFilterSortOrder { - # GraphQL field to sort on - field: [DatasourceFilterOrderField](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefilterorderfield.doc.html)! - # Order direction to sort output - direction: [OrderDirection](https://help.tableau.com/current/api/metadata_api/en-us/reference/orderdirection.doc.html)! - } ` ## [_link_](#require-by) Require by - [AnalyticsField_Base GraphQL type for a field containing analytics metadata_](https://help.tableau.com/current/api/metadata_api/en-us/reference/analyticsfield.doc.html "AnalyticsField - Base GraphQL type for a field containing analytics metadata") - [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/current/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/current/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") - [ColumnField_ColumnFields are a type of field which directly connects to a column in some type of table._](https://help.tableau.com/current/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/current/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/current/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") - [DataField_Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField._](https://help.tableau.com/current/api/metadata_api/en-us/reference/datafield.doc.html "DataField - Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField.") - [Datasource_Root GraphQL type for embedded and published data sources Data sources are a way to represent how Tableau Desktop and Tableau Server model and connect to data. Data sources can be published separately, as a published data source, or may be contained in a workbook as an embedded data source. See https://onlinehelp.tableau.com/current/server/en-us/datasource.htm_](datasource.doc.html "Datasource - Root GraphQL type for embedded and published data sources Data sources are a way to represent how Tableau Desktop and Tableau Server model and connect to data. Data sources can be published separately, as a published data source, or may be contained in a workbook as an embedded data source. See https://onlinehelp.tableau.com/current/server/en-us/datasource.htm") - [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/current/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.") - [EmbeddedDatasource_A data source embedded in a workbook_](https://help.tableau.com/current/api/metadata_api/en-us/reference/embeddeddatasource.doc.html "EmbeddedDatasource - A data source embedded in a workbook") - [Field_Base GraphQL type for a field_](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [FieldReferencingField_Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula._](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield.doc.html "FieldReferencingField - Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula.") - [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/current/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/current/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") - [PublishedDatasource_A Tableau data source that has been published separately to Tableau Server. It can be used by multiple workbooks._](https://help.tableau.com/current/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/current/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/current/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") _menu_ Types ENUM # DatasourceOrderField Enum for fields that can be used for sorting ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - enum DatasourceOrderField { - # Sort by downstreamOwners count - DOWNSTREAM_OWNERS_COUNT - # Sort by downstreamWorkbooks count - DOWNSTREAM_WORKBOOKS_COUNT - # Sort by fields count - FIELDS_COUNT - # Sort by containsUnsupportedCustomSql - CONTAINS_UNSUPPORTED_CUSTOM_SQL - # Sort by id - ID - # Sort by name - NAME - } ` ## [_link_](#require-by) Require by - [DatasourceSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcesortorder.doc.html "DatasourceSortOrder - 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.") _menu_ Types OBJECT # DatasourcesConnection Connection Type for Datasource ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type DatasourcesConnection { - # List of nodes - nodes: [[Datasource](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasource.doc.html)!]! - # Information for pagination - pageInfo: [PageInfo](https://help.tableau.com/current/api/metadata_api/en-us/reference/pageinfo.doc.html)! - # Total number of objects in connection - totalCount: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html)! - } ` ## [_link_](#require-by) Require by - [Dashboard_A dashboard contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard.doc.html "Dashboard - A dashboard contained in a published workbook.") - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/api/metadata_api/en-us/reference/query.doc.html "Query - Query root for Metadata GraphQL interface") - [Sheet_A sheet contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html "Sheet - A sheet contained in a published workbook.") _menu_ Types INPUT\_OBJECT # DatasourceSortOrder 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. ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input DatasourceSortOrder { - # GraphQL field to sort on - field: [DatasourceOrderField](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourceorderfield.doc.html)! - # Order direction to sort output - direction: [OrderDirection](https://help.tableau.com/current/api/metadata_api/en-us/reference/orderdirection.doc.html)! - } ` ## [_link_](#require-by) Require by - [Dashboard_A dashboard contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard.doc.html "Dashboard - A dashboard contained in a published workbook.") - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/api/metadata_api/en-us/reference/query.doc.html "Query - Query root for Metadata GraphQL interface") - [Sheet_A sheet contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html "Sheet - A sheet contained in a published workbook.") _menu_ Types SCALAR # DateTime An RFC-3339 compliant DateTime Scalar ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - scalar DateTime ` ## [_link_](#require-by) Require by - [Dashboard_A dashboard contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard.doc.html "Dashboard - A dashboard contained in a published workbook.") - [DataQualityCertification_A data quality certification associated with a content item_](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitycertification.doc.html "DataQualityCertification - A data quality certification associated with a content item") - [DataQualityWarning_A data quality warning associated with a content item_](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarning.doc.html "DataQualityWarning - A data quality warning associated with a content item") - [Datasource_Root GraphQL type for embedded and published data sources Data sources are a way to represent how Tableau Desktop and Tableau Server model and connect to data. Data sources can be published separately, as a published data source, or may be contained in a workbook as an embedded data source. See https://onlinehelp.tableau.com/current/server/en-us/datasource.htm_](datasource.doc.html "Datasource - Root GraphQL type for embedded and published data sources Data sources are a way to represent how Tableau Desktop and Tableau Server model and connect to data. Data sources can be published separately, as a published data source, or may be contained in a workbook as an embedded data source. See https://onlinehelp.tableau.com/current/server/en-us/datasource.htm") - [EmbeddedDatasource_A data source embedded in a workbook_](https://help.tableau.com/current/api/metadata_api/en-us/reference/embeddeddatasource.doc.html "EmbeddedDatasource - A data source embedded in a workbook") - [Flow_Flows are used to prepare data, which can include aggregation, cleaning, preprocessing, etc._](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow.doc.html "Flow - Flows are used to prepare data, which can include aggregation, cleaning, preprocessing, etc.") - [GenericLabel_A label that can be attached to assets. \*Available in Tableau Cloud March 2023 / Server 2023.1 and later.\*_](genericlabel.doc.html "GenericLabel - A label that can be attached to assets. *Available in Tableau Cloud March 2023 / Server 2023.1 and later.*") - [Label_A label that can be attached to assets. \*Available in Tableau Cloud March 2023 / Server 2023.1 and later.\*_](label.doc.html "Label - A label that can be attached to assets. *Available in Tableau Cloud March 2023 / Server 2023.1 and later.*") - [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.*") - [Metric_Metrics are time series data constructed from fields contained in views. \*Retired in Tableau Cloud February 2024 / Server 2024.2.\*_](metric.doc.html "Metric - Metrics are time series data constructed from fields contained in views. *Retired in Tableau Cloud February 2024 / Server 2024.2.*") - [PublishedDatasource_A Tableau data source that has been published separately to Tableau Server. It can be used by multiple workbooks._](https://help.tableau.com/current/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.") - [Sheet_A sheet contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html "Sheet - A sheet contained in a published workbook.") - [TableauSite_Site on Tableau server_](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableausite.doc.html "TableauSite - Site on Tableau server") - [View_A view contained in a published workbook. Views can be sheets or dashboards._](https://help.tableau.com/current/api/metadata_api/en-us/reference/view.doc.html "View - A view contained in a published workbook. Views can be sheets or dashboards.") - [VirtualConnection_A virtual connection. \*Available in Tableau Cloud March 2022 / Server 2022.1 and later.\*_](virtualconnection.doc.html "VirtualConnection - A virtual connection. *Available in Tableau Cloud March 2022 / Server 2022.1 and later.*") - [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.*") - [VirtualConnectionTable\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html "VirtualConnectionTable_Filter - Filter by GraphQL field and given value") - [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/current/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).") _menu_ Types # deprecated Marks the field, argument, input field or enum value as deprecated ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - directive @deprecated(reason: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)) on FIELD_DEFINITION | ARGUMENT_DEFINITION | ENUM_VALUE | INPUT_FIELD_DEFINITION ` ## [_link_](#require-by) Require by This element is not required by anyone _menu_ Types OBJECT # EmbeddedDatasource A data source embedded in a workbook ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type EmbeddedDatasource implements [Datasource](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasource.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/current/api/metadata_api/en-us/reference/id.doc.html)! - # Name shown in server and desktop clients - name: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # True if data source contains a formula that involves a user function (for - # example, USERNAME or ISMEMBEROF) - hasUserReference: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) - # True if datasource contains extracted data - hasExtracts: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) - # True if the datasource contains unsupported custom SQL, in which case lineage - # may be incomplete - containsUnsupportedCustomSql: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) - # Time an extract was last fully refreshed - extractLastRefreshTime: [DateTime](https://help.tableau.com/current/api/metadata_api/en-us/reference/datetime.doc.html) - # Time an extract was last incrementally updated - extractLastIncrementalUpdateTime: [DateTime](https://help.tableau.com/current/api/metadata_api/en-us/reference/datetime.doc.html) - # Time an extract was last updated by either a full refresh, incremental update, - # or creation - extractLastUpdateTime: [DateTime](https://help.tableau.com/current/api/metadata_api/en-us/reference/datetime.doc.html) - # Fields, usually measures or dimensions, contained in the data source - # - # 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. - fields( - filter: [Field_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/field_filter.doc.html), - orderBy: [FieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Field](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.doc.html)!]! - # Fields, usually measures or dimensions, contained in the data source - # - # 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. - fieldsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Field_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/field_filter.doc.html), - orderBy: [FieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsconnection.doc.html) - # Data source filters contained in this data source - # - # 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. - datasourceFilters( - filter: [DatasourceFilter_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefilter_filter.doc.html), - orderBy: [DatasourceFilterSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefiltersortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DatasourceFilter](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefilter.doc.html)!]! - # Data source filters contained in this data source - # - # 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. - datasourceFiltersConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DatasourceFilter_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefilter_filter.doc.html), - orderBy: [DatasourceFilterSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefiltersortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatasourceFiltersConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefiltersconnection.doc.html) - # Sheets downstream from this data source - # - # 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/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Sheet](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html)!]! - # Sheets downstream from this data source - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Sheet_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [SheetsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsconnection.doc.html) - # Dashboards downstream from this data source - # - # 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/current/api/metadata_api/en-us/reference/dashboard_filter.doc.html), - orderBy: [DashboardSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboardsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Dashboard](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard.doc.html)!]! - # Dashboards downstream from this data source - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Dashboard_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard_filter.doc.html), - orderBy: [DashboardSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboardsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DashboardsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboardsconnection.doc.html) - # Workbooks downstream from this data source - # - # 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/current/api/metadata_api/en-us/reference/workbook_filter.doc.html), - orderBy: [WorkbookSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Workbook](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbook.doc.html)!]! - # Workbooks downstream from this data source - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Workbook_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbook_filter.doc.html), - orderBy: [WorkbookSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [WorkbooksConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksconnection.doc.html) - # Workbook owners downstream from this data source - # - # 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/current/api/metadata_api/en-us/reference/tableauuser_filter.doc.html), - orderBy: [TableauUserSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauusersortorder.doc.html) - ): [[TableauUser](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauuser.doc.html)!]! - # Workbook owners downstream from this data source - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [TableauUser_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauuser_filter.doc.html), - orderBy: [TableauUserSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauusersortorder.doc.html) - ): [TableauUsersConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauusersconnection.doc.html) - # Flows downstream from this data source - # - # 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/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Flow](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow.doc.html)!]! - # Flows downstream from this data source - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Flow_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FlowsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsconnection.doc.html) - # Tables upstream from this data source - # - # 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/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DatabaseTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable.doc.html)!]! - # Tables upstream from this data source - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabaseTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesconnection.doc.html) - # Databases upstream from this data source - # - # 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/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Database](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html)!]! - # Databases upstream from this data source - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Database_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabasesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesconnection.doc.html) - # Flows upstream from this data source - # - # 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/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Flow](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow.doc.html)!]! - # Flows upstream from this data source - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Flow_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FlowsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsconnection.doc.html) - # Datasources upstream from this data source - # - # 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/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[PublishedDatasource](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource.doc.html)!]! - # Datasources upstream from this data source - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [PublishedDatasource_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [PublishedDatasourcesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesconnection.doc.html) - # Parent published data sources of this embedded data source - # - # 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. - parentPublishedDatasources( - filter: [PublishedDatasource_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[PublishedDatasource](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource.doc.html)!]! - # Parent published data sources of this embedded data source - # - # 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. - parentPublishedDatasourcesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [PublishedDatasource_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [PublishedDatasourcesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesconnection.doc.html) - # Data quality warnings upstream from this data source - # - # 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/current/api/metadata_api/en-us/reference/dataqualitywarning_filter.doc.html), - orderBy: [DataQualityWarningSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarningsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DataQualityWarning](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarning.doc.html)!]! - # Data quality warnings upstream from this data source - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DataQualityWarning_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarning_filter.doc.html), - orderBy: [DataQualityWarningSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarningsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DataQualityWarningsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarningsconnection.doc.html) - # Labels upstream from this data source. 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/current/api/metadata_api/en-us/reference/label_filter.doc.html), - orderBy: [LabelSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/labelsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Label](https://help.tableau.com/current/api/metadata_api/en-us/reference/label.doc.html)!]! - # Labels upstream from this data source. 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Label_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/label_filter.doc.html), - orderBy: [LabelSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/labelsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [LabelsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/labelsconnection.doc.html) - # Time the datasource was created. Available in Tableau Cloud June 2022 / Server - # 2022.3 and later. - createdAt: [DateTime](https://help.tableau.com/current/api/metadata_api/en-us/reference/datetime.doc.html) - # Time the datasource was last updated. Available in Tableau Cloud June 2022 / - # Server 2022.3 and later. - updatedAt: [DateTime](https://help.tableau.com/current/api/metadata_api/en-us/reference/datetime.doc.html) - # Workbook that contains these embedded datasources - workbook: [Workbook](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbook.doc.html) - # The lenses derived from this datasource - # - # 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. - lenses( - filter: [Lens_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/lens_filter.doc.html), - orderBy: [LensSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/lenssortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Lens](https://help.tableau.com/current/api/metadata_api/en-us/reference/lens.doc.html)] - # The lenses derived from this datasource - # - # 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. - lensesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Lens_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/lens_filter.doc.html), - orderBy: [LensSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/lenssortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [LensesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensesconnection.doc.html) - } ` ## [_link_](#require-by) Require by - [EmbeddedDatasourcesConnection_Connection Type for EmbeddedDatasource_](https://help.tableau.com/current/api/metadata_api/en-us/reference/embeddeddatasourcesconnection.doc.html "EmbeddedDatasourcesConnection - Connection Type for EmbeddedDatasource") - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/api/metadata_api/en-us/reference/query.doc.html "Query - Query root for Metadata GraphQL interface") - [Sheet_A sheet contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html "Sheet - A sheet contained in a published workbook.") - [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/current/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).") _menu_ Types INPUT\_OBJECT # EmbeddedDatasource\_Filter Filter by GraphQL field and given value ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input EmbeddedDatasource_Filter { - # True if the datasource contains unsupported custom SQL, in which case lineage - # may be incomplete - containsUnsupportedCustomSql: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) - # True if the datasource contains unsupported custom SQL, in which case lineage - # may be incomplete - containsUnsupportedCustomSqlWithin: [[Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html)] - # Name shown in server and desktop clients - name: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Name shown in server and desktop clients - nameWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.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/current/api/metadata_api/en-us/reference/id.doc.html) - # Unique identifier used by the metadata API. Not the same as the numeric ID used - # on server - idWithin: [[ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html)] - } ` ## [_link_](#require-by) Require by - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/api/metadata_api/en-us/reference/query.doc.html "Query - Query root for Metadata GraphQL interface") - [Sheet_A sheet contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html "Sheet - A sheet contained in a published workbook.") - [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/current/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).") _menu_ Types ENUM # EmbeddedDatasourceOrderField Enum for fields that can be used for sorting ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - enum EmbeddedDatasourceOrderField { - # Sort by downstreamOwners count - DOWNSTREAM_OWNERS_COUNT - # Sort by downstreamWorkbooks count - DOWNSTREAM_WORKBOOKS_COUNT - # Sort by fields count - FIELDS_COUNT - # Sort by containsUnsupportedCustomSql - CONTAINS_UNSUPPORTED_CUSTOM_SQL - # Sort by id - ID - # Sort by name - NAME - } ` ## [_link_](#require-by) Require by - [EmbeddedDatasourceSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/embeddeddatasourcesortorder.doc.html "EmbeddedDatasourceSortOrder - 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.") _menu_ Types OBJECT # EmbeddedDatasourcesConnection Connection Type for EmbeddedDatasource ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type EmbeddedDatasourcesConnection { - # List of nodes - nodes: [[EmbeddedDatasource](https://help.tableau.com/current/api/metadata_api/en-us/reference/embeddeddatasource.doc.html)!]! - # Information for pagination - pageInfo: [PageInfo](https://help.tableau.com/current/api/metadata_api/en-us/reference/pageinfo.doc.html)! - # Total number of objects in connection - totalCount: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html)! - } ` ## [_link_](#require-by) Require by - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/api/metadata_api/en-us/reference/query.doc.html "Query - Query root for Metadata GraphQL interface") - [Sheet_A sheet contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html "Sheet - A sheet contained in a published workbook.") - [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/current/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).") _menu_ Types INPUT\_OBJECT # EmbeddedDatasourceSortOrder 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. ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input EmbeddedDatasourceSortOrder { - # GraphQL field to sort on - field: [EmbeddedDatasourceOrderField](https://help.tableau.com/current/api/metadata_api/en-us/reference/embeddeddatasourceorderfield.doc.html)! - # Order direction to sort output - direction: [OrderDirection](https://help.tableau.com/current/api/metadata_api/en-us/reference/orderdirection.doc.html)! - } ` ## [_link_](#require-by) Require by - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/api/metadata_api/en-us/reference/query.doc.html "Query - Query root for Metadata GraphQL interface") - [Sheet_A sheet contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html "Sheet - A sheet contained in a published workbook.") - [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/current/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).") # Example Queries **In this section** ## GraphQL basics If you’re new to GraphQL, check out the many resources to learn GraphQL. For example, [Introduction to GraphQL \[↗\]](https://graphql.org/learn). To get you started, here are some common GraphQL query-related concepts you should understand. #### Schema The GraphQL schema tells you what queries are allowed. The schema defines the objects, object types, and attributes that you can get from the Tableau Metadata API. #### Object The building block of a query is the object. Objects are a collection of data assets accessible from the Metadata API. Objects have object types and attributes. #### Queries GraphQL operations come in the form of queries. Queries are also objects, specifically root objects in GraphQL. However, queries are special objects because they define the entry point of every GraphQL query. For example, suppose you have the following GraphQL query: ``` query { hello } ``` The operation above begins with the required `query` root object. The object being requested is `hello`. The result of the query is: ``` "data": { "hello": "world" }, ``` As you can see, GraphQL returns data in a similar shape as the query itself. ## Common queries to get you started After identifying the data that you’re interested in, you can write a query to access the information. ### What types of database and table assets are used on my site? To answer what types of databases and tables are used on your site, you might use the following query: ``` query getDatabasesOnMySite{ databases { id name } } query getTablesTablesOnMySite{ tables { id name } } ``` Here, `databases` and `tables` are objects and `id` and `name` are attributes in the Metadata API that you can query. ### Find a table To find a specific table, such as the _Orders_ table, you can pass a filter parameter with a value of “Orders” through the `tables` object. Your query might look like the following: ``` query ShowMeOneTableCalledOrders{ tables (filter: {name: "Orders"}){ name columns { name } } } ``` Here, `tables` is the object and `name` and `columns` are attributes in the Metadata API that you can query. The filter parameter that you pass through the `table` object uses the format `(filter: {name: ""})`. ### Find a table in a workbook using query variables To find a specific table in a workbook using a dynamic value instead of a static value in the filter parameter, you can use a query variable. A query variable is value that you can define outside of the query so that it can be changed dynamically. This query variable is a second object that’s passed through the same query. The query variable uses the following formats depending on where the query variable is being used: - When defining the variable name: `variableName: ` - Declaring the variable in the query: `{name: $variableName}` For example, suppose you want to use a query variable to find the _Sample\_Superstore_ workbook. You might use the following query, where the query variable is “$workbookname” and the value for the variable in this example is “Sample\_Superstore”. ``` query ShowMeAnyTable($workbookName: String, $sheetName: String){ workbooks(filter: {name: $workbookName}){ name embeddedDataSources { fields { name ...on CalculatedField { formula } } } sheets(filter: {name: $sheetName}){ name worksheetFields { name formula } } } } ``` ### Filtering A filter sorts through and retrieves only the data that meets a set of specified criteria. For example, suppose you’re looking for a published data source named “Orders.” You might use the following query to find information about the published data source: ``` query FilteredQuery { publishedDatasources(filter: {name: "Orders"}) { name hasExtracts upstreamTables } } ``` Here, the filter parameter that you pass through the `publishedDataSources` object uses the format `(filter: {name: ""})`. Suppose you’re looking for multiple published data sources, “Orders” and “Education.” You might use the following query to find information about these published data sources: ``` query FilteredWithinQuery { publishedDatasources(filter: {nameWithin: ["Orders", "Education"]}) { name hasExtracts upstreamTables } } ``` To filter for multiple published data sources, the filter parameter that you pass through the `publishedDataSources` object uses the format `(filter: {namewithin: ["", ""]})`. ### Pagination Pagination enables you to traverse through relationships among the data that you’re querying. The Metadata API defines pagination objects as those that have “Connection” appended to it. There are two common methods for pagination that these objects can support: offset and cursors. The maximum page size using either method is 1,000 items. #### Paginate using offset method Using the offset method, you can specify the number of items you want and where to start counting the items you want retrieved. This method allows for larger queries. However, it also might affect performance of the query as the query gets larger. For example, suppose you want to retrieve data about published data sources. In the `publishedDataSourcesConnections` object parameter you can specify the number of items you want using “first” and where to start counting the items you want retrieved using “offset”. The following query gives you the **_first_** ten items. ``` query PaginatedQueryOffsetPage1 { publishedDatasourcesConnection(first: 10, offset: 0) { nodes { name } } } ``` Here, the pagination format you can use for offset is `(first: , offset: )`. The following query gives you the **_next_** ten items, for a total of 20 items. ``` query PaginatedQueryOffsetPage2 { publishedDatasourcesConnection(first: 10, offset: 10) { nodes { name } } } ``` #### Paginate using cursor method Using cursors, you can retrieve data by specifying the page size and then using a “cursor” to keep track of where the next set of data should be retrieved from. This method is faster than the offset method when you need return results for large lists. For example, suppose you want to retrieve data about published data sources. In the publishedDataSourcesConnection object parameter, you can specify the number of items you want using “first”. Then, instead of counting pages using “offset” like in the offset method, you pass in “after” when using the cursor method, which is a value that is returned by the pageInfo attribute in the publishedDataSourcesConnection object. ``` query PaginatedQueryCursorPage1 { publishedDatasourcesConnection(first: 10, orderBy: {field: NAME, direction: ASC}) { nodes { name } pageInfo { hasNextPage endCursor } } } ``` **Notes:** - hasNextPage is only true if there are more pages after given OrderBy and first parameters. - endCursor should be saved and passed to the query for page two. When you include “after” in the parameter, the value of the “endCursor” is passed into a subsequent query. ``` query PaginatedQueryCursorPage2 { publishedDatasourcesConnection(first: 10, after: null, orderBy: {field: NAME, direction: ASC}) { nodes { name } pageInfo { hasNextPage endCursor } } } ``` ### Inheritance When querying fields, you can include a description inheritance object, `descriptionInherited`, in your query to return information about the closest upstream object where the description is inherited from. Including this description inheritance object in your query can be useful for providing supplemental description information associated with upstream objects. The following query returns description attribute information for fields in all data sources that are associated with the specified table. ``` query whereIsThisDescriptionComingFrom { databaseTables(filter: {id: "57a8c84f-0671-4df5-964b-774fc68968b1"}) { downstreamDatasources { fields { description descriptionInherited { value asset { id __typename } } } } } } ``` ### Permissions There are two permission modes available in the Metadata API: - Obfuscate - Filter #### Obfuscate mode If you do not specify a permissions mode in a query, the default permission mode, obfuscate, is applied. Obfuscate returns all results, but will hide any sensitive attributes on external assets that you do not have permissions to see. For more information, see [Access Metadata about Related Asset](/current/api/metadata_api/en-us/docs/meta_api_permissions.html#access-metadata-about-related-assets-lineage) section of the How Permissions Work topic. You can explicitly specify the obfuscate permissions mode by passing the permissions mode parameter through the object using the format `(permissionMode: OBFUSCATE_RESULTS)` like in the example below. ``` query ObfuscatePermissionsQuery { databases(permissionMode: OBFUSCATE_RESULTS) { tables{ downstreamDatasources{ name } } } } ``` In the example query above, although you might not have permissions to all the databases, the obfuscate permissions mode returns all the related data sources that you have permissions to see. #### Filter mode If you specify the filter permissions mode, only the results whose attributes of external assets you have permissions to see are returned. You can specify the filter permissions mode by passing the permissions mode parameter through the object using the format `(permissionMode: FILTER_RESULTS)` like in the example below. ``` query FilteredPermissionsQuery { databases(permissionMode: FILTER_RESULTS) { tables{ downstreamDatasources{ name } } } } ``` In the example query above, because you might not have permissions to all the database, the filter permissions mode returns only the data sources that are related to the databases and tables that you have permissions to see. This means, a query like this might omit data sources that you might have permissions to see. ### Linked flows You can use linked flow objects in a query to return information about which flows are directly upstream or downstream of one another. The following query returns all the downstream flow objects that have a relationship to Flow1. ``` query flows { flows (filter: {name: "Flow1"}){ name downstreamLinkedFlows{ asset{ name id } toEdges fromEdges } } } ``` For more information about linked flow objects, see [Working with linked flow objects](/current/api/metadata_api/en-us/docs/meta_api_model.html#linkedtasks_flows). _menu_ Types ENUM # ExtractType Possible types of extract ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - enum ExtractType { - INCREMENTAL - FULL - } ` ## [_link_](#require-by) Require by - [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.*") _menu_ Types INPUT\_OBJECT # ExtractType\_Filter Filter by GraphQL field and given value ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input ExtractType_Filter { - # Unique Identifier of object to retrieve - id: [ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html) - # Unique Identifier of object to retrieve - idWithin: [[ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html)] - } ` ## [_link_](#require-by) Require by This element is not required by anyone _menu_ Types INTERFACE # Field Base GraphQL type for a field ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - interface Field { - # Unique identifier used by the metadata API. Not the same as the numeric ID used - # on server - id: [ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html)! - # Name shown in server - name: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Name internally used to uniquely identify fields - fullyQualifiedName: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Description of field shown in server and desktop clients - description: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # description that is shown in the Tableau UI - # - # Arguments - # **inheritanceType**: Method for selecting inherited value - # **permissionMode**: Option to select how to apply permissions. By - # default it is OBFUSCATE_RESULTS - descriptionInherited( - inheritanceType: [InheritanceType](https://help.tableau.com/current/api/metadata_api/en-us/reference/inheritancetype.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[InheritedStringResult](https://help.tableau.com/current/api/metadata_api/en-us/reference/inheritedstringresult.doc.html)] - # True if the field is hidden - isHidden: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) - # Name of folder if the field is in a folder. See - # https://onlinehelp.tableau.com/current/pro/desktop/en-us/datafields_dwfeatures.html#Organize - folderName: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Databases connected upstream from the field - # - # 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/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Database](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html)!]! - # Databases connected upstream from the field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Database_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabasesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesconnection.doc.html) - # Tables connected upstream from the field - # - # 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/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DatabaseTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable.doc.html)!]! - # Tables connected upstream from the field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabaseTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesconnection.doc.html) - # Virtual connection tables upstream of this field - # - # 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/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnectionTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable.doc.html)!]! - # Virtual connection tables upstream of this field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnectionTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesconnection.doc.html) - # Virtual connections upstream of this field - # - # 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. - upstreamVirtualConnections( - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection.doc.html)!]! - # Virtual connections upstream of this field - # - # 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. - upstreamVirtualConnectionsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsconnection.doc.html) - # Flows connected upstream from the field - # - # 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/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Flow](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow.doc.html)!]! - # Flows connected upstream from the field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Flow_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FlowsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsconnection.doc.html) - # Datasources upstream of this field - # - # 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/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[PublishedDatasource](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource.doc.html)!]! - # Datasources upstream of this field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [PublishedDatasource_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [PublishedDatasourcesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesconnection.doc.html) - # Columns downstream of this field - # - # 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. - downstreamColumns( - filter: [Column_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/column_filter.doc.html), - orderBy: [ColumnSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Column](https://help.tableau.com/current/api/metadata_api/en-us/reference/column.doc.html)!]! - # Columns downstream of this field - # - # 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. - downstreamColumnsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Column_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/column_filter.doc.html), - orderBy: [ColumnSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [ColumnsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnsconnection.doc.html) - # Tables downstream of this field - # - # 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. - downstreamTables( - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DatabaseTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable.doc.html)!]! - # Tables downstream of this field - # - # 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. - downstreamTablesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabaseTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesconnection.doc.html) - # Virtual connection tables downstream of this field - # - # 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/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnectionTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable.doc.html)!]! - # Virtual connection tables downstream of this field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnectionTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesconnection.doc.html) - # Virtual connections downstream of this field - # - # 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. - downstreamVirtualConnections( - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection.doc.html)!]! - # Virtual connections downstream of this field - # - # 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. - downstreamVirtualConnectionsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsconnection.doc.html) - # Databases downstream of this field - # - # 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. - downstreamDatabases( - filter: [Database_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Database](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html)!]! - # Databases downstream of this field - # - # 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. - downstreamDatabasesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Database_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabasesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesconnection.doc.html) - # Flows downstream of this field - # - # 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/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Flow](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow.doc.html)!]! - # Flows downstream of this field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Flow_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FlowsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsconnection.doc.html) - # Downstream fields that reference this field - # - # 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. - downstreamFields( - filter: [Field_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/field_filter.doc.html), - orderBy: [FieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Field](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.doc.html)!]! - # Downstream fields that reference this field - # - # 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. - downstreamFieldsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Field_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/field_filter.doc.html), - orderBy: [FieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsconnection.doc.html) - # Datasources connected downstream from this field - # - # 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/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[PublishedDatasource](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource.doc.html)!] - # Datasources connected downstream from this field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [PublishedDatasource_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [PublishedDatasourcesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesconnection.doc.html) - # Lenses connected downstream from this field - # - # 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/current/api/metadata_api/en-us/reference/lens_filter.doc.html), - orderBy: [LensSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/lenssortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Lens](https://help.tableau.com/current/api/metadata_api/en-us/reference/lens.doc.html)!] - # Lenses connected downstream from this field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Lens_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/lens_filter.doc.html), - orderBy: [LensSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/lenssortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [LensesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensesconnection.doc.html) - # Sheets connected downstream from the field - # - # 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/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Sheet](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html)!]! - # Sheets connected downstream from the field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Sheet_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [SheetsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsconnection.doc.html) - # Dashboards connected downstream from the field - # - # 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/current/api/metadata_api/en-us/reference/dashboard_filter.doc.html), - orderBy: [DashboardSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboardsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Dashboard](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard.doc.html)!]! - # Dashboards connected downstream from the field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Dashboard_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard_filter.doc.html), - orderBy: [DashboardSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboardsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DashboardsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboardsconnection.doc.html) - # Workbooks connected downstream from the field - # - # 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/current/api/metadata_api/en-us/reference/workbook_filter.doc.html), - orderBy: [WorkbookSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Workbook](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbook.doc.html)!] - # Workbooks connected downstream from the field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Workbook_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbook_filter.doc.html), - orderBy: [WorkbookSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [WorkbooksConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksconnection.doc.html) - # Metrics connected downstream from the field - # - # 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/current/api/metadata_api/en-us/reference/metric_filter.doc.html), - orderBy: [MetricSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Metric](https://help.tableau.com/current/api/metadata_api/en-us/reference/metric.doc.html)!] - # Metrics connected downstream from the field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Metric_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metric_filter.doc.html), - orderBy: [MetricSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [MetricsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricsconnection.doc.html) - # Workbook owners (authors) connected downstream from the field - # - # 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/current/api/metadata_api/en-us/reference/tableauuser_filter.doc.html), - orderBy: [TableauUserSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauusersortorder.doc.html) - ): [[TableauUser](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauuser.doc.html)!] - # Workbook owners (authors) connected downstream from the field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [TableauUser_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauuser_filter.doc.html), - orderBy: [TableauUserSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauusersortorder.doc.html) - ): [TableauUsersConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauusersconnection.doc.html) - # The field that references this field - # - # 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. - referencedByFields( - filter: [FieldReferencingField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield_filter.doc.html), - orderBy: [FieldReferencingFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[FieldReferencingField](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield.doc.html)] - # The field that references this field - # - # 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. - referencedByFieldsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [FieldReferencingField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield_filter.doc.html), - orderBy: [FieldReferencingFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FieldReferencingFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfieldsconnection.doc.html) - # Data source that contains this field - datasource: [Datasource](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasource.doc.html) - # Metric definitions that reference this data source field. - # - # 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. - metricDefinitions( - filter: [MetricDefinition_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinition_filter.doc.html), - orderBy: [MetricDefinitionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[MetricDefinition](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinition.doc.html)] - # Metric definitions that reference this data source field. - # - # 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. - metricDefinitionsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [MetricDefinition_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinition_filter.doc.html), - orderBy: [MetricDefinitionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [MetricDefinitionsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsconnection.doc.html) - # The data source filters that include this field - # - # 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. - referencedByFilters( - filter: [DatasourceFilter_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefilter_filter.doc.html), - orderBy: [DatasourceFilterSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefiltersortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DatasourceFilter](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefilter.doc.html)] - # The data source filters that include this field - # - # 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. - referencedByFiltersConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DatasourceFilter_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefilter_filter.doc.html), - orderBy: [DatasourceFilterSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefiltersortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatasourceFiltersConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefiltersconnection.doc.html) - # The bin field that references this field - # - # 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. - referencedByBins( - filter: [BinField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/binfield_filter.doc.html), - orderBy: [BinFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/binfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[BinField](https://help.tableau.com/current/api/metadata_api/en-us/reference/binfield.doc.html)] - # The bin field that references this field - # - # 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. - referencedByBinsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [BinField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/binfield_filter.doc.html), - orderBy: [BinFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/binfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [BinFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/binfieldsconnection.doc.html) - # The calculated field that references this field - # - # 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. - referencedByCalculations( - filter: [CalculatedField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/calculatedfield_filter.doc.html), - orderBy: [CalculatedFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/calculatedfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[CalculatedField](https://help.tableau.com/current/api/metadata_api/en-us/reference/calculatedfield.doc.html)] - # The calculated field that references this field - # - # 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. - referencedByCalculationsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [CalculatedField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/calculatedfield_filter.doc.html), - orderBy: [CalculatedFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/calculatedfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [CalculatedFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/calculatedfieldsconnection.doc.html) - # The combined field that references this field - # - # 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. - referencedByCombinedFields( - filter: [CombinedField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedfield_filter.doc.html), - orderBy: [CombinedFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[CombinedField](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedfield.doc.html)] - # The combined field that references this field - # - # 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. - referencedByCombinedFieldsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [CombinedField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedfield_filter.doc.html), - orderBy: [CombinedFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [CombinedFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedfieldsconnection.doc.html) - # Thie combined set field that references this field - # - # 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. - referencedByCombinedSets( - filter: [CombinedSetField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedsetfield_filter.doc.html), - orderBy: [CombinedSetFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedsetfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[CombinedSetField](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedsetfield.doc.html)] - # Thie combined set field that references this field - # - # 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. - referencedByCombinedSetsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [CombinedSetField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedsetfield_filter.doc.html), - orderBy: [CombinedSetFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedsetfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [CombinedSetFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedsetfieldsconnection.doc.html) - # The field that references this remote field - # - # 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. - referencedByRemoteFields( - filter: [DatasourceField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefield_filter.doc.html), - orderBy: [DatasourceFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DatasourceField](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefield.doc.html)] - # The field that references this remote field - # - # 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. - referencedByRemoteFieldsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DatasourceField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefield_filter.doc.html), - orderBy: [DatasourceFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatasourceFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefieldsconnection.doc.html) - # The group field that references this field - # - # 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. - referencedByGroups( - filter: [GroupField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/groupfield_filter.doc.html), - orderBy: [GroupFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/groupfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[GroupField](https://help.tableau.com/current/api/metadata_api/en-us/reference/groupfield.doc.html)] - # The group field that references this field - # - # 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. - referencedByGroupsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [GroupField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/groupfield_filter.doc.html), - orderBy: [GroupFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/groupfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [GroupFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/groupfieldsconnection.doc.html) - # The set field that this field references - # - # 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. - referencedBySets( - filter: [SetField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/setfield_filter.doc.html), - orderBy: [SetFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/setfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[SetField](https://help.tableau.com/current/api/metadata_api/en-us/reference/setfield.doc.html)] - # The set field that this field references - # - # 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. - referencedBySetsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [SetField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/setfield_filter.doc.html), - orderBy: [SetFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/setfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [SetFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/setfieldsconnection.doc.html) - # The hierarchy field that references this field - # - # 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. - referencedByHierarchies( - filter: [HierarchyField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/hierarchyfield_filter.doc.html), - orderBy: [HierarchyFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/hierarchyfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[HierarchyField](https://help.tableau.com/current/api/metadata_api/en-us/reference/hierarchyfield.doc.html)] - # The hierarchy field that references this field - # - # 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. - referencedByHierarchiesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [HierarchyField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/hierarchyfield_filter.doc.html), - orderBy: [HierarchyFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/hierarchyfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [HierarchyFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/hierarchyfieldsconnection.doc.html) - # Sheets that reference this data source field - # - # 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. - sheets( - filter: [Sheet_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Sheet](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html)] - # Sheets that reference this data source field - # - # 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. - sheetsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Sheet_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [SheetsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsconnection.doc.html) - # Sheets that reference this field - # - # 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. - directSheets( - filter: [Sheet_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Sheet](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html)] - # Sheets that reference this field - # - # 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. - directSheetsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Sheet_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [SheetsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsconnection.doc.html) - # List of lens fields which are derived from this field - # - # 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. - derivedLensFields( - filter: [LensField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensfield_filter.doc.html), - orderBy: [LensFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[LensField](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensfield.doc.html)] - # List of lens fields which are derived from this field - # - # 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. - derivedLensFieldsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [LensField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensfield_filter.doc.html), - orderBy: [LensFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [LensFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensfieldsconnection.doc.html) - # A flow input field that wraps this field - # - # 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. - referencedByFlowFieldInputField( - filter: [FlowFieldInputField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfield_filter.doc.html), - orderBy: [FlowFieldInputFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfieldsortorder.doc.html) - ): [[FlowFieldInputField](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfield.doc.html)] - # A flow input field that wraps this field - # - # 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. - referencedByFlowFieldInputFieldConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [FlowFieldInputField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfield_filter.doc.html), - orderBy: [FlowFieldInputFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfieldsortorder.doc.html) - ): [FlowFieldInputFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfieldsconnection.doc.html) - # A flow output field that wraps this field - # - # 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. - referencedByFlowFieldOutputField( - filter: [FlowFieldOutputField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfield_filter.doc.html), - orderBy: [FlowFieldOutputFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[FlowFieldOutputField](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfield.doc.html)] - # A flow output field that wraps this field - # - # 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. - referencedByFlowFieldOutputFieldConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [FlowFieldOutputField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfield_filter.doc.html), - orderBy: [FlowFieldOutputFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FlowFieldOutputFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfieldsconnection.doc.html) - # fields that are upstream of this field - # - # 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. - upstreamFields( - filter: [Field_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/field_filter.doc.html), - orderBy: [FieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Field](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.doc.html)]! - # fields that are upstream of this field - # - # 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. - upstreamFieldsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Field_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/field_filter.doc.html), - orderBy: [FieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsconnection.doc.html) - # Metric definitions downstream from this field. - # - # 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/current/api/metadata_api/en-us/reference/metricdefinition_filter.doc.html), - orderBy: [MetricDefinitionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[MetricDefinition](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinition.doc.html)] - # Metric definitions downstream from this field. - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [MetricDefinition_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinition_filter.doc.html), - orderBy: [MetricDefinitionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [MetricDefinitionsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsconnection.doc.html) - # All upstream columns this field references - # - # 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. - upstreamColumns( - filter: [Column_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/column_filter.doc.html), - orderBy: [ColumnSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Column](https://help.tableau.com/current/api/metadata_api/en-us/reference/column.doc.html)]! - # All upstream columns this field references - # - # 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. - upstreamColumnsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Column_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/column_filter.doc.html), - orderBy: [ColumnSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [ColumnsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnsconnection.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/current/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/current/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") - [Column_GraphQL type for a table column_](https://help.tableau.com/current/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/current/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/current/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/current/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") - [Dashboard_A dashboard contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard.doc.html "Dashboard - A dashboard contained in a published workbook.") - [Datasource_Root GraphQL type for embedded and published data sources Data sources are a way to represent how Tableau Desktop and Tableau Server model and connect to data. Data sources can be published separately, as a published data source, or may be contained in a workbook as an embedded data source. See https://onlinehelp.tableau.com/current/server/en-us/datasource.htm_](datasource.doc.html "Datasource - Root GraphQL type for embedded and published data sources Data sources are a way to represent how Tableau Desktop and Tableau Server model and connect to data. Data sources can be published separately, as a published data source, or may be contained in a workbook as an embedded data source. See https://onlinehelp.tableau.com/current/server/en-us/datasource.htm") - [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/current/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.") - [DatasourceFilter_Data source filters include/exclude certain values from a single field to filter out rows of data from this data source. For data security reasons, we don't track the values used in the filter in this schema, but you can see the field used in the filter. See https://onlinehelp.tableau.com/current/pro/desktop/en-us/filtering\_datasource.html_](datasourcefilter.doc.html "DatasourceFilter - Data source filters include/exclude certain values from a single field to filter out rows of data from this data source. For data security reasons, we don't track the values used in the filter in this schema, but you can see the field used in the filter. See https://onlinehelp.tableau.com/current/pro/desktop/en-us/filtering_datasource.html") - [EmbeddedDatasource_A data source embedded in a workbook_](https://help.tableau.com/current/api/metadata_api/en-us/reference/embeddeddatasource.doc.html "EmbeddedDatasource - A data source embedded in a workbook") - [Field_Base GraphQL type for a field_](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [FieldReferencingField_Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula._](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield.doc.html "FieldReferencingField - Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula.") - [FieldsConnection_Connection Type for Field_](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsconnection.doc.html "FieldsConnection - Connection Type for Field") - [FlowFieldInputField_Field input field implementation_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfield.doc.html "FlowFieldInputField - Field input field implementation") - [FlowFieldOutputField_Field output field implementation_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfield.doc.html "FlowFieldOutputField - Field output field implementation") - [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/current/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/current/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.*") - [LensField_Lens Fields contain extra information based on an underlying datasource field_](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensfield.doc.html "LensField - Lens Fields contain extra information based on an underlying datasource field") - [Metric_Metrics are time series data constructed from fields contained in views. \*Retired in Tableau Cloud February 2024 / Server 2024.2.\*_](metric.doc.html "Metric - Metrics are time series data constructed from fields contained in views. *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/current/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/current/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/current/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") - [Sheet_A sheet contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html "Sheet - A sheet contained in a published workbook.") _menu_ Types INPUT\_OBJECT # Field\_Filter Filter by GraphQL field and given value ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input Field_Filter { - # Name shown in server - name: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Name shown in server - nameWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.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/current/api/metadata_api/en-us/reference/id.doc.html) - # Unique identifier used by the metadata API. Not the same as the numeric ID used - # on server - idWithin: [[ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html)] - # True if the field is hidden - isHidden: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) - # True if the field is hidden - isHiddenWithin: [[Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html)] - # Filter the output based on text query. - text: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.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/current/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/current/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") - [Column_GraphQL type for a table column_](https://help.tableau.com/current/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/current/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/current/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/current/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") - [Dashboard_A dashboard contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard.doc.html "Dashboard - A dashboard contained in a published workbook.") - [Datasource_Root GraphQL type for embedded and published data sources Data sources are a way to represent how Tableau Desktop and Tableau Server model and connect to data. Data sources can be published separately, as a published data source, or may be contained in a workbook as an embedded data source. See https://onlinehelp.tableau.com/current/server/en-us/datasource.htm_](datasource.doc.html "Datasource - Root GraphQL type for embedded and published data sources Data sources are a way to represent how Tableau Desktop and Tableau Server model and connect to data. Data sources can be published separately, as a published data source, or may be contained in a workbook as an embedded data source. See https://onlinehelp.tableau.com/current/server/en-us/datasource.htm") - [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/current/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.") - [EmbeddedDatasource_A data source embedded in a workbook_](https://help.tableau.com/current/api/metadata_api/en-us/reference/embeddeddatasource.doc.html "EmbeddedDatasource - A data source embedded in a workbook") - [Field_Base GraphQL type for a field_](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [FieldReferencingField_Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula._](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield.doc.html "FieldReferencingField - Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula.") - [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/current/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/current/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.*") - [Metric_Metrics are time series data constructed from fields contained in views. \*Retired in Tableau Cloud February 2024 / Server 2024.2.\*_](metric.doc.html "Metric - Metrics are time series data constructed from fields contained in views. *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/current/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/current/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/current/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") - [Sheet_A sheet contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html "Sheet - A sheet contained in a published workbook.") _menu_ Types INPUT\_OBJECT # Field\_Required\_Filter Filter by GraphQL field and given value ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input Field_Required_Filter { - # Name shown in server - name: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Name shown in server - nameWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.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/current/api/metadata_api/en-us/reference/id.doc.html) - # Unique identifier used by the metadata API. Not the same as the numeric ID used - # on server - idWithin: [[ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html)] - } ` ## [_link_](#require-by) Require by This element is not required by anyone _menu_ Types ENUM # FieldDataType Possible data types for a field. ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - enum FieldDataType { - INTEGER - REAL - STRING - DATETIME - DATE - TUPLE - SPATIAL - BOOLEAN - TABLE - UNKNOWN - } ` ## [_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/current/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/current/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") - [ColumnField_ColumnFields are a type of field which directly connects to a column in some type of table._](https://help.tableau.com/current/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.") - [DataField_Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField._](https://help.tableau.com/current/api/metadata_api/en-us/reference/datafield.doc.html "DataField - Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField.") - [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/current/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") _menu_ Types INPUT\_OBJECT # FieldDataType\_Filter Filter by GraphQL field and given value ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input FieldDataType_Filter { - # Unique Identifier of object to retrieve - id: [ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html) - # Unique Identifier of object to retrieve - idWithin: [[ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html)] - } ` ## [_link_](#require-by) Require by This element is not required by anyone _menu_ Types ENUM # FieldOrderField Enum for fields that can be used for sorting ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - enum FieldOrderField { - # Sort by downstreamSheets count - DOWNSTREAM_SHEETS_COUNT - # Sort by id - ID - # Sort by isHidden - IS_HIDDEN - # Sort by name - NAME - } ` ## [_link_](#require-by) Require by - [FieldSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsortorder.doc.html "FieldSortOrder - 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.") _menu_ Types INTERFACE # FieldReferencingField Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula. ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - interface FieldReferencingField { - # Unique identifier used by the metadata API. Not the same as the numeric ID used - # on server - id: [ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html)! - # Name internally used to uniquely identify fields - fullyQualifiedName: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Fields referenced by this field - # - # 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. - fields( - filter: [Field_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/field_filter.doc.html), - orderBy: [FieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Field](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.doc.html)!]! - # Fields referenced by this field - # - # 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. - fieldsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Field_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/field_filter.doc.html), - orderBy: [FieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsconnection.doc.html) - # Tables connected upstream from the field - # - # 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/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DatabaseTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable.doc.html)!]! - # Tables connected upstream from the field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabaseTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesconnection.doc.html) - # Databases connected upstream from the field - # - # 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/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Database](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html)!]! - # Databases connected upstream from the field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Database_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabasesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesconnection.doc.html) - # Flows connected upstream from the field - # - # 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/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Flow](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow.doc.html)!]! - # Flows connected upstream from the field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Flow_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FlowsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsconnection.doc.html) - # The bin field that references this field - # - # 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. - referencedByBins( - filter: [BinField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/binfield_filter.doc.html), - orderBy: [BinFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/binfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[BinField](https://help.tableau.com/current/api/metadata_api/en-us/reference/binfield.doc.html)] - # The bin field that references this field - # - # 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. - referencedByBinsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [BinField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/binfield_filter.doc.html), - orderBy: [BinFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/binfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [BinFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/binfieldsconnection.doc.html) - # Sheets that reference this field - # - # 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. - directSheets( - filter: [Sheet_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Sheet](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html)] - # Sheets that reference this field - # - # 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. - directSheetsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Sheet_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [SheetsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsconnection.doc.html) - # The set field that this field references - # - # 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. - referencedBySets( - filter: [SetField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/setfield_filter.doc.html), - orderBy: [SetFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/setfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[SetField](https://help.tableau.com/current/api/metadata_api/en-us/reference/setfield.doc.html)] - # The set field that this field references - # - # 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. - referencedBySetsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [SetField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/setfield_filter.doc.html), - orderBy: [SetFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/setfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [SetFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/setfieldsconnection.doc.html) - # The field that references this remote field - # - # 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. - referencedByRemoteFields( - filter: [DatasourceField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefield_filter.doc.html), - orderBy: [DatasourceFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DatasourceField](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefield.doc.html)] - # The field that references this remote field - # - # 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. - referencedByRemoteFieldsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DatasourceField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefield_filter.doc.html), - orderBy: [DatasourceFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatasourceFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefieldsconnection.doc.html) - # The hierarchy field that references this field - # - # 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. - referencedByHierarchies( - filter: [HierarchyField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/hierarchyfield_filter.doc.html), - orderBy: [HierarchyFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/hierarchyfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[HierarchyField](https://help.tableau.com/current/api/metadata_api/en-us/reference/hierarchyfield.doc.html)] - # The hierarchy field that references this field - # - # 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. - referencedByHierarchiesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [HierarchyField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/hierarchyfield_filter.doc.html), - orderBy: [HierarchyFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/hierarchyfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [HierarchyFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/hierarchyfieldsconnection.doc.html) - # The field that references this field - # - # 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. - referencedByFields( - filter: [FieldReferencingField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield_filter.doc.html), - orderBy: [FieldReferencingFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[FieldReferencingField](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield.doc.html)] - # The field that references this field - # - # 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. - referencedByFieldsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [FieldReferencingField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield_filter.doc.html), - orderBy: [FieldReferencingFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FieldReferencingFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfieldsconnection.doc.html) - # The data source filters that include this field - # - # 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. - referencedByFilters( - filter: [DatasourceFilter_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefilter_filter.doc.html), - orderBy: [DatasourceFilterSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefiltersortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DatasourceFilter](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefilter.doc.html)] - # The data source filters that include this field - # - # 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. - referencedByFiltersConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DatasourceFilter_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefilter_filter.doc.html), - orderBy: [DatasourceFilterSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefiltersortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatasourceFiltersConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefiltersconnection.doc.html) - # Thie combined set field that references this field - # - # 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. - referencedByCombinedSets( - filter: [CombinedSetField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedsetfield_filter.doc.html), - orderBy: [CombinedSetFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedsetfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[CombinedSetField](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedsetfield.doc.html)] - # Thie combined set field that references this field - # - # 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. - referencedByCombinedSetsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [CombinedSetField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedsetfield_filter.doc.html), - orderBy: [CombinedSetFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedsetfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [CombinedSetFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedsetfieldsconnection.doc.html) - # Sheets that reference this data source field - # - # 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. - sheets( - filter: [Sheet_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Sheet](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html)] - # Sheets that reference this data source field - # - # 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. - sheetsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Sheet_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [SheetsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsconnection.doc.html) - # A flow output field that wraps this field - # - # 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. - referencedByFlowFieldOutputField( - filter: [FlowFieldOutputField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfield_filter.doc.html), - orderBy: [FlowFieldOutputFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[FlowFieldOutputField](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfield.doc.html)] - # A flow output field that wraps this field - # - # 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. - referencedByFlowFieldOutputFieldConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [FlowFieldOutputField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfield_filter.doc.html), - orderBy: [FlowFieldOutputFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FlowFieldOutputFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfieldsconnection.doc.html) - # The calculated field that references this field - # - # 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. - referencedByCalculations( - filter: [CalculatedField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/calculatedfield_filter.doc.html), - orderBy: [CalculatedFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/calculatedfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[CalculatedField](https://help.tableau.com/current/api/metadata_api/en-us/reference/calculatedfield.doc.html)] - # The calculated field that references this field - # - # 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. - referencedByCalculationsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [CalculatedField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/calculatedfield_filter.doc.html), - orderBy: [CalculatedFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/calculatedfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [CalculatedFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/calculatedfieldsconnection.doc.html) - # A flow input field that wraps this field - # - # 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. - referencedByFlowFieldInputField( - filter: [FlowFieldInputField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfield_filter.doc.html), - orderBy: [FlowFieldInputFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfieldsortorder.doc.html) - ): [[FlowFieldInputField](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfield.doc.html)] - # A flow input field that wraps this field - # - # 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. - referencedByFlowFieldInputFieldConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [FlowFieldInputField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfield_filter.doc.html), - orderBy: [FlowFieldInputFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfieldsortorder.doc.html) - ): [FlowFieldInputFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfieldsconnection.doc.html) - # Data source that contains this field - datasource: [Datasource](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasource.doc.html) - # Metric definitions that reference this data source field. - # - # 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. - metricDefinitions( - filter: [MetricDefinition_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinition_filter.doc.html), - orderBy: [MetricDefinitionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[MetricDefinition](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinition.doc.html)] - # Metric definitions that reference this data source field. - # - # 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. - metricDefinitionsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [MetricDefinition_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinition_filter.doc.html), - orderBy: [MetricDefinitionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [MetricDefinitionsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsconnection.doc.html) - # The group field that references this field - # - # 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. - referencedByGroups( - filter: [GroupField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/groupfield_filter.doc.html), - orderBy: [GroupFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/groupfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[GroupField](https://help.tableau.com/current/api/metadata_api/en-us/reference/groupfield.doc.html)] - # The group field that references this field - # - # 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. - referencedByGroupsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [GroupField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/groupfield_filter.doc.html), - orderBy: [GroupFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/groupfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [GroupFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/groupfieldsconnection.doc.html) - # The combined field that references this field - # - # 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. - referencedByCombinedFields( - filter: [CombinedField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedfield_filter.doc.html), - orderBy: [CombinedFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[CombinedField](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedfield.doc.html)] - # The combined field that references this field - # - # 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. - referencedByCombinedFieldsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [CombinedField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedfield_filter.doc.html), - orderBy: [CombinedFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [CombinedFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedfieldsconnection.doc.html) - # List of lens fields which are derived from this field - # - # 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. - derivedLensFields( - filter: [LensField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensfield_filter.doc.html), - orderBy: [LensFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[LensField](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensfield.doc.html)] - # List of lens fields which are derived from this field - # - # 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. - derivedLensFieldsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [LensField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensfield_filter.doc.html), - orderBy: [LensFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [LensFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensfieldsconnection.doc.html) - } ` ## [_link_](#require-by) Require by - [AnalyticsField_Base GraphQL type for a field containing analytics metadata_](https://help.tableau.com/current/api/metadata_api/en-us/reference/analyticsfield.doc.html "AnalyticsField - Base GraphQL type for a field containing analytics metadata") - [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/current/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/current/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") - [ColumnField_ColumnFields are a type of field which directly connects to a column in some type of table._](https://help.tableau.com/current/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/current/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/current/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") - [DataField_Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField._](https://help.tableau.com/current/api/metadata_api/en-us/reference/datafield.doc.html "DataField - Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField.") - [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/current/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/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [FieldReferencingField_Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula._](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield.doc.html "FieldReferencingField - Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula.") - [FieldReferencingFieldsConnection_Connection Type for FieldReferencingField_](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfieldsconnection.doc.html "FieldReferencingFieldsConnection - Connection Type for FieldReferencingField") - [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/current/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/current/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") - [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/current/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") _menu_ Types INPUT\_OBJECT # FieldReferencingField\_Filter Filter by GraphQL field and given value ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input FieldReferencingField_Filter { - # Unique Identifier of object to retrieve - id: [ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html) - # Unique Identifier of object to retrieve - idWithin: [[ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html)] - } ` ## [_link_](#require-by) Require by - [AnalyticsField_Base GraphQL type for a field containing analytics metadata_](https://help.tableau.com/current/api/metadata_api/en-us/reference/analyticsfield.doc.html "AnalyticsField - Base GraphQL type for a field containing analytics metadata") - [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/current/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/current/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") - [ColumnField_ColumnFields are a type of field which directly connects to a column in some type of table._](https://help.tableau.com/current/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/current/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/current/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") - [DataField_Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField._](https://help.tableau.com/current/api/metadata_api/en-us/reference/datafield.doc.html "DataField - Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField.") - [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/current/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/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [FieldReferencingField_Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula._](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield.doc.html "FieldReferencingField - Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula.") - [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/current/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/current/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") - [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/current/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") _menu_ Types ENUM # FieldReferencingFieldOrderField Enum for fields that can be used for sorting ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - enum FieldReferencingFieldOrderField { - # Sort by fields count - FIELDS_COUNT - # Sort by id - ID - } ` ## [_link_](#require-by) Require by - [FieldReferencingFieldSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfieldsortorder.doc.html "FieldReferencingFieldSortOrder - 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.") _menu_ Types OBJECT # FieldReferencingFieldsConnection Connection Type for FieldReferencingField ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type FieldReferencingFieldsConnection { - # List of nodes - nodes: [[FieldReferencingField](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield.doc.html)!]! - # Information for pagination - pageInfo: [PageInfo](https://help.tableau.com/current/api/metadata_api/en-us/reference/pageinfo.doc.html)! - # Total number of objects in connection - totalCount: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html)! - } ` ## [_link_](#require-by) Require by - [AnalyticsField_Base GraphQL type for a field containing analytics metadata_](https://help.tableau.com/current/api/metadata_api/en-us/reference/analyticsfield.doc.html "AnalyticsField - Base GraphQL type for a field containing analytics metadata") - [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/current/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/current/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") - [ColumnField_ColumnFields are a type of field which directly connects to a column in some type of table._](https://help.tableau.com/current/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/current/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/current/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") - [DataField_Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField._](https://help.tableau.com/current/api/metadata_api/en-us/reference/datafield.doc.html "DataField - Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField.") - [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/current/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/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [FieldReferencingField_Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula._](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield.doc.html "FieldReferencingField - Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula.") - [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/current/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/current/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") - [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/current/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") _menu_ Types INPUT\_OBJECT # FieldReferencingFieldSortOrder 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. ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input FieldReferencingFieldSortOrder { - # GraphQL field to sort on - field: [FieldReferencingFieldOrderField](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfieldorderfield.doc.html)! - # Order direction to sort output - direction: [OrderDirection](https://help.tableau.com/current/api/metadata_api/en-us/reference/orderdirection.doc.html)! - } ` ## [_link_](#require-by) Require by - [AnalyticsField_Base GraphQL type for a field containing analytics metadata_](https://help.tableau.com/current/api/metadata_api/en-us/reference/analyticsfield.doc.html "AnalyticsField - Base GraphQL type for a field containing analytics metadata") - [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/current/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/current/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") - [ColumnField_ColumnFields are a type of field which directly connects to a column in some type of table._](https://help.tableau.com/current/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/current/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/current/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") - [DataField_Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField._](https://help.tableau.com/current/api/metadata_api/en-us/reference/datafield.doc.html "DataField - Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField.") - [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/current/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/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [FieldReferencingField_Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula._](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield.doc.html "FieldReferencingField - Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula.") - [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/current/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/current/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") - [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/current/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") _menu_ Types ENUM # FieldRole Possible roles of a field. ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - enum FieldRole { - DIMENSION - MEASURE - UNKNOWN - } ` ## [_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/current/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/current/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") - [ColumnField_ColumnFields are a type of field which directly connects to a column in some type of table._](https://help.tableau.com/current/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.") - [DataField_Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField._](https://help.tableau.com/current/api/metadata_api/en-us/reference/datafield.doc.html "DataField - Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField.") - [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/current/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") _menu_ Types INPUT\_OBJECT # FieldRole\_Filter Filter by GraphQL field and given value ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input FieldRole_Filter { - # Unique Identifier of object to retrieve - id: [ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html) - # Unique Identifier of object to retrieve - idWithin: [[ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html)] - } ` ## [_link_](#require-by) Require by This element is not required by anyone _menu_ Types ENUM # FieldRoleCategory Possible categories of a field role. ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - enum FieldRoleCategory { - QUANTITATIVE - NOMINAL - ORDINAL - UNKNOWN - } ` ## [_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/current/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/current/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") - [ColumnField_ColumnFields are a type of field which directly connects to a column in some type of table._](https://help.tableau.com/current/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.") - [DataField_Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField._](https://help.tableau.com/current/api/metadata_api/en-us/reference/datafield.doc.html "DataField - Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField.") - [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/current/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") _menu_ Types INPUT\_OBJECT # FieldRoleCategory\_Filter Filter by GraphQL field and given value ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input FieldRoleCategory_Filter { - # Unique Identifier of object to retrieve - id: [ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html) - # Unique Identifier of object to retrieve - idWithin: [[ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html)] - } ` ## [_link_](#require-by) Require by This element is not required by anyone _menu_ Types OBJECT # FieldsConnection Connection Type for Field ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type FieldsConnection { - # List of nodes - nodes: [[Field](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.doc.html)!]! - # Information for pagination - pageInfo: [PageInfo](https://help.tableau.com/current/api/metadata_api/en-us/reference/pageinfo.doc.html)! - # Total number of objects in connection - totalCount: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.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/current/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/current/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") - [Column_GraphQL type for a table column_](https://help.tableau.com/current/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/current/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/current/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/current/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") - [Dashboard_A dashboard contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard.doc.html "Dashboard - A dashboard contained in a published workbook.") - [Datasource_Root GraphQL type for embedded and published data sources Data sources are a way to represent how Tableau Desktop and Tableau Server model and connect to data. Data sources can be published separately, as a published data source, or may be contained in a workbook as an embedded data source. See https://onlinehelp.tableau.com/current/server/en-us/datasource.htm_](datasource.doc.html "Datasource - Root GraphQL type for embedded and published data sources Data sources are a way to represent how Tableau Desktop and Tableau Server model and connect to data. Data sources can be published separately, as a published data source, or may be contained in a workbook as an embedded data source. See https://onlinehelp.tableau.com/current/server/en-us/datasource.htm") - [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/current/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.") - [EmbeddedDatasource_A data source embedded in a workbook_](https://help.tableau.com/current/api/metadata_api/en-us/reference/embeddeddatasource.doc.html "EmbeddedDatasource - A data source embedded in a workbook") - [Field_Base GraphQL type for a field_](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [FieldReferencingField_Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula._](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield.doc.html "FieldReferencingField - Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula.") - [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/current/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/current/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.*") - [Metric_Metrics are time series data constructed from fields contained in views. \*Retired in Tableau Cloud February 2024 / Server 2024.2.\*_](metric.doc.html "Metric - Metrics are time series data constructed from fields contained in views. *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/current/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/current/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/current/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") - [Sheet_A sheet contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html "Sheet - A sheet contained in a published workbook.") _menu_ Types INPUT\_OBJECT # FieldSortOrder 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. ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input FieldSortOrder { - # GraphQL field to sort on - field: [FieldOrderField](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldorderfield.doc.html)! - # Order direction to sort output - direction: [OrderDirection](https://help.tableau.com/current/api/metadata_api/en-us/reference/orderdirection.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/current/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/current/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") - [Column_GraphQL type for a table column_](https://help.tableau.com/current/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/current/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/current/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/current/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") - [Dashboard_A dashboard contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard.doc.html "Dashboard - A dashboard contained in a published workbook.") - [Datasource_Root GraphQL type for embedded and published data sources Data sources are a way to represent how Tableau Desktop and Tableau Server model and connect to data. Data sources can be published separately, as a published data source, or may be contained in a workbook as an embedded data source. See https://onlinehelp.tableau.com/current/server/en-us/datasource.htm_](datasource.doc.html "Datasource - Root GraphQL type for embedded and published data sources Data sources are a way to represent how Tableau Desktop and Tableau Server model and connect to data. Data sources can be published separately, as a published data source, or may be contained in a workbook as an embedded data source. See https://onlinehelp.tableau.com/current/server/en-us/datasource.htm") - [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/current/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.") - [EmbeddedDatasource_A data source embedded in a workbook_](https://help.tableau.com/current/api/metadata_api/en-us/reference/embeddeddatasource.doc.html "EmbeddedDatasource - A data source embedded in a workbook") - [Field_Base GraphQL type for a field_](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [FieldReferencingField_Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula._](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield.doc.html "FieldReferencingField - Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula.") - [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/current/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/current/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.*") - [Metric_Metrics are time series data constructed from fields contained in views. \*Retired in Tableau Cloud February 2024 / Server 2024.2.\*_](metric.doc.html "Metric - Metrics are time series data constructed from fields contained in views. *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/current/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/current/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/current/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") - [Sheet_A sheet contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html "Sheet - A sheet contained in a published workbook.") _menu_ Types OBJECT # File A file connection ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type File implements [Database](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html), [Warnable](https://help.tableau.com/current/api/metadata_api/en-us/reference/warnable.doc.html), [Certifiable](https://help.tableau.com/current/api/metadata_api/en-us/reference/certifiable.doc.html), [CanHaveLabels](https://help.tableau.com/current/api/metadata_api/en-us/reference/canhavelabels.doc.html), [Taggable](https://help.tableau.com/current/api/metadata_api/en-us/reference/taggable.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/current/api/metadata_api/en-us/reference/id.doc.html)! - # Vizportal ID of this database, for use in client-to-server communications - vizportalId: [String](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/string.doc.html)! - # Name shown in server and desktop clients - name: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Connection type shortname - connectionType: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # True if this file is embedded in Tableau content, e.g., a packaged workbook - isEmbedded: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) - # Path to file - filePath: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # User modifiable description of this database - description: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # The ID of the project in which the database is visible. Will be empty if the - # database is not in a project. - projectVizportalUrlId: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # The name of the project in which the database is visible. Will be empty if the - # database is not in a project. - projectName: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Contact for this database - contact: [TableauUser](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauuser.doc.html) - # True if this database contains an active data quality certification - isCertified: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html)! - # True if this database has its permission locked - isControlledPermissionsEnabled: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) - # True if this database has been grouped with other databases - isGrouped: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) - # Notes related to this database being marked as certified - certificationNote: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) @deprecated( reason: "No longer supported. Use 'dataQualityCertifications'" ) - # User who marked this database as certified - certifier: [TableauUser](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauuser.doc.html) @deprecated( reason: "No longer supported. Use 'dataQualityCertifications'" ) - # True if the database has an active data quality warning - hasActiveWarning: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html)! - # The optional data quality warning on a database - dataQualityWarning: [DataQualityWarning](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarning.doc.html) @deprecated( reason: "Use 'dataQualityWarnings'" ) - # The data quality warnings on a 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. - # **permissionMode**: Results filtering mode. - dataQualityWarnings( - filter: [DataQualityWarning_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarning_filter.doc.html), - orderBy: [DataQualityWarningSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarningsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DataQualityWarning](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarning.doc.html)!]! - # The data quality warnings on a 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. - # **permissionMode**: Results filtering mode. - dataQualityWarningsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DataQualityWarning_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarning_filter.doc.html), - orderBy: [DataQualityWarningSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarningsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DataQualityWarningsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarningsconnection.doc.html) - # The data quality certifications on a 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. - # **permissionMode**: Results filtering mode. - dataQualityCertifications( - filter: [DataQualityCertification_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitycertification_filter.doc.html), - orderBy: [DataQualityCertificationSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitycertificationsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DataQualityCertification](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitycertification.doc.html)!]! - # The data quality certifications on a 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. - # **permissionMode**: Results filtering mode. - dataQualityCertificationsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DataQualityCertification_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitycertification_filter.doc.html), - orderBy: [DataQualityCertificationSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitycertificationsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DataQualityCertificationsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitycertificationsconnection.doc.html) - # The labels on a database. 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/current/api/metadata_api/en-us/reference/label_filter.doc.html), - orderBy: [LabelSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/labelsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Label](https://help.tableau.com/current/api/metadata_api/en-us/reference/label.doc.html)!]! - # The labels on a database. 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Label_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/label_filter.doc.html), - orderBy: [LabelSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/labelsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [LabelsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/labelsconnection.doc.html) - # Data quality warnings upstream from this 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. - # **permissionMode**: Results filtering mode. - upstreamDataQualityWarnings( - filter: [DataQualityWarning_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarning_filter.doc.html), - orderBy: [DataQualityWarningSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarningsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DataQualityWarning](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarning.doc.html)!]! - # Data quality warnings upstream from this 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. - # **permissionMode**: Results filtering mode. - upstreamDataQualityWarningsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DataQualityWarning_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarning_filter.doc.html), - orderBy: [DataQualityWarningSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarningsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DataQualityWarningsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarningsconnection.doc.html) - # Labels upstream from this database. 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/current/api/metadata_api/en-us/reference/label_filter.doc.html), - orderBy: [LabelSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/labelsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Label](https://help.tableau.com/current/api/metadata_api/en-us/reference/label.doc.html)!]! - # Labels upstream from this database. 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Label_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/label_filter.doc.html), - orderBy: [LabelSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/labelsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [LabelsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/labelsconnection.doc.html) - # Tags associated with 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. - tags(filter: [Tag_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/tag_filter.doc.html), orderBy: [TagSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tagsortorder.doc.html)): [[Tag](https://help.tableau.com/current/api/metadata_api/en-us/reference/tag.doc.html)!]! - # Tags associated with 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. - tagsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Tag_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/tag_filter.doc.html), - orderBy: [TagSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tagsortorder.doc.html) - ): [TagsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/tagsconnection.doc.html) - # Databases upstream of this 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. - # **permissionMode**: Results filtering mode. - upstreamDatabases( - filter: [Database_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Database](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html)!]! - # Databases upstream of this 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. - # **permissionMode**: Results filtering mode. - upstreamDatabasesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Database_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabasesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesconnection.doc.html) - # Tables upstream of this 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. - # **permissionMode**: Results filtering mode. - upstreamTables( - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DatabaseTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable.doc.html)!]! - # Tables upstream of this 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. - # **permissionMode**: Results filtering mode. - upstreamTablesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabaseTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesconnection.doc.html) - # Virtual connection tables upstream of this 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. - # **permissionMode**: Results filtering mode. - upstreamVirtualConnections( - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection.doc.html)!]! - # Virtual connection tables upstream of this 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. - # **permissionMode**: Results filtering mode. - upstreamVirtualConnectionsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsconnection.doc.html) - # Virtual connection tables upstream of this 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. - # **permissionMode**: Results filtering mode. - upstreamVirtualConnectionTables( - filter: [VirtualConnectionTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnectionTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable.doc.html)!]! - # Virtual connection tables upstream of this 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. - # **permissionMode**: Results filtering mode. - upstreamVirtualConnectionTablesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnectionTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesconnection.doc.html) - # Flows upstream of this 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. - # **permissionMode**: Results filtering mode. - upstreamFlows( - filter: [Flow_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Flow](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow.doc.html)!]! - # Flows upstream of this 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. - # **permissionMode**: Results filtering mode. - upstreamFlowsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Flow_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FlowsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsconnection.doc.html) - # Datasources upstream of this 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. - # **permissionMode**: Results filtering mode. - upstreamDatasources( - filter: [PublishedDatasource_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[PublishedDatasource](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource.doc.html)!]! - # Datasources upstream of this 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. - # **permissionMode**: Results filtering mode. - upstreamDatasourcesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [PublishedDatasource_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [PublishedDatasourcesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesconnection.doc.html) - # Databases downstream of this 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. - # **permissionMode**: Results filtering mode. - downstreamDatabases( - filter: [Database_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Database](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html)!]! - # Databases downstream of this 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. - # **permissionMode**: Results filtering mode. - downstreamDatabasesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Database_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabasesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesconnection.doc.html) - # Tables downstream of this 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. - # **permissionMode**: Results filtering mode. - downstreamTables( - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DatabaseTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable.doc.html)!]! - # Tables downstream of this 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. - # **permissionMode**: Results filtering mode. - downstreamTablesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabaseTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesconnection.doc.html) - # Virtual connection tables downstream of this 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. - # **permissionMode**: Results filtering mode. - downstreamVirtualConnections( - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection.doc.html)!]! - # Virtual connection tables downstream of this 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. - # **permissionMode**: Results filtering mode. - downstreamVirtualConnectionsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsconnection.doc.html) - # Virtual connection tables downstream of this 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. - # **permissionMode**: Results filtering mode. - downstreamVirtualConnectionTables( - filter: [VirtualConnectionTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnectionTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable.doc.html)!]! - # Virtual connection tables downstream of this 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. - # **permissionMode**: Results filtering mode. - downstreamVirtualConnectionTablesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnectionTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesconnection.doc.html) - # Flows downstream of this 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. - # **permissionMode**: Results filtering mode. - downstreamFlows( - filter: [Flow_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Flow](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow.doc.html)!]! - # Flows downstream of this 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. - # **permissionMode**: Results filtering mode. - downstreamFlowsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Flow_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FlowsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsconnection.doc.html) - # Published datasources 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. - # **permissionMode**: Results filtering mode. - downstreamDatasources( - filter: [PublishedDatasource_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[PublishedDatasource](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource.doc.html)!]! - # Published datasources 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. - # **permissionMode**: Results filtering mode. - downstreamDatasourcesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [PublishedDatasource_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [PublishedDatasourcesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesconnection.doc.html) - # Lenses 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. - # **permissionMode**: Results filtering mode. - downstreamLenses( - filter: [Lens_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/lens_filter.doc.html), - orderBy: [LensSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/lenssortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Lens](https://help.tableau.com/current/api/metadata_api/en-us/reference/lens.doc.html)!]! - # Lenses 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. - # **permissionMode**: Results filtering mode. - downstreamLensesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Lens_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/lens_filter.doc.html), - orderBy: [LensSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/lenssortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [LensesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensesconnection.doc.html) - # Workbooks 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. - # **permissionMode**: Results filtering mode. - downstreamWorkbooks( - filter: [Workbook_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbook_filter.doc.html), - orderBy: [WorkbookSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Workbook](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbook.doc.html)!]! - # Workbooks 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. - # **permissionMode**: Results filtering mode. - downstreamWorkbooksConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Workbook_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbook_filter.doc.html), - orderBy: [WorkbookSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [WorkbooksConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksconnection.doc.html) - # Dashboards 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. - # **permissionMode**: Results filtering mode. - downstreamDashboards( - filter: [Dashboard_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard_filter.doc.html), - orderBy: [DashboardSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboardsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Dashboard](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard.doc.html)!]! - # Dashboards 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. - # **permissionMode**: Results filtering mode. - downstreamDashboardsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Dashboard_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard_filter.doc.html), - orderBy: [DashboardSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboardsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DashboardsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboardsconnection.doc.html) - # Sheets 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. - # **permissionMode**: Results filtering mode. - downstreamSheets( - filter: [Sheet_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Sheet](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html)!]! - # Sheets 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. - # **permissionMode**: Results filtering mode. - downstreamSheetsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Sheet_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [SheetsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsconnection.doc.html) - # Metrics 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. - # **permissionMode**: Results filtering mode. - downstreamMetrics( - filter: [Metric_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metric_filter.doc.html), - orderBy: [MetricSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Metric](https://help.tableau.com/current/api/metadata_api/en-us/reference/metric.doc.html)!]! - # Metrics 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. - # **permissionMode**: Results filtering mode. - downstreamMetricsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Metric_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metric_filter.doc.html), - orderBy: [MetricSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [MetricsConnection](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/tableauuser_filter.doc.html), - orderBy: [TableauUserSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauusersortorder.doc.html) - ): [[TableauUser](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [TableauUser_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauuser_filter.doc.html), - orderBy: [TableauUserSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauusersortorder.doc.html) - ): [TableauUsersConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauusersconnection.doc.html) - # The custom SQL queries that reference this 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. - # **permissionMode**: Results filtering mode. - referencedByQueries( - filter: [CustomSQLTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/customsqltable_filter.doc.html), - orderBy: [CustomSQLTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/customsqltablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[CustomSQLTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/customsqltable.doc.html)] - # The custom SQL queries that reference this 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. - # **permissionMode**: Results filtering mode. - referencedByQueriesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [CustomSQLTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/customsqltable_filter.doc.html), - orderBy: [CustomSQLTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/customsqltablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [CustomSQLTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/customsqltablesconnection.doc.html) - # Tables belonging to this 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. - # **permissionMode**: Results filtering mode. - tables( - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DatabaseTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable.doc.html)] - # Tables belonging to this 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. - # **permissionMode**: Results filtering mode. - tablesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabaseTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesconnection.doc.html) - # Metric definitions downstream from this 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. - # **permissionMode**: Results filtering mode. - downstreamMetricDefinitions( - filter: [MetricDefinition_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinition_filter.doc.html), - orderBy: [MetricDefinitionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[MetricDefinition](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinition.doc.html)]! - # Metric definitions downstream from this 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. - # **permissionMode**: Results filtering mode. - downstreamMetricDefinitionsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [MetricDefinition_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinition_filter.doc.html), - orderBy: [MetricDefinitionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [MetricDefinitionsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsconnection.doc.html) - } ` ## [_link_](#require-by) Require by - [FilesConnection_Connection Type for File_](https://help.tableau.com/current/api/metadata_api/en-us/reference/filesconnection.doc.html "FilesConnection - Connection Type for File") - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/api/metadata_api/en-us/reference/query.doc.html "Query - Query root for Metadata GraphQL interface") _menu_ Types INPUT\_OBJECT # File\_Filter Filter by GraphQL field and given value ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input File_Filter { - # True if the database has an active data quality warning - hasActiveWarning: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) - # True if the database has an active data quality warning - hasActiveWarningWithin: [[Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html)] - # Locally unique identifier used for the REST API on the Tableau Server - luid: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Locally unique identifier used for the REST API on the Tableau Server - luidWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)] - # True if this database contains an active data quality certification - isCertified: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) - # True if this database contains an active data quality certification - isCertifiedWithin: [[Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html)] - # Name shown in server and desktop clients - name: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Name shown in server and desktop clients - nameWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)] - # True if this file is embedded in Tableau content, e.g., a packaged workbook - isEmbedded: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) - # True if this file is embedded in Tableau content, e.g., a packaged workbook - isEmbeddedWithin: [[Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.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/current/api/metadata_api/en-us/reference/id.doc.html) - # Unique identifier used by the Metadata API. Not the same as the numeric ID used - # on server - idWithin: [[ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html)] - # The name of the project in which the database is visible. Will be empty if the - # database is not in a project. - projectName: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # The name of the project in which the database is visible. Will be empty if the - # database is not in a project. - projectNameWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)] - # Connection type shortname - connectionType: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Connection type shortname - connectionTypeWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)] - # Filter the output based on text query. - text: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - } ` ## [_link_](#require-by) Require by - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/api/metadata_api/en-us/reference/query.doc.html "Query - Query root for Metadata GraphQL interface") _menu_ Types ENUM # FileOrderField Enum for fields that can be used for sorting ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - enum FileOrderField { - # Sort by downstreamDatasources count - DOWNSTREAM_DATASOURCES_COUNT - # Sort by downstreamVirtualConnections count - DOWNSTREAM_VIRTUAL_CONNECTIONS_COUNT - # Sort by downstreamWorkbooks count - DOWNSTREAM_WORKBOOKS_COUNT - # Sort by connectionType - CONNECTION_TYPE - # Sort by hasActiveWarning - HAS_ACTIVE_WARNING - # Sort by id - ID - # Sort by isCertified - IS_CERTIFIED - # Sort by isEmbedded - IS_EMBEDDED - # Sort by luid - LUID - # Sort by name - NAME - # Sort by projectName - PROJECT_NAME - } ` ## [_link_](#require-by) Require by - [FileSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/filesortorder.doc.html "FileSortOrder - 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.") _menu_ Types OBJECT # FilesConnection Connection Type for File ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type FilesConnection { - # List of nodes - nodes: [[File](https://help.tableau.com/current/api/metadata_api/en-us/reference/file.doc.html)!]! - # Information for pagination - pageInfo: [PageInfo](https://help.tableau.com/current/api/metadata_api/en-us/reference/pageinfo.doc.html)! - # Total number of objects in connection - totalCount: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html)! - } ` ## [_link_](#require-by) Require by - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/api/metadata_api/en-us/reference/query.doc.html "Query - Query root for Metadata GraphQL interface") _menu_ Types INPUT\_OBJECT # FileSortOrder 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. ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input FileSortOrder { - # GraphQL field to sort on - field: [FileOrderField](https://help.tableau.com/current/api/metadata_api/en-us/reference/fileorderfield.doc.html)! - # Order direction to sort output - direction: [OrderDirection](https://help.tableau.com/current/api/metadata_api/en-us/reference/orderdirection.doc.html)! - } ` ## [_link_](#require-by) Require by - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/api/metadata_api/en-us/reference/query.doc.html "Query - Query root for Metadata GraphQL interface") _menu_ Types OBJECT # Flow Flows are used to prepare data, which can include aggregation, cleaning, preprocessing, etc. ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type Flow implements [Warnable](https://help.tableau.com/current/api/metadata_api/en-us/reference/warnable.doc.html), [CanHaveLabels](https://help.tableau.com/current/api/metadata_api/en-us/reference/canhavelabels.doc.html), [Taggable](https://help.tableau.com/current/api/metadata_api/en-us/reference/taggable.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/current/api/metadata_api/en-us/reference/id.doc.html)! - # Name shown in server and desktop clients - name: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Locally unique identifier used for the REST API on the Tableau Server - uri: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # VizPortal URL ID; used for URL generation - vizportalUrlId: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)! - # Time the flow was created. Available in Tableau Cloud June 2022 / Server 2022.3 - # and later. - createdAt: [DateTime](https://help.tableau.com/current/api/metadata_api/en-us/reference/datetime.doc.html) - # Time the flow was updated. Available in Tableau Cloud June 2022 / Server 2022.3 - # and later. - updatedAt: [DateTime](https://help.tableau.com/current/api/metadata_api/en-us/reference/datetime.doc.html) - # The site in which the flow is visible and usable - site: [TableauSite](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableausite.doc.html) - # The ID of the project in which the flow is visible and usable. Will be null if - # the flow is not in a project. - projectVizportalUrlId: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # The name of the project in which the flow is visible and usable - projectName: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # 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. - personalSpaceUrlLink: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # The type of the container in which the flow is visible and usable. Either - # personal space or project. - containerType: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)! - # The name of the container in which the flow is visible and usable. Either a - # personal space or project. - containerName: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # User who owns this flow - owner: [TableauUser](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauuser.doc.html) - # 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. - inputFields( - filter: [FlowInputField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowinputfield_filter.doc.html), - orderBy: [FlowInputFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowinputfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[FlowInputField](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowinputfield.doc.html)!]! - # 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. - inputFieldsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [FlowInputField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowinputfield_filter.doc.html), - orderBy: [FlowInputFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowinputfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FlowInputFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowinputfieldsconnection.doc.html) - # 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. - outputFields( - filter: [FlowOutputField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowoutputfield_filter.doc.html), - orderBy: [FlowOutputFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowoutputfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[FlowOutputField](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowoutputfield.doc.html)!]! - # 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. - outputFieldsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [FlowOutputField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowoutputfield_filter.doc.html), - orderBy: [FlowOutputFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowoutputfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FlowOutputFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowoutputfieldsconnection.doc.html) - # 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. - outputSteps( - filter: [FlowOutputStep_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowoutputstep_filter.doc.html), - orderBy: [FlowOutputStepSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowoutputstepsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[FlowOutputStep](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowoutputstep.doc.html)!]! - # 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. - outputStepsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [FlowOutputStep_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowoutputstep_filter.doc.html), - orderBy: [FlowOutputStepSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowoutputstepsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FlowOutputStepsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowoutputstepsconnection.doc.html) - # Description of the flow - description: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # True if the flow has an active data quality warning - hasActiveWarning: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html)! - # True if the flow contains unsupported custom SQL, in which case lineage may be - # incomplete - containsUnsupportedCustomSql: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) - # Locally unique identifier used for the REST API on the Tableau Server - luid: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)! - # 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. - tags(filter: [Tag_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/tag_filter.doc.html), orderBy: [TagSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tagsortorder.doc.html)): [[Tag](https://help.tableau.com/current/api/metadata_api/en-us/reference/tag.doc.html)!]! - # 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. - tagsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Tag_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/tag_filter.doc.html), - orderBy: [TagSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tagsortorder.doc.html) - ): [TagsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/tagsconnection.doc.html) - # The optional data quality warning on a flow - dataQualityWarning: [DataQualityWarning](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarning.doc.html) @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. - dataQualityWarnings( - filter: [DataQualityWarning_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarning_filter.doc.html), - orderBy: [DataQualityWarningSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarningsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DataQualityWarning](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarning.doc.html)!]! - # 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. - dataQualityWarningsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DataQualityWarning_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarning_filter.doc.html), - orderBy: [DataQualityWarningSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarningsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DataQualityWarningsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarningsconnection.doc.html) - # 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. - labels( - filter: [Label_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/label_filter.doc.html), - orderBy: [LabelSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/labelsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Label](https://help.tableau.com/current/api/metadata_api/en-us/reference/label.doc.html)!]! - # 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. - labelsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Label_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/label_filter.doc.html), - orderBy: [LabelSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/labelsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [LabelsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/labelsconnection.doc.html) - # 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. - upstreamDataQualityWarnings( - filter: [DataQualityWarning_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarning_filter.doc.html), - orderBy: [DataQualityWarningSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarningsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DataQualityWarning](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarning.doc.html)!]! - # 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. - upstreamDataQualityWarningsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DataQualityWarning_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarning_filter.doc.html), - orderBy: [DataQualityWarningSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarningsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DataQualityWarningsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarningsconnection.doc.html) - # 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. - upstreamLabels( - filter: [Label_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/label_filter.doc.html), - orderBy: [LabelSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/labelsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Label](https://help.tableau.com/current/api/metadata_api/en-us/reference/label.doc.html)!]! - # 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. - upstreamLabelsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Label_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/label_filter.doc.html), - orderBy: [LabelSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/labelsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [LabelsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/labelsconnection.doc.html) - # 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. - upstreamDatabases( - filter: [Database_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Database](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html)!]! - # 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. - upstreamDatabasesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Database_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabasesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesconnection.doc.html) - # 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. - upstreamTables( - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DatabaseTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable.doc.html)!]! - # 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. - upstreamTablesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabaseTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesconnection.doc.html) - # 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. - upstreamFlows( - filter: [Flow_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Flow](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow.doc.html)!]! - # 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. - upstreamFlowsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Flow_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FlowsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsconnection.doc.html) - # 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. - upstreamDatasources( - filter: [PublishedDatasource_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[PublishedDatasource](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource.doc.html)!]! - # 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. - upstreamDatasourcesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [PublishedDatasource_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [PublishedDatasourcesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesconnection.doc.html) - # 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. - downstreamFlows( - filter: [Flow_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Flow](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow.doc.html)!]! - # 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. - downstreamFlowsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Flow_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FlowsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsconnection.doc.html) - # 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. - nextDownstreamFlows( - filter: [Flow_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Flow](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow.doc.html)!]! - # 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. - nextDownstreamFlowsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Flow_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FlowsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsconnection.doc.html) - # 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. - downstreamLinkedFlows( - filter: [LinkedFlow_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/linkedflow_filter.doc.html), - orderBy: [LinkedFlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/linkedflowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[LinkedFlow](https://help.tableau.com/current/api/metadata_api/en-us/reference/linkedflow.doc.html)!]! - # 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. - downstreamLinkedFlowsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [LinkedFlow_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/linkedflow_filter.doc.html), - orderBy: [LinkedFlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/linkedflowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [LinkedFlowsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/linkedflowsconnection.doc.html) - # 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. - upstreamLinkedFlows( - filter: [LinkedFlow_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/linkedflow_filter.doc.html), - orderBy: [LinkedFlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/linkedflowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[LinkedFlow](https://help.tableau.com/current/api/metadata_api/en-us/reference/linkedflow.doc.html)!]! - # 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. - upstreamLinkedFlowsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [LinkedFlow_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/linkedflow_filter.doc.html), - orderBy: [LinkedFlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/linkedflowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [LinkedFlowsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/linkedflowsconnection.doc.html) - # 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. - downstreamDatasources( - filter: [PublishedDatasource_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[PublishedDatasource](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource.doc.html)!]! - # 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. - downstreamDatasourcesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [PublishedDatasource_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [PublishedDatasourcesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesconnection.doc.html) - # 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. - downstreamLenses( - filter: [Lens_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/lens_filter.doc.html), - orderBy: [LensSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/lenssortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Lens](https://help.tableau.com/current/api/metadata_api/en-us/reference/lens.doc.html)!]! - # 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. - downstreamLensesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Lens_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/lens_filter.doc.html), - orderBy: [LensSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/lenssortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [LensesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensesconnection.doc.html) - # 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. - downstreamDatabases( - filter: [Database_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Database](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html)!]! - # 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. - downstreamDatabasesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Database_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabasesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesconnection.doc.html) - # 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. - downstreamTables( - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DatabaseTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable.doc.html)!]! - # 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. - downstreamTablesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabaseTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesconnection.doc.html) - # 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. - downstreamWorkbooks( - filter: [Workbook_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbook_filter.doc.html), - orderBy: [WorkbookSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Workbook](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbook.doc.html)!]! - # 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. - downstreamWorkbooksConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Workbook_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbook_filter.doc.html), - orderBy: [WorkbookSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [WorkbooksConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksconnection.doc.html) - # 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. - downstreamDashboards( - filter: [Dashboard_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard_filter.doc.html), - orderBy: [DashboardSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboardsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Dashboard](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard.doc.html)!]! - # 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. - downstreamDashboardsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Dashboard_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard_filter.doc.html), - orderBy: [DashboardSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboardsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DashboardsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboardsconnection.doc.html) - # 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. - downstreamSheets( - filter: [Sheet_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Sheet](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html)!]! - # 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. - downstreamSheetsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Sheet_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [SheetsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsconnection.doc.html) - # 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. - downstreamMetrics( - filter: [Metric_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metric_filter.doc.html), - orderBy: [MetricSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Metric](https://help.tableau.com/current/api/metadata_api/en-us/reference/metric.doc.html)!]! - # 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. - downstreamMetricsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Metric_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metric_filter.doc.html), - orderBy: [MetricSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [MetricsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricsconnection.doc.html) - # 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. - downstreamVirtualConnections( - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection.doc.html)!]! - # 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. - downstreamVirtualConnectionsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsconnection.doc.html) - # 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. - downstreamVirtualConnectionTables( - filter: [VirtualConnectionTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnectionTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable.doc.html)!]! - # 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. - downstreamVirtualConnectionTablesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnectionTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesconnection.doc.html) - # 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. - downstreamOwners( - filter: [TableauUser_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauuser_filter.doc.html), - orderBy: [TableauUserSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauusersortorder.doc.html) - ): [[TableauUser](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauuser.doc.html)!]! - # 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. - downstreamOwnersConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [TableauUser_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauuser_filter.doc.html), - orderBy: [TableauUserSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauusersortorder.doc.html) - ): [TableauUsersConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauusersconnection.doc.html) - # Metric definitions 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. - downstreamMetricDefinitions( - filter: [MetricDefinition_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinition_filter.doc.html), - orderBy: [MetricDefinitionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[MetricDefinition](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinition.doc.html)]! - # Metric definitions 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. - downstreamMetricDefinitionsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [MetricDefinition_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinition_filter.doc.html), - orderBy: [MetricDefinitionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [MetricDefinitionsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsconnection.doc.html) - # 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. - nextUpstreamFlows( - filter: [Flow_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Flow](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow.doc.html)]! - # 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. - nextUpstreamFlowsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Flow_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FlowsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsconnection.doc.html) - # 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. - # **permissionMode**: Results filtering mode. - upstreamVirtualConnections( - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection.doc.html)] - # 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. - # **permissionMode**: Results filtering mode. - upstreamVirtualConnectionsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsconnection.doc.html) - # 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. - upstreamVirtualConnectionTables( - filter: [VirtualConnectionTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnectionTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable.doc.html)]! - # 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. - upstreamVirtualConnectionTablesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnectionTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesconnection.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/current/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/current/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/current/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/current/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/current/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/current/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/current/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/current/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.") - [Dashboard_A dashboard contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard.doc.html "Dashboard - A dashboard contained in a published workbook.") - [Database_A database containing tables_](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html "Database - A database containing tables") - [DatabaseServer_A database server connection_](https://help.tableau.com/current/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/current/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/current/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.") - [EmbeddedDatasource_A data source embedded in a workbook_](https://help.tableau.com/current/api/metadata_api/en-us/reference/embeddeddatasource.doc.html "EmbeddedDatasource - A data source embedded in a workbook") - [Field_Base GraphQL type for a field_](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [FieldReferencingField_Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula._](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield.doc.html "FieldReferencingField - Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula.") - [File_A file connection_](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/flow.doc.html "Flow - Flows are used to prepare data, which can include aggregation, cleaning, preprocessing, etc.") - [FlowColumnInputField_Column input field implementation_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowcolumninputfield.doc.html "FlowColumnInputField - Column input field implementation") - [FlowColumnOutputField_Column output field implementation_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowcolumnoutputfield.doc.html "FlowColumnOutputField - Column output field implementation") - [FlowFieldInputField_Field input field implementation_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfield.doc.html "FlowFieldInputField - Field input field implementation") - [FlowFieldOutputField_Field output field implementation_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfield.doc.html "FlowFieldOutputField - Field output field implementation") - [FlowInputField_A wrapper for an input field contained in a published flow._](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowinputfield.doc.html "FlowInputField - A wrapper for an input field contained in a published flow.") - [FlowOutputField_A wrapper for an output field contained in a published flow._](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowoutputfield.doc.html "FlowOutputField - A wrapper for an output field contained in a published flow.") - [FlowOutputStep_A flow output step_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowoutputstep.doc.html "FlowOutputStep - A flow output step") - [FlowsConnection_Connection Type for Flow_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsconnection.doc.html "FlowsConnection - Connection Type for 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/current/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/current/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.*") - [LinkedFlow_Wrapper type including edge information_](https://help.tableau.com/current/api/metadata_api/en-us/reference/linkedflow.doc.html "LinkedFlow - Wrapper type including edge information") - [Metric_Metrics are time series data constructed from fields contained in views. \*Retired in Tableau Cloud February 2024 / Server 2024.2.\*_](metric.doc.html "Metric - Metrics are time series data constructed from fields contained in views. *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/current/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/current/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/current/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") - [Sheet_A sheet contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html "Sheet - A sheet contained in a published workbook.") - [Table_A table containing columns_](https://help.tableau.com/current/api/metadata_api/en-us/reference/table.doc.html "Table - A table containing columns") - [TableauSite_Site on Tableau server_](https://help.tableau.com/current/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/current/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/current/api/metadata_api/en-us/reference/tag.doc.html "Tag - A tag associated with content items") - [VirtualConnection_A virtual connection. \*Available in Tableau Cloud March 2022 / Server 2022.1 and later.\*_](virtualconnection.doc.html "VirtualConnection - A virtual connection. *Available in Tableau Cloud March 2022 / Server 2022.1 and later.*") - [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/current/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/current/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).") _menu_ Types INPUT\_OBJECT # Flow\_Filter Filter by GraphQL field and given value ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input Flow_Filter { - # True if the flow contains unsupported custom SQL, in which case lineage may be - # incomplete - containsUnsupportedCustomSql: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) - # True if the flow contains unsupported custom SQL, in which case lineage may be - # incomplete - containsUnsupportedCustomSqlWithin: [[Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html)] - # VizPortal URL ID; used for URL generation - vizportalUrlId: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # VizPortal URL ID; used for URL generation - vizportalUrlIdWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)] - # True if the flow has an active data quality warning - hasActiveWarning: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) - # True if the flow has an active data quality warning - hasActiveWarningWithin: [[Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html)] - # The name of the container in which the flow is visible and usable. Either a - # personal space or project. - containerName: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # The name of the container in which the flow is visible and usable. Either a - # personal space or project. - containerNameWithin: [[String](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/string.doc.html) - # Locally unique identifier used for the REST API on the Tableau Server - luidWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)] - # Name shown in server and desktop clients - name: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Name shown in server and desktop clients - nameWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.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/current/api/metadata_api/en-us/reference/id.doc.html) - # Unique identifier used by the metadata API. Not the same as the numeric ID used - # on server - idWithin: [[ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html)] - # The name of the project in which the flow is visible and usable - projectName: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # The name of the project in which the flow is visible and usable - projectNameWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.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/current/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/current/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/current/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/current/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/current/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/current/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/current/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/current/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.") - [Dashboard_A dashboard contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard.doc.html "Dashboard - A dashboard contained in a published workbook.") - [Database_A database containing tables_](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html "Database - A database containing tables") - [DatabaseServer_A database server connection_](https://help.tableau.com/current/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/current/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/current/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.") - [EmbeddedDatasource_A data source embedded in a workbook_](https://help.tableau.com/current/api/metadata_api/en-us/reference/embeddeddatasource.doc.html "EmbeddedDatasource - A data source embedded in a workbook") - [Field_Base GraphQL type for a field_](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [FieldReferencingField_Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula._](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield.doc.html "FieldReferencingField - Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula.") - [File_A file connection_](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/flow.doc.html "Flow - Flows are used to prepare data, which can include aggregation, cleaning, preprocessing, etc.") - [FlowColumnInputField_Column input field implementation_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowcolumninputfield.doc.html "FlowColumnInputField - Column input field implementation") - [FlowColumnOutputField_Column output field implementation_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowcolumnoutputfield.doc.html "FlowColumnOutputField - Column output field implementation") - [FlowFieldInputField_Field input field implementation_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfield.doc.html "FlowFieldInputField - Field input field implementation") - [FlowFieldOutputField_Field output field implementation_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfield.doc.html "FlowFieldOutputField - Field output field implementation") - [FlowInputField_A wrapper for an input field contained in a published flow._](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowinputfield.doc.html "FlowInputField - A wrapper for an input field contained in a published flow.") - [FlowOutputField_A wrapper for an output field contained in a published flow._](https://help.tableau.com/current/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/current/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/current/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.*") - [Metric_Metrics are time series data constructed from fields contained in views. \*Retired in Tableau Cloud February 2024 / Server 2024.2.\*_](metric.doc.html "Metric - Metrics are time series data constructed from fields contained in views. *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/current/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/current/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/current/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") - [Sheet_A sheet contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html "Sheet - A sheet contained in a published workbook.") - [Table_A table containing columns_](https://help.tableau.com/current/api/metadata_api/en-us/reference/table.doc.html "Table - A table containing columns") - [TableauSite_Site on Tableau server_](https://help.tableau.com/current/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/current/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/current/api/metadata_api/en-us/reference/tag.doc.html "Tag - A tag associated with content items") - [VirtualConnection_A virtual connection. \*Available in Tableau Cloud March 2022 / Server 2022.1 and later.\*_](virtualconnection.doc.html "VirtualConnection - A virtual connection. *Available in Tableau Cloud March 2022 / Server 2022.1 and later.*") - [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/current/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/current/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).") _menu_ Types OBJECT # FlowColumnInputField Column input field implementation ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type FlowColumnInputField implements [FlowInputField](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowinputfield.doc.html) { - # Unique identifier used by the metadata API - id: [ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html)! - # Name shown in server and desktop clients - name: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Identifier internal to flow - fieldId: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # The underlying wrapped column - column: [Column](https://help.tableau.com/current/api/metadata_api/en-us/reference/column.doc.html) - # Fields that are children of this field - # - # 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. - childFields( - filter: [FlowOutputField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowoutputfield_filter.doc.html), - orderBy: [FlowOutputFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowoutputfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[FlowOutputField](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowoutputfield.doc.html)!]! - # Fields that are children of this field - # - # 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. - childFieldsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [FlowOutputField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowoutputfield_filter.doc.html), - orderBy: [FlowOutputFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowoutputfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FlowOutputFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowoutputfieldsconnection.doc.html) - # Databases that are upstream from this outputField. - # - # 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/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Database](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html)!]! - # Databases that are upstream from this outputField. - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Database_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabasesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesconnection.doc.html) - # Tables that are upstream of this field - # - # 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/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DatabaseTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable.doc.html)!]! - # Tables that are upstream of this field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabaseTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesconnection.doc.html) - # Flows that are upstream from this outputField. - # - # 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/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Flow](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow.doc.html)!]! - # Flows that are upstream from this outputField. - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Flow_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FlowsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsconnection.doc.html) - # PublishedDatasources that are upstream from this outputField. - # - # 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/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[PublishedDatasource](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource.doc.html)!]! - # PublishedDatasources that are upstream from this outputField. - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [PublishedDatasource_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [PublishedDatasourcesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesconnection.doc.html) - # A flow to which these fields input - flow: [Flow](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow.doc.html) - } ` ## [_link_](#require-by) Require by - [Column_GraphQL type for a table column_](https://help.tableau.com/current/api/metadata_api/en-us/reference/column.doc.html "Column - GraphQL type for a table column") - [FlowColumnInputFieldsConnection_Connection Type for FlowColumnInputField_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowcolumninputfieldsconnection.doc.html "FlowColumnInputFieldsConnection - Connection Type for FlowColumnInputField") - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/api/metadata_api/en-us/reference/query.doc.html "Query - Query root for Metadata GraphQL interface") _menu_ Types INPUT\_OBJECT # FlowColumnInputField\_Filter Filter by GraphQL field and given value ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input FlowColumnInputField_Filter { - # Name shown in server and desktop clients - name: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Name shown in server and desktop clients - nameWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)] - # Unique identifier used by the metadata API - id: [ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html) - # Unique identifier used by the metadata API - idWithin: [[ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html)] - } ` ## [_link_](#require-by) Require by - [Column_GraphQL type for a table column_](https://help.tableau.com/current/api/metadata_api/en-us/reference/column.doc.html "Column - GraphQL type for a table column") - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/api/metadata_api/en-us/reference/query.doc.html "Query - Query root for Metadata GraphQL interface") _menu_ Types ENUM # FlowColumnInputFieldOrderField Enum for fields that can be used for sorting ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - enum FlowColumnInputFieldOrderField { - # Sort by id - ID - # Sort by name - NAME - } ` ## [_link_](#require-by) Require by - [FlowColumnInputFieldSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowcolumninputfieldsortorder.doc.html "FlowColumnInputFieldSortOrder - 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.") _menu_ Types OBJECT # FlowColumnInputFieldsConnection Connection Type for FlowColumnInputField ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type FlowColumnInputFieldsConnection { - # List of nodes - nodes: [[FlowColumnInputField](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowcolumninputfield.doc.html)!]! - # Information for pagination - pageInfo: [PageInfo](https://help.tableau.com/current/api/metadata_api/en-us/reference/pageinfo.doc.html)! - # Total number of objects in connection - totalCount: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html)! - } ` ## [_link_](#require-by) Require by - [Column_GraphQL type for a table column_](https://help.tableau.com/current/api/metadata_api/en-us/reference/column.doc.html "Column - GraphQL type for a table column") - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/api/metadata_api/en-us/reference/query.doc.html "Query - Query root for Metadata GraphQL interface") _menu_ Types INPUT\_OBJECT # FlowColumnInputFieldSortOrder 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. ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input FlowColumnInputFieldSortOrder { - # GraphQL field to sort on - field: [FlowColumnInputFieldOrderField](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowcolumninputfieldorderfield.doc.html)! - # Order direction to sort output - direction: [OrderDirection](https://help.tableau.com/current/api/metadata_api/en-us/reference/orderdirection.doc.html)! - } ` ## [_link_](#require-by) Require by - [Column_GraphQL type for a table column_](https://help.tableau.com/current/api/metadata_api/en-us/reference/column.doc.html "Column - GraphQL type for a table column") - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/api/metadata_api/en-us/reference/query.doc.html "Query - Query root for Metadata GraphQL interface") _menu_ Types OBJECT # FlowColumnOutputField Column output field implementation ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type FlowColumnOutputField implements [FlowOutputField](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowoutputfield.doc.html) { - # Unique identifier used by the metadata API - id: [ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html)! - # Name shown in server and desktop clients - name: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Identifier internal to flow - fieldId: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # The underlying wrapped column - column: [Column](https://help.tableau.com/current/api/metadata_api/en-us/reference/column.doc.html) - # Fields that are parents of this field - # - # 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. - parentFields( - filter: [FlowInputField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowinputfield_filter.doc.html), - orderBy: [FlowInputFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowinputfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[FlowInputField](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowinputfield.doc.html)!]! - # Fields that are parents of this field - # - # 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. - parentFieldsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [FlowInputField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowinputfield_filter.doc.html), - orderBy: [FlowInputFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowinputfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FlowInputFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowinputfieldsconnection.doc.html) - # Databases that are upstream from this outputField - # - # 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/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Database](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html)!]! - # Databases that are upstream from this outputField - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Database_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabasesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesconnection.doc.html) - # Tables that are upstream from this outputField - # - # 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/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DatabaseTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable.doc.html)!]! - # Tables that are upstream from this outputField - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabaseTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesconnection.doc.html) - # VirtualConnectionTables that are upstream of this outputField - # - # 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/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnectionTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable.doc.html)!]! - # VirtualConnectionTables that are upstream of this outputField - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnectionTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesconnection.doc.html) - # VirtualConnections that are upstream of this outputField - # - # 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. - upstreamVirtualConnections( - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection.doc.html)!]! - # VirtualConnections that are upstream of this outputField - # - # 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. - upstreamVirtualConnectionsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsconnection.doc.html) - # 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. - upstreamFlows( - filter: [Flow_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Flow](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow.doc.html)!]! - # 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. - upstreamFlowsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Flow_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FlowsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsconnection.doc.html) - # 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. - upstreamDatasources( - filter: [PublishedDatasource_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[PublishedDatasource](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource.doc.html)!]! - # 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. - upstreamDatasourcesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [PublishedDatasource_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [PublishedDatasourcesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesconnection.doc.html) - # Databases that are downstream from this outputField - # - # 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. - downstreamDatabases( - filter: [Database_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Database](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html)!]! - # Databases that are downstream from this outputField - # - # 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. - downstreamDatabasesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Database_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabasesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesconnection.doc.html) - # Tables that are downstream from this outputField - # - # 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. - downstreamTables( - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DatabaseTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable.doc.html)!]! - # Tables that are downstream from this outputField - # - # 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. - downstreamTablesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabaseTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesconnection.doc.html) - # Flows that are downstream from this outputField - # - # 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/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Flow](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow.doc.html)!]! - # Flows that are downstream from this outputField - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Flow_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FlowsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsconnection.doc.html) - # Datasources that are downstream from this outputField - # - # 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/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[PublishedDatasource](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource.doc.html)!]! - # Datasources that are downstream from this outputField - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [PublishedDatasource_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [PublishedDatasourcesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesconnection.doc.html) - # Lenses that are downstream from this outputField - # - # 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/current/api/metadata_api/en-us/reference/lens_filter.doc.html), - orderBy: [LensSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/lenssortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Lens](https://help.tableau.com/current/api/metadata_api/en-us/reference/lens.doc.html)!]! - # Lenses that are downstream from this outputField - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Lens_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/lens_filter.doc.html), - orderBy: [LensSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/lenssortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [LensesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensesconnection.doc.html) - # Dashboards that are downstream from this outputField - # - # 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/current/api/metadata_api/en-us/reference/dashboard_filter.doc.html), - orderBy: [DashboardSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboardsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Dashboard](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard.doc.html)!]! - # Dashboards that are downstream from this outputField - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Dashboard_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard_filter.doc.html), - orderBy: [DashboardSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboardsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DashboardsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboardsconnection.doc.html) - # Workbooks that are downstream from this outputField - # - # 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/current/api/metadata_api/en-us/reference/workbook_filter.doc.html), - orderBy: [WorkbookSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Workbook](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbook.doc.html)!]! - # Workbooks that are downstream from this outputField - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Workbook_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbook_filter.doc.html), - orderBy: [WorkbookSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [WorkbooksConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksconnection.doc.html) - # Sheets that are downstream from this outputField - # - # 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/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Sheet](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html)!]! - # Sheets that are downstream from this outputField - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Sheet_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [SheetsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsconnection.doc.html) - # Metrics that are downstream from this outputField - # - # 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/current/api/metadata_api/en-us/reference/metric_filter.doc.html), - orderBy: [MetricSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Metric](https://help.tableau.com/current/api/metadata_api/en-us/reference/metric.doc.html)!]! - # Metrics that are downstream from this outputField - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Metric_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metric_filter.doc.html), - orderBy: [MetricSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [MetricsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricsconnection.doc.html) - # VirtualConnectionTables that are downstream of this outputField - # - # 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/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnectionTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable.doc.html)!]! - # VirtualConnectionTables that are downstream of this outputField - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnectionTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesconnection.doc.html) - # VirtualConnections that are downstream of this outputField - # - # 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. - downstreamVirtualConnections( - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection.doc.html)!]! - # VirtualConnections that are downstream of this outputField - # - # 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. - downstreamVirtualConnectionsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsconnection.doc.html) - # Owners that are downstream from this outputField - # - # 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/current/api/metadata_api/en-us/reference/tableauuser_filter.doc.html), - orderBy: [TableauUserSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauusersortorder.doc.html) - ): [[TableauUser](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauuser.doc.html)!]! - # Owners that are downstream from this outputField - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [TableauUser_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauuser_filter.doc.html), - orderBy: [TableauUserSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauusersortorder.doc.html) - ): [TableauUsersConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauusersconnection.doc.html) - # The flow that outputs these fields - # - # 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: [Flow_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Flow](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow.doc.html)] - # The flow that outputs these fields - # - # 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. - flowConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Flow_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FlowsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsconnection.doc.html) - # The flow output step that contains this field - flowOutputStep: [FlowOutputStep](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowoutputstep.doc.html) - # Metric definitions downstream from this flow output field. - # - # 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/current/api/metadata_api/en-us/reference/metricdefinition_filter.doc.html), - orderBy: [MetricDefinitionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[MetricDefinition](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinition.doc.html)] - # Metric definitions downstream from this flow output field. - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [MetricDefinition_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinition_filter.doc.html), - orderBy: [MetricDefinitionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [MetricDefinitionsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsconnection.doc.html) - } ` ## [_link_](#require-by) Require by - [Column_GraphQL type for a table column_](https://help.tableau.com/current/api/metadata_api/en-us/reference/column.doc.html "Column - GraphQL type for a table column") - [FlowColumnOutputFieldsConnection_Connection Type for FlowColumnOutputField_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowcolumnoutputfieldsconnection.doc.html "FlowColumnOutputFieldsConnection - Connection Type for FlowColumnOutputField") - [Metric_Metrics are time series data constructed from fields contained in views. \*Retired in Tableau Cloud February 2024 / Server 2024.2.\*_](metric.doc.html "Metric - Metrics are time series data constructed from fields contained in views. *Retired in Tableau Cloud February 2024 / Server 2024.2.*") - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/api/metadata_api/en-us/reference/query.doc.html "Query - Query root for Metadata GraphQL interface") _menu_ Types INPUT\_OBJECT # FlowColumnOutputField\_Filter Filter by GraphQL field and given value ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input FlowColumnOutputField_Filter { - # Name shown in server and desktop clients - name: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Name shown in server and desktop clients - nameWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)] - # Unique identifier used by the metadata API - id: [ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html) - # Unique identifier used by the metadata API - idWithin: [[ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html)] - } ` ## [_link_](#require-by) Require by - [Column_GraphQL type for a table column_](https://help.tableau.com/current/api/metadata_api/en-us/reference/column.doc.html "Column - GraphQL type for a table column") - [Metric_Metrics are time series data constructed from fields contained in views. \*Retired in Tableau Cloud February 2024 / Server 2024.2.\*_](metric.doc.html "Metric - Metrics are time series data constructed from fields contained in views. *Retired in Tableau Cloud February 2024 / Server 2024.2.*") - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/api/metadata_api/en-us/reference/query.doc.html "Query - Query root for Metadata GraphQL interface") _menu_ Types ENUM # FlowColumnOutputFieldOrderField Enum for fields that can be used for sorting ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - enum FlowColumnOutputFieldOrderField { - # Sort by id - ID - # Sort by name - NAME - } ` ## [_link_](#require-by) Require by - [FlowColumnOutputFieldSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowcolumnoutputfieldsortorder.doc.html "FlowColumnOutputFieldSortOrder - 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.") _menu_ Types OBJECT # FlowColumnOutputFieldsConnection Connection Type for FlowColumnOutputField ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type FlowColumnOutputFieldsConnection { - # List of nodes - nodes: [[FlowColumnOutputField](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowcolumnoutputfield.doc.html)!]! - # Information for pagination - pageInfo: [PageInfo](https://help.tableau.com/current/api/metadata_api/en-us/reference/pageinfo.doc.html)! - # Total number of objects in connection - totalCount: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html)! - } ` ## [_link_](#require-by) Require by - [Column_GraphQL type for a table column_](https://help.tableau.com/current/api/metadata_api/en-us/reference/column.doc.html "Column - GraphQL type for a table column") - [Metric_Metrics are time series data constructed from fields contained in views. \*Retired in Tableau Cloud February 2024 / Server 2024.2.\*_](metric.doc.html "Metric - Metrics are time series data constructed from fields contained in views. *Retired in Tableau Cloud February 2024 / Server 2024.2.*") - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/api/metadata_api/en-us/reference/query.doc.html "Query - Query root for Metadata GraphQL interface") _menu_ Types INPUT\_OBJECT # FlowColumnOutputFieldSortOrder 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. ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input FlowColumnOutputFieldSortOrder { - # GraphQL field to sort on - field: [FlowColumnOutputFieldOrderField](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowcolumnoutputfieldorderfield.doc.html)! - # Order direction to sort output - direction: [OrderDirection](https://help.tableau.com/current/api/metadata_api/en-us/reference/orderdirection.doc.html)! - } ` ## [_link_](#require-by) Require by - [Column_GraphQL type for a table column_](https://help.tableau.com/current/api/metadata_api/en-us/reference/column.doc.html "Column - GraphQL type for a table column") - [Metric_Metrics are time series data constructed from fields contained in views. \*Retired in Tableau Cloud February 2024 / Server 2024.2.\*_](metric.doc.html "Metric - Metrics are time series data constructed from fields contained in views. *Retired in Tableau Cloud February 2024 / Server 2024.2.*") - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/api/metadata_api/en-us/reference/query.doc.html "Query - Query root for Metadata GraphQL interface") _menu_ Types OBJECT # FlowFieldInputField Field input field implementation ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type FlowFieldInputField implements [FlowInputField](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowinputfield.doc.html) { - # Unique identifier used by the metadata API - id: [ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html)! - # Name shown in server and desktop clients - name: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Identifier internal to flow - fieldId: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # The underlying wrapped field - field: [Field](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.doc.html) - # Fields that are children of this field - # - # 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. - childFields( - filter: [FlowOutputField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowoutputfield_filter.doc.html), - orderBy: [FlowOutputFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowoutputfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[FlowOutputField](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowoutputfield.doc.html)!]! - # Fields that are children of this field - # - # 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. - childFieldsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [FlowOutputField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowoutputfield_filter.doc.html), - orderBy: [FlowOutputFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowoutputfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FlowOutputFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowoutputfieldsconnection.doc.html) - # Databases that are upstream from this outputField. - # - # 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/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Database](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html)!]! - # Databases that are upstream from this outputField. - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Database_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabasesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesconnection.doc.html) - # Tables that are upstream of this field. - # - # 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/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DatabaseTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable.doc.html)!]! - # Tables that are upstream of this field. - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabaseTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesconnection.doc.html) - # Flows that are upstream from this outputField. - # - # 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/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Flow](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow.doc.html)!]! - # Flows that are upstream from this outputField. - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Flow_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FlowsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsconnection.doc.html) - # Datasources that are upstream from this outputField. - # - # 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/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[PublishedDatasource](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource.doc.html)!]! - # Datasources that are upstream from this outputField. - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [PublishedDatasource_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [PublishedDatasourcesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesconnection.doc.html) - # A flow to which these fields input - flow: [Flow](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow.doc.html) - } ` ## [_link_](#require-by) Require by - [AnalyticsField_Base GraphQL type for a field containing analytics metadata_](https://help.tableau.com/current/api/metadata_api/en-us/reference/analyticsfield.doc.html "AnalyticsField - Base GraphQL type for a field containing analytics metadata") - [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/current/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/current/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") - [ColumnField_ColumnFields are a type of field which directly connects to a column in some type of table._](https://help.tableau.com/current/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/current/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/current/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") - [DataField_Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField._](https://help.tableau.com/current/api/metadata_api/en-us/reference/datafield.doc.html "DataField - Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField.") - [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/current/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/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [FieldReferencingField_Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula._](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield.doc.html "FieldReferencingField - Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula.") - [FlowFieldInputFieldsConnection_Connection Type for FlowFieldInputField_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfieldsconnection.doc.html "FlowFieldInputFieldsConnection - Connection Type for FlowFieldInputField") - [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/current/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/current/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") - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/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/current/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") _menu_ Types INPUT\_OBJECT # FlowFieldInputField\_Filter Filter by GraphQL field and given value ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input FlowFieldInputField_Filter { - # Name shown in server and desktop clients - name: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Name shown in server and desktop clients - nameWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)] - # Unique identifier used by the metadata API - id: [ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html) - # Unique identifier used by the metadata API - idWithin: [[ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html)] - } ` ## [_link_](#require-by) Require by - [AnalyticsField_Base GraphQL type for a field containing analytics metadata_](https://help.tableau.com/current/api/metadata_api/en-us/reference/analyticsfield.doc.html "AnalyticsField - Base GraphQL type for a field containing analytics metadata") - [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/current/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/current/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") - [ColumnField_ColumnFields are a type of field which directly connects to a column in some type of table._](https://help.tableau.com/current/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/current/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/current/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") - [DataField_Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField._](https://help.tableau.com/current/api/metadata_api/en-us/reference/datafield.doc.html "DataField - Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField.") - [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/current/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/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [FieldReferencingField_Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula._](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield.doc.html "FieldReferencingField - Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula.") - [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/current/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/current/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") - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/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/current/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") _menu_ Types ENUM # FlowFieldInputFieldOrderField Enum for fields that can be used for sorting ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - enum FlowFieldInputFieldOrderField { - # Sort by id - ID - # Sort by name - NAME - } ` ## [_link_](#require-by) Require by - [FlowFieldInputFieldSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfieldsortorder.doc.html "FlowFieldInputFieldSortOrder - 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.") _menu_ Types OBJECT # FlowFieldInputFieldsConnection Connection Type for FlowFieldInputField ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type FlowFieldInputFieldsConnection { - # List of nodes - nodes: [[FlowFieldInputField](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfield.doc.html)!]! - # Information for pagination - pageInfo: [PageInfo](https://help.tableau.com/current/api/metadata_api/en-us/reference/pageinfo.doc.html)! - # Total number of objects in connection - totalCount: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html)! - } ` ## [_link_](#require-by) Require by - [AnalyticsField_Base GraphQL type for a field containing analytics metadata_](https://help.tableau.com/current/api/metadata_api/en-us/reference/analyticsfield.doc.html "AnalyticsField - Base GraphQL type for a field containing analytics metadata") - [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/current/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/current/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") - [ColumnField_ColumnFields are a type of field which directly connects to a column in some type of table._](https://help.tableau.com/current/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/current/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/current/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") - [DataField_Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField._](https://help.tableau.com/current/api/metadata_api/en-us/reference/datafield.doc.html "DataField - Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField.") - [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/current/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/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [FieldReferencingField_Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula._](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield.doc.html "FieldReferencingField - Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula.") - [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/current/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/current/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") - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/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/current/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") _menu_ Types INPUT\_OBJECT # FlowFieldInputFieldSortOrder 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. ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input FlowFieldInputFieldSortOrder { - # GraphQL field to sort on - field: [FlowFieldInputFieldOrderField](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfieldorderfield.doc.html)! - # Order direction to sort output - direction: [OrderDirection](https://help.tableau.com/current/api/metadata_api/en-us/reference/orderdirection.doc.html)! - } ` ## [_link_](#require-by) Require by - [AnalyticsField_Base GraphQL type for a field containing analytics metadata_](https://help.tableau.com/current/api/metadata_api/en-us/reference/analyticsfield.doc.html "AnalyticsField - Base GraphQL type for a field containing analytics metadata") - [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/current/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/current/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") - [ColumnField_ColumnFields are a type of field which directly connects to a column in some type of table._](https://help.tableau.com/current/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/current/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/current/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") - [DataField_Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField._](https://help.tableau.com/current/api/metadata_api/en-us/reference/datafield.doc.html "DataField - Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField.") - [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/current/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/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [FieldReferencingField_Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula._](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield.doc.html "FieldReferencingField - Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula.") - [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/current/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/current/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") - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/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/current/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") _menu_ Types OBJECT # FlowFieldOutputField Field output field implementation ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type FlowFieldOutputField implements [FlowOutputField](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowoutputfield.doc.html) { - # Unique identifier used by the metadata API - id: [ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html)! - # Name shown in server and desktop clients - name: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Identifier internal to flow - fieldId: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # The underlying wrapped field - field: [Field](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.doc.html) - # Fields that are parents of this field - # - # 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. - parentFields( - filter: [FlowInputField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowinputfield_filter.doc.html), - orderBy: [FlowInputFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowinputfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[FlowInputField](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowinputfield.doc.html)!]! - # Fields that are parents of this field - # - # 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. - parentFieldsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [FlowInputField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowinputfield_filter.doc.html), - orderBy: [FlowInputFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowinputfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FlowInputFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowinputfieldsconnection.doc.html) - # Databases that are upstream from this outputField - # - # 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/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Database](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html)!]! - # Databases that are upstream from this outputField - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Database_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabasesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesconnection.doc.html) - # Tables that are upstream from this outputField - # - # 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/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DatabaseTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable.doc.html)!]! - # Tables that are upstream from this outputField - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabaseTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesconnection.doc.html) - # VirtualConnectionTables that are upstream of this outputField - # - # 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/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnectionTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable.doc.html)!]! - # VirtualConnectionTables that are upstream of this outputField - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnectionTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesconnection.doc.html) - # VirtualConnections that are upstream of this outputField - # - # 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. - upstreamVirtualConnections( - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection.doc.html)!]! - # VirtualConnections that are upstream of this outputField - # - # 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. - upstreamVirtualConnectionsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsconnection.doc.html) - # 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. - upstreamFlows( - filter: [Flow_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Flow](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow.doc.html)!]! - # 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. - upstreamFlowsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Flow_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FlowsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsconnection.doc.html) - # Datasources that are upstream from this output field. - # - # 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/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[PublishedDatasource](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource.doc.html)!]! - # Datasources that are upstream from this output field. - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [PublishedDatasource_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [PublishedDatasourcesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesconnection.doc.html) - # Databases that are downstream from this outputField - # - # 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. - downstreamDatabases( - filter: [Database_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Database](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html)!]! - # Databases that are downstream from this outputField - # - # 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. - downstreamDatabasesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Database_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabasesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesconnection.doc.html) - # Tables that are downstream from this outputField - # - # 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. - downstreamTables( - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DatabaseTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable.doc.html)!]! - # Tables that are downstream from this outputField - # - # 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. - downstreamTablesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabaseTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesconnection.doc.html) - # Flows that are downstream from this outputField - # - # 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/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Flow](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow.doc.html)!]! - # Flows that are downstream from this outputField - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Flow_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FlowsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsconnection.doc.html) - # Datasources that are downstream from this outputField - # - # 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/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[PublishedDatasource](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource.doc.html)!]! - # Datasources that are downstream from this outputField - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [PublishedDatasource_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [PublishedDatasourcesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesconnection.doc.html) - # Lenses that are downstream from this outputField - # - # 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/current/api/metadata_api/en-us/reference/lens_filter.doc.html), - orderBy: [LensSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/lenssortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Lens](https://help.tableau.com/current/api/metadata_api/en-us/reference/lens.doc.html)!]! - # Lenses that are downstream from this outputField - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Lens_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/lens_filter.doc.html), - orderBy: [LensSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/lenssortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [LensesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensesconnection.doc.html) - # Workbooks that are downstream from this outputField - # - # 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/current/api/metadata_api/en-us/reference/workbook_filter.doc.html), - orderBy: [WorkbookSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Workbook](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbook.doc.html)!]! - # Workbooks that are downstream from this outputField - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Workbook_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbook_filter.doc.html), - orderBy: [WorkbookSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [WorkbooksConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksconnection.doc.html) - # Dashboards that are downstream from this outputField - # - # 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/current/api/metadata_api/en-us/reference/dashboard_filter.doc.html), - orderBy: [DashboardSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboardsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Dashboard](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard.doc.html)!]! - # Dashboards that are downstream from this outputField - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Dashboard_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard_filter.doc.html), - orderBy: [DashboardSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboardsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DashboardsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboardsconnection.doc.html) - # Sheets that are downstream from this outputField - # - # 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/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Sheet](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html)!]! - # Sheets that are downstream from this outputField - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Sheet_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [SheetsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsconnection.doc.html) - # Metrics that are downstream from this outputField - # - # 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/current/api/metadata_api/en-us/reference/metric_filter.doc.html), - orderBy: [MetricSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Metric](https://help.tableau.com/current/api/metadata_api/en-us/reference/metric.doc.html)!]! - # Metrics that are downstream from this outputField - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Metric_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metric_filter.doc.html), - orderBy: [MetricSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [MetricsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricsconnection.doc.html) - # VirtualConnectionTables that are downstream of this outputField - # - # 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/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnectionTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable.doc.html)!]! - # VirtualConnectionTables that are downstream of this outputField - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnectionTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesconnection.doc.html) - # VirtualConnections that are downstream of this outputField - # - # 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. - downstreamVirtualConnections( - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection.doc.html)!]! - # VirtualConnections that are downstream of this outputField - # - # 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. - downstreamVirtualConnectionsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsconnection.doc.html) - # Owners that are downstream from this outputField - # - # 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/current/api/metadata_api/en-us/reference/tableauuser_filter.doc.html), - orderBy: [TableauUserSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauusersortorder.doc.html) - ): [[TableauUser](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauuser.doc.html)!]! - # Owners that are downstream from this outputField - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [TableauUser_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauuser_filter.doc.html), - orderBy: [TableauUserSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauusersortorder.doc.html) - ): [TableauUsersConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauusersconnection.doc.html) - # The flow that outputs these fields - # - # 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: [Flow_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Flow](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow.doc.html)] - # The flow that outputs these fields - # - # 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. - flowConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Flow_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FlowsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsconnection.doc.html) - # The flow output step that contains this field - flowOutputStep: [FlowOutputStep](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowoutputstep.doc.html) - # Metric definitions downstream from this flow output field. - # - # 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/current/api/metadata_api/en-us/reference/metricdefinition_filter.doc.html), - orderBy: [MetricDefinitionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[MetricDefinition](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinition.doc.html)] - # Metric definitions downstream from this flow output field. - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [MetricDefinition_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinition_filter.doc.html), - orderBy: [MetricDefinitionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [MetricDefinitionsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsconnection.doc.html) - } ` ## [_link_](#require-by) Require by - [AnalyticsField_Base GraphQL type for a field containing analytics metadata_](https://help.tableau.com/current/api/metadata_api/en-us/reference/analyticsfield.doc.html "AnalyticsField - Base GraphQL type for a field containing analytics metadata") - [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/current/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/current/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") - [ColumnField_ColumnFields are a type of field which directly connects to a column in some type of table._](https://help.tableau.com/current/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/current/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/current/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") - [DataField_Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField._](https://help.tableau.com/current/api/metadata_api/en-us/reference/datafield.doc.html "DataField - Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField.") - [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/current/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/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [FieldReferencingField_Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula._](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield.doc.html "FieldReferencingField - Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula.") - [FlowFieldOutputFieldsConnection_Connection Type for FlowFieldOutputField_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfieldsconnection.doc.html "FlowFieldOutputFieldsConnection - Connection Type for FlowFieldOutputField") - [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/current/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/current/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") - [Metric_Metrics are time series data constructed from fields contained in views. \*Retired in Tableau Cloud February 2024 / Server 2024.2.\*_](metric.doc.html "Metric - Metrics are time series data constructed from fields contained in views. *Retired in Tableau Cloud February 2024 / Server 2024.2.*") - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/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/current/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") _menu_ Types INPUT\_OBJECT # FlowFieldOutputField\_Filter Filter by GraphQL field and given value ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input FlowFieldOutputField_Filter { - # Name shown in server and desktop clients - name: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Name shown in server and desktop clients - nameWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)] - # Unique identifier used by the metadata API - id: [ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html) - # Unique identifier used by the metadata API - idWithin: [[ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html)] - } ` ## [_link_](#require-by) Require by - [AnalyticsField_Base GraphQL type for a field containing analytics metadata_](https://help.tableau.com/current/api/metadata_api/en-us/reference/analyticsfield.doc.html "AnalyticsField - Base GraphQL type for a field containing analytics metadata") - [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/current/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/current/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") - [ColumnField_ColumnFields are a type of field which directly connects to a column in some type of table._](https://help.tableau.com/current/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/current/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/current/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") - [DataField_Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField._](https://help.tableau.com/current/api/metadata_api/en-us/reference/datafield.doc.html "DataField - Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField.") - [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/current/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/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [FieldReferencingField_Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula._](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield.doc.html "FieldReferencingField - Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula.") - [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/current/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/current/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") - [Metric_Metrics are time series data constructed from fields contained in views. \*Retired in Tableau Cloud February 2024 / Server 2024.2.\*_](metric.doc.html "Metric - Metrics are time series data constructed from fields contained in views. *Retired in Tableau Cloud February 2024 / Server 2024.2.*") - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/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/current/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") _menu_ Types ENUM # FlowFieldOutputFieldOrderField Enum for fields that can be used for sorting ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - enum FlowFieldOutputFieldOrderField { - # Sort by id - ID - # Sort by name - NAME - } ` ## [_link_](#require-by) Require by - [FlowFieldOutputFieldSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfieldsortorder.doc.html "FlowFieldOutputFieldSortOrder - 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.") _menu_ Types OBJECT # FlowFieldOutputFieldsConnection Connection Type for FlowFieldOutputField ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type FlowFieldOutputFieldsConnection { - # List of nodes - nodes: [[FlowFieldOutputField](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfield.doc.html)!]! - # Information for pagination - pageInfo: [PageInfo](https://help.tableau.com/current/api/metadata_api/en-us/reference/pageinfo.doc.html)! - # Total number of objects in connection - totalCount: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html)! - } ` ## [_link_](#require-by) Require by - [AnalyticsField_Base GraphQL type for a field containing analytics metadata_](https://help.tableau.com/current/api/metadata_api/en-us/reference/analyticsfield.doc.html "AnalyticsField - Base GraphQL type for a field containing analytics metadata") - [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/current/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/current/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") - [ColumnField_ColumnFields are a type of field which directly connects to a column in some type of table._](https://help.tableau.com/current/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/current/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/current/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") - [DataField_Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField._](https://help.tableau.com/current/api/metadata_api/en-us/reference/datafield.doc.html "DataField - Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField.") - [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/current/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/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [FieldReferencingField_Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula._](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield.doc.html "FieldReferencingField - Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula.") - [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/current/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/current/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") - [Metric_Metrics are time series data constructed from fields contained in views. \*Retired in Tableau Cloud February 2024 / Server 2024.2.\*_](metric.doc.html "Metric - Metrics are time series data constructed from fields contained in views. *Retired in Tableau Cloud February 2024 / Server 2024.2.*") - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/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/current/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") _menu_ Types INPUT\_OBJECT # FlowFieldOutputFieldSortOrder 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. ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input FlowFieldOutputFieldSortOrder { - # GraphQL field to sort on - field: [FlowFieldOutputFieldOrderField](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfieldorderfield.doc.html)! - # Order direction to sort output - direction: [OrderDirection](https://help.tableau.com/current/api/metadata_api/en-us/reference/orderdirection.doc.html)! - } ` ## [_link_](#require-by) Require by - [AnalyticsField_Base GraphQL type for a field containing analytics metadata_](https://help.tableau.com/current/api/metadata_api/en-us/reference/analyticsfield.doc.html "AnalyticsField - Base GraphQL type for a field containing analytics metadata") - [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/current/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/current/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") - [ColumnField_ColumnFields are a type of field which directly connects to a column in some type of table._](https://help.tableau.com/current/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/current/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/current/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") - [DataField_Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField._](https://help.tableau.com/current/api/metadata_api/en-us/reference/datafield.doc.html "DataField - Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField.") - [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/current/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/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [FieldReferencingField_Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula._](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield.doc.html "FieldReferencingField - Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula.") - [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/current/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/current/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") - [Metric_Metrics are time series data constructed from fields contained in views. \*Retired in Tableau Cloud February 2024 / Server 2024.2.\*_](metric.doc.html "Metric - Metrics are time series data constructed from fields contained in views. *Retired in Tableau Cloud February 2024 / Server 2024.2.*") - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/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/current/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") _menu_ Types INTERFACE # FlowInputField A wrapper for an input field contained in a published flow. ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - interface FlowInputField { - # Unique identifier used by the metadata API - id: [ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html)! - # Name shown in server and desktop clients - name: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Fields that are children of this field - # - # 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. - childFields( - filter: [FlowOutputField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowoutputfield_filter.doc.html), - orderBy: [FlowOutputFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowoutputfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[FlowOutputField](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowoutputfield.doc.html)!]! - # Fields that are children of this field - # - # 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. - childFieldsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [FlowOutputField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowoutputfield_filter.doc.html), - orderBy: [FlowOutputFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowoutputfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FlowOutputFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowoutputfieldsconnection.doc.html) - # Databases that are upstream from this inputField. - # - # 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/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Database](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html)!]! - # Databases that are upstream from this inputField. - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Database_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabasesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesconnection.doc.html) - # Tables that are upstream of this field. - # - # 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/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DatabaseTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable.doc.html)!]! - # Tables that are upstream of this field. - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabaseTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesconnection.doc.html) - # Flows that are upstream from this inputField. - # - # 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/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Flow](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow.doc.html)!]! - # Flows that are upstream from this inputField. - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Flow_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FlowsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsconnection.doc.html) - # Flows that are upstream from this inputField. - # - # 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/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[PublishedDatasource](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource.doc.html)!]! - # Flows that are upstream from this inputField. - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [PublishedDatasource_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [PublishedDatasourcesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesconnection.doc.html) - # A flow to which these fields input - flow: [Flow](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow.doc.html) - } ` ## [_link_](#require-by) Require by - [Flow_Flows are used to prepare data, which can include aggregation, cleaning, preprocessing, etc._](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow.doc.html "Flow - Flows are used to prepare data, which can include aggregation, cleaning, preprocessing, etc.") - [FlowColumnInputField_Column input field implementation_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowcolumninputfield.doc.html "FlowColumnInputField - Column input field implementation") - [FlowColumnOutputField_Column output field implementation_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowcolumnoutputfield.doc.html "FlowColumnOutputField - Column output field implementation") - [FlowFieldInputField_Field input field implementation_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfield.doc.html "FlowFieldInputField - Field input field implementation") - [FlowFieldOutputField_Field output field implementation_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfield.doc.html "FlowFieldOutputField - Field output field implementation") - [FlowInputFieldsConnection_Connection Type for FlowInputField_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowinputfieldsconnection.doc.html "FlowInputFieldsConnection - Connection Type for FlowInputField") - [FlowOutputField_A wrapper for an output field contained in a published flow._](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowoutputfield.doc.html "FlowOutputField - A wrapper for an output field contained in a published flow.") _menu_ Types INPUT\_OBJECT # FlowInputField\_Filter Filter by GraphQL field and given value ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input FlowInputField_Filter { - # Name shown in server and desktop clients - name: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Name shown in server and desktop clients - nameWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)] - # Unique identifier used by the metadata API - id: [ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html) - # Unique identifier used by the metadata API - idWithin: [[ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html)] - } ` ## [_link_](#require-by) Require by - [Flow_Flows are used to prepare data, which can include aggregation, cleaning, preprocessing, etc._](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/flowcolumnoutputfield.doc.html "FlowColumnOutputField - Column output field implementation") - [FlowFieldOutputField_Field output field implementation_](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/flowoutputfield.doc.html "FlowOutputField - A wrapper for an output field contained in a published flow.") _menu_ Types ENUM # FlowInputFieldOrderField Enum for fields that can be used for sorting ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - enum FlowInputFieldOrderField { - # Sort by id - ID - # Sort by name - NAME - } ` ## [_link_](#require-by) Require by - [FlowInputFieldSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowinputfieldsortorder.doc.html "FlowInputFieldSortOrder - 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.") _menu_ Types OBJECT # FlowInputFieldsConnection Connection Type for FlowInputField ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type FlowInputFieldsConnection { - # List of nodes - nodes: [[FlowInputField](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowinputfield.doc.html)!]! - # Information for pagination - pageInfo: [PageInfo](https://help.tableau.com/current/api/metadata_api/en-us/reference/pageinfo.doc.html)! - # Total number of objects in connection - totalCount: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html)! - } ` ## [_link_](#require-by) Require by - [Flow_Flows are used to prepare data, which can include aggregation, cleaning, preprocessing, etc._](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/flowcolumnoutputfield.doc.html "FlowColumnOutputField - Column output field implementation") - [FlowFieldOutputField_Field output field implementation_](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/flowoutputfield.doc.html "FlowOutputField - A wrapper for an output field contained in a published flow.") _menu_ Types INPUT\_OBJECT # FlowInputFieldSortOrder 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. ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input FlowInputFieldSortOrder { - # GraphQL field to sort on - field: [FlowInputFieldOrderField](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowinputfieldorderfield.doc.html)! - # Order direction to sort output - direction: [OrderDirection](https://help.tableau.com/current/api/metadata_api/en-us/reference/orderdirection.doc.html)! - } ` ## [_link_](#require-by) Require by - [Flow_Flows are used to prepare data, which can include aggregation, cleaning, preprocessing, etc._](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/flowcolumnoutputfield.doc.html "FlowColumnOutputField - Column output field implementation") - [FlowFieldOutputField_Field output field implementation_](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/flowoutputfield.doc.html "FlowOutputField - A wrapper for an output field contained in a published flow.") _menu_ Types ENUM # FlowOrderField Enum for fields that can be used for sorting ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - enum FlowOrderField { - # Sort by containerName - CONTAINER_NAME - # Sort by containsUnsupportedCustomSql - CONTAINS_UNSUPPORTED_CUSTOM_SQL - # Sort by hasActiveWarning - HAS_ACTIVE_WARNING - # Sort by id - ID - # Sort by luid - LUID - # Sort by name - NAME - # Sort by projectName - PROJECT_NAME - # Sort by vizportalUrlId - VIZPORTAL_URL_ID - } ` ## [_link_](#require-by) Require by - [FlowSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html "FlowSortOrder - 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.") _menu_ Types INTERFACE # FlowOutputField A wrapper for an output field contained in a published flow. ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - interface FlowOutputField { - # Unique identifier used by the metadata API - id: [ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html)! - # Name shown in server and desktop clients - name: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Fields that are parents of this field - # - # 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. - parentFields( - filter: [FlowInputField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowinputfield_filter.doc.html), - orderBy: [FlowInputFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowinputfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[FlowInputField](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowinputfield.doc.html)!]! - # Fields that are parents of this field - # - # 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. - parentFieldsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [FlowInputField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowinputfield_filter.doc.html), - orderBy: [FlowInputFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowinputfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FlowInputFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowinputfieldsconnection.doc.html) - # Databases that are upstream from this outputField - # - # 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/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Database](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html)!]! - # Databases that are upstream from this outputField - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Database_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabasesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesconnection.doc.html) - # Tables that are upstream from this outputField - # - # 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/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DatabaseTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable.doc.html)!]! - # Tables that are upstream from this outputField - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabaseTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesconnection.doc.html) - # VirtualConnectionTables that are upstream of this outputField - # - # 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/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnectionTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable.doc.html)!]! - # VirtualConnectionTables that are upstream of this outputField - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnectionTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesconnection.doc.html) - # VirtualConnections that are upstream of this outputField - # - # 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. - upstreamVirtualConnections( - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection.doc.html)!]! - # VirtualConnections that are upstream of this outputField - # - # 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. - upstreamVirtualConnectionsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsconnection.doc.html) - # Flows that are upstream from this outputField. - # - # 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/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Flow](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow.doc.html)!]! - # Flows that are upstream from this outputField. - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Flow_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FlowsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsconnection.doc.html) - # Datasources that are upstream from this outputField - # - # 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/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[PublishedDatasource](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource.doc.html)!]! - # Datasources that are upstream from this outputField - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [PublishedDatasource_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [PublishedDatasourcesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesconnection.doc.html) - # Databases that are downstream from this outputField - # - # 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. - downstreamDatabases( - filter: [Database_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Database](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html)!]! - # Databases that are downstream from this outputField - # - # 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. - downstreamDatabasesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Database_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabasesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesconnection.doc.html) - # Tables that are downstream from this outputField - # - # 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. - downstreamTables( - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DatabaseTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable.doc.html)!]! - # Tables that are downstream from this outputField - # - # 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. - downstreamTablesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabaseTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesconnection.doc.html) - # Flows that are downstream from this outputField - # - # 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/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Flow](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow.doc.html)!]! - # Flows that are downstream from this outputField - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Flow_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FlowsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsconnection.doc.html) - # Datasources that are downstream from this outputField - # - # 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/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[PublishedDatasource](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource.doc.html)!]! - # Datasources that are downstream from this outputField - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [PublishedDatasource_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [PublishedDatasourcesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesconnection.doc.html) - # Lenses that are downstream from this outputField - # - # 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/current/api/metadata_api/en-us/reference/lens_filter.doc.html), - orderBy: [LensSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/lenssortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Lens](https://help.tableau.com/current/api/metadata_api/en-us/reference/lens.doc.html)!]! - # Lenses that are downstream from this outputField - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Lens_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/lens_filter.doc.html), - orderBy: [LensSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/lenssortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [LensesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensesconnection.doc.html) - # Dashboards that are downstream from this outputField - # - # 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/current/api/metadata_api/en-us/reference/dashboard_filter.doc.html), - orderBy: [DashboardSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboardsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Dashboard](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard.doc.html)!]! - # Dashboards that are downstream from this outputField - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Dashboard_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard_filter.doc.html), - orderBy: [DashboardSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboardsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DashboardsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboardsconnection.doc.html) - # Workbooks that are downstream from this outputField - # - # 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/current/api/metadata_api/en-us/reference/workbook_filter.doc.html), - orderBy: [WorkbookSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Workbook](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbook.doc.html)!]! - # Workbooks that are downstream from this outputField - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Workbook_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbook_filter.doc.html), - orderBy: [WorkbookSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [WorkbooksConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksconnection.doc.html) - # Sheets that are downstream from this outputField - # - # 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/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Sheet](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html)!]! - # Sheets that are downstream from this outputField - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Sheet_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [SheetsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsconnection.doc.html) - # Metrics that are downstream from this outputField - # - # 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/current/api/metadata_api/en-us/reference/metric_filter.doc.html), - orderBy: [MetricSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Metric](https://help.tableau.com/current/api/metadata_api/en-us/reference/metric.doc.html)!]! - # Metrics that are downstream from this outputField - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Metric_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metric_filter.doc.html), - orderBy: [MetricSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [MetricsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricsconnection.doc.html) - # VirtualConnectionTables that are downstream of this outputField - # - # 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/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnectionTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable.doc.html)!]! - # VirtualConnectionTables that are downstream of this outputField - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnectionTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesconnection.doc.html) - # VirtualConnections that are downstream of this outputField - # - # 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. - downstreamVirtualConnections( - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection.doc.html)!]! - # VirtualConnections that are downstream of this outputField - # - # 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. - downstreamVirtualConnectionsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsconnection.doc.html) - # Owners that are downstream from this outputField - # - # 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/current/api/metadata_api/en-us/reference/tableauuser_filter.doc.html), - orderBy: [TableauUserSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauusersortorder.doc.html) - ): [[TableauUser](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauuser.doc.html)!]! - # Owners that are downstream from this outputField - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [TableauUser_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauuser_filter.doc.html), - orderBy: [TableauUserSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauusersortorder.doc.html) - ): [TableauUsersConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauusersconnection.doc.html) - # The flow that outputs these fields - # - # 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: [Flow_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Flow](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow.doc.html)] - # The flow that outputs these fields - # - # 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. - flowConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Flow_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FlowsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsconnection.doc.html) - # The flow output step that contains this field - flowOutputStep: [FlowOutputStep](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowoutputstep.doc.html) - # Metric definitions downstream from this flow output field. - # - # 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/current/api/metadata_api/en-us/reference/metricdefinition_filter.doc.html), - orderBy: [MetricDefinitionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[MetricDefinition](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinition.doc.html)] - # Metric definitions downstream from this flow output field. - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [MetricDefinition_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinition_filter.doc.html), - orderBy: [MetricDefinitionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [MetricDefinitionsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsconnection.doc.html) - } ` ## [_link_](#require-by) Require by - [Flow_Flows are used to prepare data, which can include aggregation, cleaning, preprocessing, etc._](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow.doc.html "Flow - Flows are used to prepare data, which can include aggregation, cleaning, preprocessing, etc.") - [FlowColumnInputField_Column input field implementation_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowcolumninputfield.doc.html "FlowColumnInputField - Column input field implementation") - [FlowColumnOutputField_Column output field implementation_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowcolumnoutputfield.doc.html "FlowColumnOutputField - Column output field implementation") - [FlowFieldInputField_Field input field implementation_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfield.doc.html "FlowFieldInputField - Field input field implementation") - [FlowFieldOutputField_Field output field implementation_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfield.doc.html "FlowFieldOutputField - Field output field implementation") - [FlowInputField_A wrapper for an input field contained in a published flow._](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowinputfield.doc.html "FlowInputField - A wrapper for an input field contained in a published flow.") - [FlowOutputFieldsConnection_Connection Type for FlowOutputField_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowoutputfieldsconnection.doc.html "FlowOutputFieldsConnection - Connection Type for FlowOutputField") - [FlowOutputStep_A flow output step_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowoutputstep.doc.html "FlowOutputStep - A flow output step") - [Metric_Metrics are time series data constructed from fields contained in views. \*Retired in Tableau Cloud February 2024 / Server 2024.2.\*_](metric.doc.html "Metric - Metrics are time series data constructed from fields contained in views. *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.*") _menu_ Types INPUT\_OBJECT # FlowOutputField\_Filter Filter by GraphQL field and given value ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input FlowOutputField_Filter { - # Name shown in server and desktop clients - name: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Name shown in server and desktop clients - nameWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)] - # Unique identifier used by the metadata API - id: [ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html) - # Unique identifier used by the metadata API - idWithin: [[ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html)] - } ` ## [_link_](#require-by) Require by - [Flow_Flows are used to prepare data, which can include aggregation, cleaning, preprocessing, etc._](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow.doc.html "Flow - Flows are used to prepare data, which can include aggregation, cleaning, preprocessing, etc.") - [FlowColumnInputField_Column input field implementation_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowcolumninputfield.doc.html "FlowColumnInputField - Column input field implementation") - [FlowFieldInputField_Field input field implementation_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfield.doc.html "FlowFieldInputField - Field input field implementation") - [FlowInputField_A wrapper for an input field contained in a published flow._](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowinputfield.doc.html "FlowInputField - A wrapper for an input field contained in a published flow.") - [FlowOutputStep_A flow output step_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowoutputstep.doc.html "FlowOutputStep - A flow output step") - [Metric_Metrics are time series data constructed from fields contained in views. \*Retired in Tableau Cloud February 2024 / Server 2024.2.\*_](metric.doc.html "Metric - Metrics are time series data constructed from fields contained in views. *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.*") _menu_ Types ENUM # FlowOutputFieldOrderField Enum for fields that can be used for sorting ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - enum FlowOutputFieldOrderField { - # Sort by id - ID - # Sort by name - NAME - } ` ## [_link_](#require-by) Require by - [FlowOutputFieldSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowoutputfieldsortorder.doc.html "FlowOutputFieldSortOrder - 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.") _menu_ Types OBJECT # FlowOutputFieldsConnection Connection Type for FlowOutputField ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type FlowOutputFieldsConnection { - # List of nodes - nodes: [[FlowOutputField](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowoutputfield.doc.html)!]! - # Information for pagination - pageInfo: [PageInfo](https://help.tableau.com/current/api/metadata_api/en-us/reference/pageinfo.doc.html)! - # Total number of objects in connection - totalCount: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html)! - } ` ## [_link_](#require-by) Require by - [Flow_Flows are used to prepare data, which can include aggregation, cleaning, preprocessing, etc._](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow.doc.html "Flow - Flows are used to prepare data, which can include aggregation, cleaning, preprocessing, etc.") - [FlowColumnInputField_Column input field implementation_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowcolumninputfield.doc.html "FlowColumnInputField - Column input field implementation") - [FlowFieldInputField_Field input field implementation_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfield.doc.html "FlowFieldInputField - Field input field implementation") - [FlowInputField_A wrapper for an input field contained in a published flow._](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowinputfield.doc.html "FlowInputField - A wrapper for an input field contained in a published flow.") - [FlowOutputStep_A flow output step_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowoutputstep.doc.html "FlowOutputStep - A flow output step") - [Metric_Metrics are time series data constructed from fields contained in views. \*Retired in Tableau Cloud February 2024 / Server 2024.2.\*_](metric.doc.html "Metric - Metrics are time series data constructed from fields contained in views. *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.*") _menu_ Types INPUT\_OBJECT # FlowOutputFieldSortOrder 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. ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input FlowOutputFieldSortOrder { - # GraphQL field to sort on - field: [FlowOutputFieldOrderField](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowoutputfieldorderfield.doc.html)! - # Order direction to sort output - direction: [OrderDirection](https://help.tableau.com/current/api/metadata_api/en-us/reference/orderdirection.doc.html)! - } ` ## [_link_](#require-by) Require by - [Flow_Flows are used to prepare data, which can include aggregation, cleaning, preprocessing, etc._](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow.doc.html "Flow - Flows are used to prepare data, which can include aggregation, cleaning, preprocessing, etc.") - [FlowColumnInputField_Column input field implementation_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowcolumninputfield.doc.html "FlowColumnInputField - Column input field implementation") - [FlowFieldInputField_Field input field implementation_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfield.doc.html "FlowFieldInputField - Field input field implementation") - [FlowInputField_A wrapper for an input field contained in a published flow._](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowinputfield.doc.html "FlowInputField - A wrapper for an input field contained in a published flow.") - [FlowOutputStep_A flow output step_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowoutputstep.doc.html "FlowOutputStep - A flow output step") - [Metric_Metrics are time series data constructed from fields contained in views. \*Retired in Tableau Cloud February 2024 / Server 2024.2.\*_](metric.doc.html "Metric - Metrics are time series data constructed from fields contained in views. *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.*") _menu_ Types OBJECT # FlowOutputStep A flow output step ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type FlowOutputStep { - # Unique identifier used by the metadata API - id: [ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html)! - # Name shown in server and desktop clients - name: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Identifier internal to flow - stepId: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Fields output by this step - # - # 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. - outputFields( - filter: [FlowOutputField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowoutputfield_filter.doc.html), - orderBy: [FlowOutputFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowoutputfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[FlowOutputField](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowoutputfield.doc.html)!]! - # Fields output by this step - # - # 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. - outputFieldsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [FlowOutputField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowoutputfield_filter.doc.html), - orderBy: [FlowOutputFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowoutputfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FlowOutputFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowoutputfieldsconnection.doc.html) - # The flow that contains this output step - flow: [Flow](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow.doc.html) - } ` ## [_link_](#require-by) Require by - [Flow_Flows are used to prepare data, which can include aggregation, cleaning, preprocessing, etc._](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/flowcolumnoutputfield.doc.html "FlowColumnOutputField - Column output field implementation") - [FlowFieldOutputField_Field output field implementation_](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/flowoutputfield.doc.html "FlowOutputField - A wrapper for an output field contained in a published flow.") - [FlowOutputStepsConnection_Connection Type for FlowOutputStep_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowoutputstepsconnection.doc.html "FlowOutputStepsConnection - Connection Type for FlowOutputStep") - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/api/metadata_api/en-us/reference/query.doc.html "Query - Query root for Metadata GraphQL interface") _menu_ Types INPUT\_OBJECT # FlowOutputStep\_Filter Filter by GraphQL field and given value ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input FlowOutputStep_Filter { - # Name shown in server and desktop clients - name: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Name shown in server and desktop clients - nameWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)] - # Unique identifier used by the metadata API - id: [ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html) - # Unique identifier used by the metadata API - idWithin: [[ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html)] - } ` ## [_link_](#require-by) Require by - [Flow_Flows are used to prepare data, which can include aggregation, cleaning, preprocessing, etc._](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow.doc.html "Flow - Flows are used to prepare data, which can include aggregation, cleaning, preprocessing, etc.") - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/api/metadata_api/en-us/reference/query.doc.html "Query - Query root for Metadata GraphQL interface") _menu_ Types ENUM # FlowOutputStepOrderField Enum for fields that can be used for sorting ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - enum FlowOutputStepOrderField { - # Sort by id - ID - # Sort by name - NAME - } ` ## [_link_](#require-by) Require by - [FlowOutputStepSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowoutputstepsortorder.doc.html "FlowOutputStepSortOrder - 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.") _menu_ Types OBJECT # FlowOutputStepsConnection Connection Type for FlowOutputStep ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type FlowOutputStepsConnection { - # List of nodes - nodes: [[FlowOutputStep](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowoutputstep.doc.html)!]! - # Information for pagination - pageInfo: [PageInfo](https://help.tableau.com/current/api/metadata_api/en-us/reference/pageinfo.doc.html)! - # Total number of objects in connection - totalCount: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html)! - } ` ## [_link_](#require-by) Require by - [Flow_Flows are used to prepare data, which can include aggregation, cleaning, preprocessing, etc._](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow.doc.html "Flow - Flows are used to prepare data, which can include aggregation, cleaning, preprocessing, etc.") - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/api/metadata_api/en-us/reference/query.doc.html "Query - Query root for Metadata GraphQL interface") _menu_ Types INPUT\_OBJECT # FlowOutputStepSortOrder 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. ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input FlowOutputStepSortOrder { - # GraphQL field to sort on - field: [FlowOutputStepOrderField](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowoutputsteporderfield.doc.html)! - # Order direction to sort output - direction: [OrderDirection](https://help.tableau.com/current/api/metadata_api/en-us/reference/orderdirection.doc.html)! - } ` ## [_link_](#require-by) Require by - [Flow_Flows are used to prepare data, which can include aggregation, cleaning, preprocessing, etc._](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow.doc.html "Flow - Flows are used to prepare data, which can include aggregation, cleaning, preprocessing, etc.") - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/api/metadata_api/en-us/reference/query.doc.html "Query - Query root for Metadata GraphQL interface") _menu_ Types OBJECT # FlowsConnection Connection Type for Flow ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type FlowsConnection { - # List of nodes - nodes: [[Flow](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow.doc.html)!]! - # Information for pagination - pageInfo: [PageInfo](https://help.tableau.com/current/api/metadata_api/en-us/reference/pageinfo.doc.html)! - # Total number of objects in connection - totalCount: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.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/current/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/current/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/current/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/current/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/current/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/current/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/current/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/current/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.") - [Dashboard_A dashboard contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard.doc.html "Dashboard - A dashboard contained in a published workbook.") - [Database_A database containing tables_](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html "Database - A database containing tables") - [DatabaseServer_A database server connection_](https://help.tableau.com/current/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/current/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/current/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.") - [EmbeddedDatasource_A data source embedded in a workbook_](https://help.tableau.com/current/api/metadata_api/en-us/reference/embeddeddatasource.doc.html "EmbeddedDatasource - A data source embedded in a workbook") - [Field_Base GraphQL type for a field_](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [FieldReferencingField_Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula._](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield.doc.html "FieldReferencingField - Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula.") - [File_A file connection_](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/flow.doc.html "Flow - Flows are used to prepare data, which can include aggregation, cleaning, preprocessing, etc.") - [FlowColumnInputField_Column input field implementation_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowcolumninputfield.doc.html "FlowColumnInputField - Column input field implementation") - [FlowColumnOutputField_Column output field implementation_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowcolumnoutputfield.doc.html "FlowColumnOutputField - Column output field implementation") - [FlowFieldInputField_Field input field implementation_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfield.doc.html "FlowFieldInputField - Field input field implementation") - [FlowFieldOutputField_Field output field implementation_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfield.doc.html "FlowFieldOutputField - Field output field implementation") - [FlowInputField_A wrapper for an input field contained in a published flow._](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowinputfield.doc.html "FlowInputField - A wrapper for an input field contained in a published flow.") - [FlowOutputField_A wrapper for an output field contained in a published flow._](https://help.tableau.com/current/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/current/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/current/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.*") - [Metric_Metrics are time series data constructed from fields contained in views. \*Retired in Tableau Cloud February 2024 / Server 2024.2.\*_](metric.doc.html "Metric - Metrics are time series data constructed from fields contained in views. *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/current/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/current/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/current/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") - [Sheet_A sheet contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html "Sheet - A sheet contained in a published workbook.") - [Table_A table containing columns_](https://help.tableau.com/current/api/metadata_api/en-us/reference/table.doc.html "Table - A table containing columns") - [TableauSite_Site on Tableau server_](https://help.tableau.com/current/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/current/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/current/api/metadata_api/en-us/reference/tag.doc.html "Tag - A tag associated with content items") - [VirtualConnection_A virtual connection. \*Available in Tableau Cloud March 2022 / Server 2022.1 and later.\*_](virtualconnection.doc.html "VirtualConnection - A virtual connection. *Available in Tableau Cloud March 2022 / Server 2022.1 and later.*") - [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/current/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/current/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).") _menu_ Types INPUT\_OBJECT # FlowSortOrder 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. ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input FlowSortOrder { - # GraphQL field to sort on - field: [FlowOrderField](https://help.tableau.com/current/api/metadata_api/en-us/reference/floworderfield.doc.html)! - # Order direction to sort output - direction: [OrderDirection](https://help.tableau.com/current/api/metadata_api/en-us/reference/orderdirection.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/current/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/current/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/current/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/current/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/current/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/current/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/current/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/current/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.") - [Dashboard_A dashboard contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard.doc.html "Dashboard - A dashboard contained in a published workbook.") - [Database_A database containing tables_](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html "Database - A database containing tables") - [DatabaseServer_A database server connection_](https://help.tableau.com/current/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/current/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/current/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.") - [EmbeddedDatasource_A data source embedded in a workbook_](https://help.tableau.com/current/api/metadata_api/en-us/reference/embeddeddatasource.doc.html "EmbeddedDatasource - A data source embedded in a workbook") - [Field_Base GraphQL type for a field_](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [FieldReferencingField_Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula._](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield.doc.html "FieldReferencingField - Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula.") - [File_A file connection_](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/flow.doc.html "Flow - Flows are used to prepare data, which can include aggregation, cleaning, preprocessing, etc.") - [FlowColumnInputField_Column input field implementation_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowcolumninputfield.doc.html "FlowColumnInputField - Column input field implementation") - [FlowColumnOutputField_Column output field implementation_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowcolumnoutputfield.doc.html "FlowColumnOutputField - Column output field implementation") - [FlowFieldInputField_Field input field implementation_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfield.doc.html "FlowFieldInputField - Field input field implementation") - [FlowFieldOutputField_Field output field implementation_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfield.doc.html "FlowFieldOutputField - Field output field implementation") - [FlowInputField_A wrapper for an input field contained in a published flow._](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowinputfield.doc.html "FlowInputField - A wrapper for an input field contained in a published flow.") - [FlowOutputField_A wrapper for an output field contained in a published flow._](https://help.tableau.com/current/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/current/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/current/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.*") - [Metric_Metrics are time series data constructed from fields contained in views. \*Retired in Tableau Cloud February 2024 / Server 2024.2.\*_](metric.doc.html "Metric - Metrics are time series data constructed from fields contained in views. *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/current/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/current/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/current/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") - [Sheet_A sheet contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html "Sheet - A sheet contained in a published workbook.") - [Table_A table containing columns_](https://help.tableau.com/current/api/metadata_api/en-us/reference/table.doc.html "Table - A table containing columns") - [TableauSite_Site on Tableau server_](https://help.tableau.com/current/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/current/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/current/api/metadata_api/en-us/reference/tag.doc.html "Tag - A tag associated with content items") - [VirtualConnection_A virtual connection. \*Available in Tableau Cloud March 2022 / Server 2022.1 and later.\*_](virtualconnection.doc.html "VirtualConnection - A virtual connection. *Available in Tableau Cloud March 2022 / Server 2022.1 and later.*") - [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/current/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/current/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).") _menu_ Types OBJECT # GenericLabel A label that can be attached to assets. _Available in Tableau Cloud March 2023 / Server 2023.1 and later._ ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type GenericLabel implements [Label](https://help.tableau.com/current/api/metadata_api/en-us/reference/label.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/current/api/metadata_api/en-us/reference/id.doc.html)! - # User who last updated this label - author: [TableauUser](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauuser.doc.html) - # Name of the user who last updated this label - authorDisplayName: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Vizportal ID of this label, for use in client-to-server communications - vizportalId: [String](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/string.doc.html)! - # True if the label is active - isActive: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html)! - # True if the label is elevated - isElevated: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html)! - # Value of the label - value: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)! - # Category of the label - category: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)! - # Message of the label - message: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Time the label was created - createdAt: [DateTime](https://help.tableau.com/current/api/metadata_api/en-us/reference/datetime.doc.html)! - # Time the label was last updated - updatedAt: [DateTime](https://help.tableau.com/current/api/metadata_api/en-us/reference/datetime.doc.html)! - # The asset that contains the label - asset: [CanHaveLabels](https://help.tableau.com/current/api/metadata_api/en-us/reference/canhavelabels.doc.html) - } ` ## [_link_](#require-by) Require by - [GenericLabelsConnection_Connection Type for GenericLabel_](https://help.tableau.com/current/api/metadata_api/en-us/reference/genericlabelsconnection.doc.html "GenericLabelsConnection - Connection Type for GenericLabel") - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/api/metadata_api/en-us/reference/query.doc.html "Query - Query root for Metadata GraphQL interface") _menu_ Types INPUT\_OBJECT # GenericLabel\_Filter Filter by GraphQL field and given value ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input GenericLabel_Filter { - # True if the label is elevated - isElevated: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) - # True if the label is elevated - isElevatedWithin: [[Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html)] - # Locally unique identifier used for the REST API on the Tableau Server - luid: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Locally unique identifier used for the REST API on the Tableau Server - luidWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.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/current/api/metadata_api/en-us/reference/id.doc.html) - # Unique identifier used by the metadata API. Not the same as the numeric ID used - # on server - idWithin: [[ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html)] - # True if the label is active - isActive: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) - # True if the label is active - isActiveWithin: [[Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html)] - # Category of the label - category: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Category of the label - categoryWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)] - # Value of the label - value: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Value of the label - valueWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)] - } ` ## [_link_](#require-by) Require by - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/api/metadata_api/en-us/reference/query.doc.html "Query - Query root for Metadata GraphQL interface") _menu_ Types ENUM # GenericLabelOrderField Enum for fields that can be used for sorting ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - enum GenericLabelOrderField { - # Sort by category - CATEGORY - # Sort by id - ID - # Sort by isActive - IS_ACTIVE - # Sort by isElevated - IS_ELEVATED - # Sort by luid - LUID - # Sort by value - VALUE - } ` ## [_link_](#require-by) Require by - [GenericLabelSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/genericlabelsortorder.doc.html "GenericLabelSortOrder - 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.") _menu_ Types OBJECT # GenericLabelsConnection Connection Type for GenericLabel ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type GenericLabelsConnection { - # List of nodes - nodes: [[GenericLabel](https://help.tableau.com/current/api/metadata_api/en-us/reference/genericlabel.doc.html)!]! - # Information for pagination - pageInfo: [PageInfo](https://help.tableau.com/current/api/metadata_api/en-us/reference/pageinfo.doc.html)! - # Total number of objects in connection - totalCount: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html)! - } ` ## [_link_](#require-by) Require by - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/api/metadata_api/en-us/reference/query.doc.html "Query - Query root for Metadata GraphQL interface") _menu_ Types INPUT\_OBJECT # GenericLabelSortOrder 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. ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input GenericLabelSortOrder { - # GraphQL field to sort on - field: [GenericLabelOrderField](https://help.tableau.com/current/api/metadata_api/en-us/reference/genericlabelorderfield.doc.html)! - # Order direction to sort output - direction: [OrderDirection](https://help.tableau.com/current/api/metadata_api/en-us/reference/orderdirection.doc.html)! - } ` ## [_link_](#require-by) Require by - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/api/metadata_api/en-us/reference/query.doc.html "Query - Query root for Metadata GraphQL interface") # Get Started To get started, review the requirements necessary to use the Tableau Metadata API. **In this section** ## Prerequisites To use the Tableau Metadata API, the following requirements must be met: ### For Tableau Cloud - **Data Management:** Tableau Cloud requires Data Management (or an edition that includes it) to access the Metadata API. This requirement started with Tableau Cloud October 2026. If you were using the Metadata API without Data Management at that time, you can continue doing so until June 2027. - **An authentication token** to programmatically access the Metadata API through the [GraphQL endpoint](#endpoint). The Metadata API uses the same authentication process and token as the Tableau REST API. For more information, see [How to Authenticate](/current/api/metadata_api/en-us/docs/meta_api_auth.html). **Note:** The Metadata API is enabled automatically for Tableau Cloud sites with Data Management. If your site was upgraded from Standard, a site admin must turn on Catalog once. For more information, see [Enable Tableau Catalog \[↗\]](https://help.tableau.com/current/online/en-us/dm_catalog_enable.htm). ### For Tableau Server - **Tableau REST API must not be disabled.** - **The Metadata API must be enabled**. For more information about enabling the Metadata API, see the [section](#enable) below. - **An authentication token** to programmatically access the Metadata API through the [GraphQL endpoint](#endpoint). The Metadata API uses the same authentication process and token as the Tableau REST API. For more information, see [How to Authenticate](/current/api/metadata_api/en-us/docs/meta_api_auth.html). - **Enable the Metadata API**, as follows: ## Tableau Server Only: Enable the Metadata API The Metadata API is installed with Tableau Server but disabled by default. A server admin must enable the Metadata API on Tableau Server using the `tsm maintenance metadata-services enable` command through the Tableau Services Manager (TSM) command line interface (CLI). For more information, see [tsm maintenance \[↗\]](https://help.tableau.com/current/server/en-us/cli_maintenance_tsm.htm#cat_enable) topic in the Tableau Server Help. Running the command begins initial ingestion, which is a component of the indexing process for the Metadata API. 1. Open a command prompt as an admin on the initial node (where TSM is installed) in the cluster. 2. Run the command: `tsm maintenance metadata-services enable` **Notes:** When running this command, keep the following points in mind: - This command stops and starts some services used by Tableau Server, which causes certain functionality, such as the Recommendations capability, to be temporarily unavailable. - A new index of metadata is created at this time. Running this command any subsequent times will create and replace the previous index. After the requirements have been met and the Metadata API has been enabled (for Tableau Server only) you can learn about the GraphQL schema or start querying the Metadata API. ## About querying the Metadata API To get the information you need from the Metadata API, you need to be able to write queries. Queries fetch metadata about the content published to your Tableau Cloud site or Tableau Server. Before you can begin writing these queries, you need to understand what kind of Tableau Cloud or Tableau Server metadata is available through the Metadata API and the ways for accessing the metadata. For more information, see [Understand the Metadata Model](/current/api/metadata_api/en-us/docs/meta_api_model.html). ### Who can query the Metadata API In general, any authorized user can query the Metadata API. Tableau Cloud requires Data Management to access the Metadata API, but Tableau Server does not. This requirement started with Tableau Cloud October 2026. If you were using the Metadata API without Data Management at that time, you can continue doing so until June 2027. On Tableau Server without Data Management, if “derived permissions” is enabled, users can see external assets related to their Tableau content. For more information about derived permissions: - For Tableau Cloud: [Permissions on external assets using derived permissions \[↗\]](https://help.tableau.com/current/online/en-us/dm_perms_assets.htm#derived) - For Tableau Server: [Permissions on external assets using derived permissions \[↗\]](https://help.tableau.com/current/server/en-us/dm_perms_assets.htm#derived) ## Query the API using the GraphQL endpoint Unlike a REST API, the Metadata API has only a single endpoint. To use the Metadata API, issue queries against this metadata api endpoint using GraphQL. ### The endpoint URI `http:///api/metadata/graphql` **Note:** - The API endpoint and the in-browser tool that you can use to query GraphQL have distinct but very similar URLs: - `https:///api/metadata/graphql` is the API endpoint. - `https:///metadata/graphiql/` is in-browser tool that you can use to query GraphQL. - Issue API calls against the endpoint URI. If you’re looking for a way to query the metadata API in a browser, see [Explore the Metadata API schema using GraphiQL](#graphiql). - To use the GraphQL endpoint, you must authenticate using the Tableau REST API. For more information, see [How to Authenticate](/current/api/metadata_api/en-us/docs/meta_api_auth.html) topic. ### Query To form a query using GraphQL, you must specify the objects, and in some cases, objects within those objects until a unit of data can be returned. ``` query { (){ { } } } ``` ### Query example ``` query useMetadataApiToQueryOrdersDatabases{ databases (filter: {name: "adventureworks"}){ name tables{ name } } } ``` For more query examples, see the [Example Queries](/current/api/metadata_api/en-us/docs/meta_api_examples.html) topic. ### Submitting the query #### POST and Content-Type application/json You typically submit GraphQL queries using `POST` and an HTTP `Content-Type` header of `application/json`, with the JSON-encoded query in the HTTP request body. A typical HTTP request body with a JSON-encoded simple GraphQL query might look like: ``` {"query":"query myquery{databases {name id}}"} ``` #### POST and Content-Type application/graphql You can also submit GraphQL queries using `POST` and an HTTP `Content-Type` header of `application/graphql`. A typical HTTP request body with the same simple GraphQL query as above would be: ``` query myquery{databases {name id}} ``` #### GET You can also submit GraphQL queries using `GET` and a querystring, with no request body at all. The querystring is a field-value pair where the field is `query` and the value is the GraphQL query, URL encoded. A typical HTTP request using the same simple GraphQL query as above would result in a URI and querystring like: ``` https://tableau.example.com/api/metadata/graphql?query=query%20myquery%7Bdatabases%7Bname%20id%7D%7D' ``` #### More information For more information on typical GraphQL requests and expected interactions, see [HTTP Methods, Headers, and Body \[↗\]](https://graphql.org/learn/serving-over-http/#http-methods-headers-and-body) on the GraphQL.org website. ### Query response The query returns only the data you specify in same shape as your query. For the query example used above, you will see the following query response. ``` { "data": { "databases": [ { "name": "adventureworks", "tables": [ { "name": "AWBuildVersion" } ] }, { "name": "adventureworks", "tables": [ { "name": "SalesTerritory" }, { "name": "Department" }, { "name": "Culture" }, { "name": "Address" }, { "name": "Product" } ] }, { "name": "adventureworks", "tables": [ { "name": "CustomerAddress" }, { "name": "Address" }, { "name": "Customer" } ] } ] } } ``` ### Permissions Your query results are scoped to the permissions you’ve been granted. For more information, see [How Permissions Work](/current/api/metadata_api/en-us/docs/meta_api_permissions.html) topic. ### Errors See [Common Errors](/current/api/metadata_api/en-us/docs/meta_api_errors.html) topic. ## Explore the Metadata API schema using GraphiQL One way to quickly get started with GraphQL queries and explore the Metadata API is to test queries against the schema. You can explore the schema using GraphiQL, which is an interactive in-browser tool. You can change the query as you like and see the results immediately. **Note:** To access GraphiQL, you must sign in (authenticate) to your Tableau Cloud site or Tableau Server. The data you can see, specifically about external assets, is scoped to the permissions you’ve been granted. Tableau Cloud requires Data Management to access GraphiQL, but Tableau Server does not. 1. Open a browser and sign in to [Tableau Cloud \[↗\]](https://online.tableau.com) or Tableau Server 2019.3 (or later). 2. Copy the following partial URL: `/metadata/graphiql/` 3. In the browser’s address bar, delete everything after the “`.com`”. 4. Paste the partial URL after the “`.com`” and press ENTER or RETURN. For example, if your site’s name is “MYCO” and the site URL is: `https://us-west-2b.online.tableau.com/#/site/MYCO/explore` The GraphiQL tool URL is: `https://us-west-2b.online.tableau.com/metadata/graphiql/` **Note:** - The API endpoint and the in-browser tool that you can use to query GraphQL have distinct but very similar URLs: - `https:///api/metadata/graphql` is the API endpoint. - `https:///metadata/graphiql/` is in-browser tool that you can use to query GraphQL. - You can also access the GraphiQL in-browser tool from Tableau Catalog in Tableau Cloud site or Tableau Server by clicking **Query metadata (GraphiQL)** in the upper-right corner of the **External Assets** page. ### About the GraphiQL query tool The GraphiQL query tool is comprised of several parts. ![Parts of the GraphiQL interface](/current/api/metadata_api/en-us/docs/assets/graphiql.png) 1. **History pane:** After you have written and run a query, it’s saved to a list so that you can reuse the query at another time. To toggle the History pane, click the **History** button in the toolbar. 2. **Left pane:** Build queries in the left pane. To run a query, click the play button (Execute Query) in the Toolbar. For more information about writing queries, see [Example Queries](/current/api/metadata_api/en-us/docs/meta_api_examples.html). 3. **Query Variables pane:** Use this pane to define the variables that you pass to your queries. 4. **Toolbar:** Use the toolbar to run queries, see a history of queries that you’ve run, and to explore the GraphQL schema. 5. **Middle pane:** See the results of and validate your queries in the right pane. 6. **Right pane:** Toggle this pane by clicking **Documentation Explorer** to show the GraphQL schema. You can search the schema to see the objects that are implemented by the Metadata API and the metadata that you can query. _menu_ Types # Graphql schema documentation Tableau Metadata API GraphQL reference ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - schema { - # Query root for Metadata GraphQL interface - query: [Query](https://help.tableau.com/current/api/metadata_api/en-us/reference/query.doc.html) - } ` _menu_ Types OBJECT # GroupField GraphQL type for a group field. See [https://onlinehelp.tableau.com/current/pro/desktop/en-us/sortgroup\_groups\_creating.html](https://onlinehelp.tableau.com/current/pro/desktop/en-us/sortgroup_groups_creating.html) ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type GroupField implements [Field](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.doc.html), [DataField](https://help.tableau.com/current/api/metadata_api/en-us/reference/datafield.doc.html), [FieldReferencingField](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield.doc.html), [Node](https://help.tableau.com/current/api/metadata_api/en-us/reference/node.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/current/api/metadata_api/en-us/reference/id.doc.html)! - # Name shown in server and desktop clients - name: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Name internally used to uniquely identify fields - fullyQualifiedName: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Description of field shown in server and desktop clients - description: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # description that is shown in the Tableau UI - # - # Arguments - # **inheritanceType**: Method for selecting inherited value - # **permissionMode**: Option to select how to apply permissions. By - # default it is OBFUSCATE_RESULTS - descriptionInherited( - inheritanceType: [InheritanceType](https://help.tableau.com/current/api/metadata_api/en-us/reference/inheritancetype.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[InheritedStringResult](https://help.tableau.com/current/api/metadata_api/en-us/reference/inheritedstringresult.doc.html)] - # True if the field is hidden - isHidden: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) - # Name of folder if the field is in a folder. See - # https://onlinehelp.tableau.com/current/pro/desktop/en-us/datafields_dwfeatures.html#Organize - folderName: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Data category of the field - dataCategory: [FieldRoleCategory](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldrolecategory.doc.html) - # Role of the field: 'dimension', 'measure' or 'unknown' - role: [FieldRole](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldrole.doc.html) - # Type of the data in the field. See - # https://onlinehelp.tableau.com/current/pro/desktop/en-us/datafields_typesandroles_datatypes.html - dataType: [FieldDataType](https://help.tableau.com/current/api/metadata_api/en-us/reference/fielddatatype.doc.html) - # Field has an 'Other' group. See - # https://onlinehelp.tableau.com/current/pro/desktop/en-us/sortgroup_groups_creating.html#Include - hasOther: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) - # List of fields, if any, that this field references - # - # 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. - fields( - filter: [Field_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/field_filter.doc.html), - orderBy: [FieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Field](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.doc.html)!]! - # List of fields, if any, that this field references - # - # 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. - fieldsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Field_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/field_filter.doc.html), - orderBy: [FieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsconnection.doc.html) - # Columns downstream of this field - # - # 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. - downstreamColumns( - filter: [Column_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/column_filter.doc.html), - orderBy: [ColumnSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Column](https://help.tableau.com/current/api/metadata_api/en-us/reference/column.doc.html)!]! - # Columns downstream of this field - # - # 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. - downstreamColumnsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Column_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/column_filter.doc.html), - orderBy: [ColumnSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [ColumnsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnsconnection.doc.html) - # Tables downstream of this field - # - # 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. - downstreamTables( - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DatabaseTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable.doc.html)!]! - # Tables downstream of this field - # - # 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. - downstreamTablesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabaseTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesconnection.doc.html) - # Virtual connection tables downstream of this field - # - # 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/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnectionTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable.doc.html)!]! - # Virtual connection tables downstream of this field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnectionTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesconnection.doc.html) - # Virtual connections downstream of this field - # - # 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. - downstreamVirtualConnections( - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection.doc.html)!]! - # Virtual connections downstream of this field - # - # 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. - downstreamVirtualConnectionsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsconnection.doc.html) - # Databases downstream of this field - # - # 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. - downstreamDatabases( - filter: [Database_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Database](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html)!]! - # Databases downstream of this field - # - # 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. - downstreamDatabasesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Database_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabasesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesconnection.doc.html) - # Flows downstream of this field - # - # 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/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Flow](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow.doc.html)!]! - # Flows downstream of this field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Flow_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FlowsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsconnection.doc.html) - # downstream fields that reference this field - # - # 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. - downstreamFields( - filter: [Field_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/field_filter.doc.html), - orderBy: [FieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Field](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.doc.html)!]! - # downstream fields that reference this field - # - # 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. - downstreamFieldsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Field_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/field_filter.doc.html), - orderBy: [FieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsconnection.doc.html) - # Datasources connected downstream from this field - # - # 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/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[PublishedDatasource](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource.doc.html)!] - # Datasources connected downstream from this field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [PublishedDatasource_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [PublishedDatasourcesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesconnection.doc.html) - # Lenses connected downstream from this field - # - # 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/current/api/metadata_api/en-us/reference/lens_filter.doc.html), - orderBy: [LensSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/lenssortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Lens](https://help.tableau.com/current/api/metadata_api/en-us/reference/lens.doc.html)!] - # Lenses connected downstream from this field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Lens_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/lens_filter.doc.html), - orderBy: [LensSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/lenssortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [LensesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensesconnection.doc.html) - # Sheets connected downstream from the field - # - # 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/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Sheet](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html)!]! - # Sheets connected downstream from the field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Sheet_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [SheetsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsconnection.doc.html) - # Dashboards connected downstream from the field - # - # 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/current/api/metadata_api/en-us/reference/dashboard_filter.doc.html), - orderBy: [DashboardSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboardsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Dashboard](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard.doc.html)!]! - # Dashboards connected downstream from the field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Dashboard_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard_filter.doc.html), - orderBy: [DashboardSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboardsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DashboardsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboardsconnection.doc.html) - # Workbooks connected downstream from the field - # - # 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/current/api/metadata_api/en-us/reference/workbook_filter.doc.html), - orderBy: [WorkbookSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Workbook](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbook.doc.html)!] - # Workbooks connected downstream from the field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Workbook_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbook_filter.doc.html), - orderBy: [WorkbookSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [WorkbooksConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksconnection.doc.html) - # Metrics connected downstream from the field - # - # 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/current/api/metadata_api/en-us/reference/metric_filter.doc.html), - orderBy: [MetricSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Metric](https://help.tableau.com/current/api/metadata_api/en-us/reference/metric.doc.html)!] - # Metrics connected downstream from the field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Metric_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metric_filter.doc.html), - orderBy: [MetricSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [MetricsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricsconnection.doc.html) - # Workbook owners (authors) connected downstream from the field - # - # 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/current/api/metadata_api/en-us/reference/tableauuser_filter.doc.html), - orderBy: [TableauUserSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauusersortorder.doc.html) - ): [[TableauUser](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauuser.doc.html)!] - # Workbook owners (authors) connected downstream from the field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [TableauUser_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauuser_filter.doc.html), - orderBy: [TableauUserSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauusersortorder.doc.html) - ): [TableauUsersConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauusersconnection.doc.html) - # Tables connected upstream from the field - # - # 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/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DatabaseTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable.doc.html)!]! - # Tables connected upstream from the field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabaseTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesconnection.doc.html) - # Virtual connection tables upstream of this field - # - # 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/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnectionTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable.doc.html)!]! - # Virtual connection tables upstream of this field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnectionTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesconnection.doc.html) - # Virtual connections upstream of this field - # - # 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. - upstreamVirtualConnections( - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection.doc.html)!]! - # Virtual connections upstream of this field - # - # 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. - upstreamVirtualConnectionsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsconnection.doc.html) - # Databases connected upstream from the field - # - # 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/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Database](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html)!]! - # Databases connected upstream from the field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Database_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabasesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesconnection.doc.html) - # Flows connected upstream from the field - # - # 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/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Flow](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow.doc.html)!]! - # Flows connected upstream from the field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Flow_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FlowsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsconnection.doc.html) - # Datasources connected upstream from the field - # - # 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/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[PublishedDatasource](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource.doc.html)!]! - # Datasources connected upstream from the field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [PublishedDatasource_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [PublishedDatasourcesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesconnection.doc.html) - # The field that references this field - # - # 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. - referencedByFields( - filter: [FieldReferencingField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield_filter.doc.html), - orderBy: [FieldReferencingFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[FieldReferencingField](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield.doc.html)] - # The field that references this field - # - # 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. - referencedByFieldsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [FieldReferencingField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield_filter.doc.html), - orderBy: [FieldReferencingFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FieldReferencingFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfieldsconnection.doc.html) - # Data source that contains this field - datasource: [Datasource](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasource.doc.html) - # Metric definitions that reference this data source field. - # - # 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. - metricDefinitions( - filter: [MetricDefinition_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinition_filter.doc.html), - orderBy: [MetricDefinitionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[MetricDefinition](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinition.doc.html)] - # Metric definitions that reference this data source field. - # - # 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. - metricDefinitionsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [MetricDefinition_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinition_filter.doc.html), - orderBy: [MetricDefinitionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [MetricDefinitionsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsconnection.doc.html) - # The data source filters that include this field - # - # 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. - referencedByFilters( - filter: [DatasourceFilter_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefilter_filter.doc.html), - orderBy: [DatasourceFilterSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefiltersortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DatasourceFilter](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefilter.doc.html)] - # The data source filters that include this field - # - # 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. - referencedByFiltersConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DatasourceFilter_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefilter_filter.doc.html), - orderBy: [DatasourceFilterSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefiltersortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatasourceFiltersConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefiltersconnection.doc.html) - # The bin field that references this field - # - # 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. - referencedByBins( - filter: [BinField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/binfield_filter.doc.html), - orderBy: [BinFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/binfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[BinField](https://help.tableau.com/current/api/metadata_api/en-us/reference/binfield.doc.html)] - # The bin field that references this field - # - # 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. - referencedByBinsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [BinField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/binfield_filter.doc.html), - orderBy: [BinFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/binfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [BinFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/binfieldsconnection.doc.html) - # The calculated field that references this field - # - # 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. - referencedByCalculations( - filter: [CalculatedField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/calculatedfield_filter.doc.html), - orderBy: [CalculatedFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/calculatedfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[CalculatedField](https://help.tableau.com/current/api/metadata_api/en-us/reference/calculatedfield.doc.html)] - # The calculated field that references this field - # - # 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. - referencedByCalculationsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [CalculatedField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/calculatedfield_filter.doc.html), - orderBy: [CalculatedFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/calculatedfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [CalculatedFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/calculatedfieldsconnection.doc.html) - # The combined field that references this field - # - # 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. - referencedByCombinedFields( - filter: [CombinedField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedfield_filter.doc.html), - orderBy: [CombinedFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[CombinedField](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedfield.doc.html)] - # The combined field that references this field - # - # 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. - referencedByCombinedFieldsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [CombinedField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedfield_filter.doc.html), - orderBy: [CombinedFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [CombinedFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedfieldsconnection.doc.html) - # Thie combined set field that references this field - # - # 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. - referencedByCombinedSets( - filter: [CombinedSetField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedsetfield_filter.doc.html), - orderBy: [CombinedSetFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedsetfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[CombinedSetField](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedsetfield.doc.html)] - # Thie combined set field that references this field - # - # 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. - referencedByCombinedSetsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [CombinedSetField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedsetfield_filter.doc.html), - orderBy: [CombinedSetFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedsetfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [CombinedSetFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedsetfieldsconnection.doc.html) - # The field that references this remote field - # - # 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. - referencedByRemoteFields( - filter: [DatasourceField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefield_filter.doc.html), - orderBy: [DatasourceFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DatasourceField](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefield.doc.html)] - # The field that references this remote field - # - # 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. - referencedByRemoteFieldsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DatasourceField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefield_filter.doc.html), - orderBy: [DatasourceFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatasourceFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefieldsconnection.doc.html) - # The group field that references this field - # - # 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. - referencedByGroups( - filter: [GroupField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/groupfield_filter.doc.html), - orderBy: [GroupFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/groupfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[GroupField](https://help.tableau.com/current/api/metadata_api/en-us/reference/groupfield.doc.html)] - # The group field that references this field - # - # 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. - referencedByGroupsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [GroupField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/groupfield_filter.doc.html), - orderBy: [GroupFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/groupfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [GroupFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/groupfieldsconnection.doc.html) - # The set field that this field references - # - # 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. - referencedBySets( - filter: [SetField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/setfield_filter.doc.html), - orderBy: [SetFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/setfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[SetField](https://help.tableau.com/current/api/metadata_api/en-us/reference/setfield.doc.html)] - # The set field that this field references - # - # 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. - referencedBySetsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [SetField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/setfield_filter.doc.html), - orderBy: [SetFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/setfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [SetFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/setfieldsconnection.doc.html) - # The hierarchy field that references this field - # - # 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. - referencedByHierarchies( - filter: [HierarchyField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/hierarchyfield_filter.doc.html), - orderBy: [HierarchyFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/hierarchyfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[HierarchyField](https://help.tableau.com/current/api/metadata_api/en-us/reference/hierarchyfield.doc.html)] - # The hierarchy field that references this field - # - # 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. - referencedByHierarchiesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [HierarchyField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/hierarchyfield_filter.doc.html), - orderBy: [HierarchyFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/hierarchyfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [HierarchyFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/hierarchyfieldsconnection.doc.html) - # Sheets that reference this data source field - # - # 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. - sheets( - filter: [Sheet_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Sheet](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html)] - # Sheets that reference this data source field - # - # 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. - sheetsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Sheet_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [SheetsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsconnection.doc.html) - # Sheets that reference this field - # - # 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. - directSheets( - filter: [Sheet_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Sheet](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html)] - # Sheets that reference this field - # - # 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. - directSheetsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Sheet_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [SheetsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsconnection.doc.html) - # List of lens fields which are derived from this field - # - # 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. - derivedLensFields( - filter: [LensField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensfield_filter.doc.html), - orderBy: [LensFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[LensField](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensfield.doc.html)] - # List of lens fields which are derived from this field - # - # 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. - derivedLensFieldsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [LensField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensfield_filter.doc.html), - orderBy: [LensFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [LensFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensfieldsconnection.doc.html) - # A flow input field that wraps this field - # - # 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. - referencedByFlowFieldInputField( - filter: [FlowFieldInputField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfield_filter.doc.html), - orderBy: [FlowFieldInputFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfieldsortorder.doc.html) - ): [[FlowFieldInputField](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfield.doc.html)] - # A flow input field that wraps this field - # - # 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. - referencedByFlowFieldInputFieldConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [FlowFieldInputField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfield_filter.doc.html), - orderBy: [FlowFieldInputFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfieldsortorder.doc.html) - ): [FlowFieldInputFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfieldsconnection.doc.html) - # A flow output field that wraps this field - # - # 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. - referencedByFlowFieldOutputField( - filter: [FlowFieldOutputField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfield_filter.doc.html), - orderBy: [FlowFieldOutputFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[FlowFieldOutputField](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfield.doc.html)] - # A flow output field that wraps this field - # - # 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. - referencedByFlowFieldOutputFieldConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [FlowFieldOutputField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfield_filter.doc.html), - orderBy: [FlowFieldOutputFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FlowFieldOutputFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfieldsconnection.doc.html) - # fields that are upstream of this field - # - # 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. - upstreamFields( - filter: [Field_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/field_filter.doc.html), - orderBy: [FieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Field](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.doc.html)]! - # fields that are upstream of this field - # - # 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. - upstreamFieldsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Field_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/field_filter.doc.html), - orderBy: [FieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsconnection.doc.html) - # Metric definitions downstream from this field. - # - # 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/current/api/metadata_api/en-us/reference/metricdefinition_filter.doc.html), - orderBy: [MetricDefinitionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[MetricDefinition](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinition.doc.html)] - # Metric definitions downstream from this field. - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [MetricDefinition_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinition_filter.doc.html), - orderBy: [MetricDefinitionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [MetricDefinitionsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsconnection.doc.html) - # All upstream columns this field references - # - # 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. - upstreamColumns( - filter: [Column_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/column_filter.doc.html), - orderBy: [ColumnSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Column](https://help.tableau.com/current/api/metadata_api/en-us/reference/column.doc.html)]! - # All upstream columns this field references - # - # 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. - upstreamColumnsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Column_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/column_filter.doc.html), - orderBy: [ColumnSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [ColumnsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnsconnection.doc.html) - } ` ## [_link_](#require-by) Require by - [AnalyticsField_Base GraphQL type for a field containing analytics metadata_](https://help.tableau.com/current/api/metadata_api/en-us/reference/analyticsfield.doc.html "AnalyticsField - Base GraphQL type for a field containing analytics metadata") - [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/current/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/current/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") - [ColumnField_ColumnFields are a type of field which directly connects to a column in some type of table._](https://help.tableau.com/current/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/current/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/current/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") - [DataField_Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField._](https://help.tableau.com/current/api/metadata_api/en-us/reference/datafield.doc.html "DataField - Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField.") - [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/current/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/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [FieldReferencingField_Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula._](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield.doc.html "FieldReferencingField - Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula.") - [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/current/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") - [GroupFieldsConnection_Connection Type for GroupField_](https://help.tableau.com/current/api/metadata_api/en-us/reference/groupfieldsconnection.doc.html "GroupFieldsConnection - Connection Type for GroupField") - [HierarchyField_GraphQL type for a hierarchy. See https://onlinehelp.tableau.com/current/pro/desktop/en-us/qs\_hierarchies.html_](https://help.tableau.com/current/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") - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/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/current/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") _menu_ Types INPUT\_OBJECT # GroupField\_Filter Filter by GraphQL field and given value ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input GroupField_Filter { - # Name shown in server and desktop clients - name: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Name shown in server and desktop clients - nameWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.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/current/api/metadata_api/en-us/reference/id.doc.html) - # Unique identifier used by the metadata API. Not the same as the numeric ID used - # on server - idWithin: [[ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html)] - # True if the field is hidden - isHidden: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) - # True if the field is hidden - isHiddenWithin: [[Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html)] - # Filter the output based on text query. - text: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - } ` ## [_link_](#require-by) Require by - [AnalyticsField_Base GraphQL type for a field containing analytics metadata_](https://help.tableau.com/current/api/metadata_api/en-us/reference/analyticsfield.doc.html "AnalyticsField - Base GraphQL type for a field containing analytics metadata") - [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/current/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/current/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") - [ColumnField_ColumnFields are a type of field which directly connects to a column in some type of table._](https://help.tableau.com/current/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/current/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/current/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") - [DataField_Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField._](https://help.tableau.com/current/api/metadata_api/en-us/reference/datafield.doc.html "DataField - Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField.") - [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/current/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/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [FieldReferencingField_Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula._](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield.doc.html "FieldReferencingField - Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula.") - [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/current/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/current/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") - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/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/current/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") _menu_ Types INPUT\_OBJECT # GroupField\_Required\_Filter Filter by GraphQL field and given value ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input GroupField_Required_Filter { - # Name shown in server and desktop clients - name: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Name shown in server and desktop clients - nameWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.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/current/api/metadata_api/en-us/reference/id.doc.html) - # Unique identifier used by the metadata API. Not the same as the numeric ID used - # on server - idWithin: [[ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html)] - } ` ## [_link_](#require-by) Require by This element is not required by anyone _menu_ Types ENUM # GroupFieldOrderField Enum for fields that can be used for sorting ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - enum GroupFieldOrderField { - # Sort by downstreamSheets count - DOWNSTREAM_SHEETS_COUNT - # Sort by fields count - FIELDS_COUNT - # Sort by dataCategory - DATA_CATEGORY - # Sort by dataType - DATA_TYPE - # Sort by id - ID - # Sort by isHidden - IS_HIDDEN - # Sort by name - NAME - # Sort by role - ROLE - } ` ## [_link_](#require-by) Require by - [GroupFieldSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/groupfieldsortorder.doc.html "GroupFieldSortOrder - 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.") _menu_ Types OBJECT # GroupFieldsConnection Connection Type for GroupField ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type GroupFieldsConnection { - # List of nodes - nodes: [[GroupField](https://help.tableau.com/current/api/metadata_api/en-us/reference/groupfield.doc.html)!]! - # Information for pagination - pageInfo: [PageInfo](https://help.tableau.com/current/api/metadata_api/en-us/reference/pageinfo.doc.html)! - # Total number of objects in connection - totalCount: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html)! - } ` ## [_link_](#require-by) Require by - [AnalyticsField_Base GraphQL type for a field containing analytics metadata_](https://help.tableau.com/current/api/metadata_api/en-us/reference/analyticsfield.doc.html "AnalyticsField - Base GraphQL type for a field containing analytics metadata") - [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/current/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/current/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") - [ColumnField_ColumnFields are a type of field which directly connects to a column in some type of table._](https://help.tableau.com/current/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/current/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/current/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") - [DataField_Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField._](https://help.tableau.com/current/api/metadata_api/en-us/reference/datafield.doc.html "DataField - Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField.") - [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/current/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/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [FieldReferencingField_Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula._](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield.doc.html "FieldReferencingField - Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula.") - [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/current/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/current/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") - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/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/current/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") _menu_ Types INPUT\_OBJECT # GroupFieldSortOrder 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. ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input GroupFieldSortOrder { - # GraphQL field to sort on - field: [GroupFieldOrderField](https://help.tableau.com/current/api/metadata_api/en-us/reference/groupfieldorderfield.doc.html)! - # Order direction to sort output - direction: [OrderDirection](https://help.tableau.com/current/api/metadata_api/en-us/reference/orderdirection.doc.html)! - } ` ## [_link_](#require-by) Require by - [AnalyticsField_Base GraphQL type for a field containing analytics metadata_](https://help.tableau.com/current/api/metadata_api/en-us/reference/analyticsfield.doc.html "AnalyticsField - Base GraphQL type for a field containing analytics metadata") - [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/current/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/current/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") - [ColumnField_ColumnFields are a type of field which directly connects to a column in some type of table._](https://help.tableau.com/current/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/current/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/current/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") - [DataField_Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField._](https://help.tableau.com/current/api/metadata_api/en-us/reference/datafield.doc.html "DataField - Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField.") - [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/current/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/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [FieldReferencingField_Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula._](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield.doc.html "FieldReferencingField - Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula.") - [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/current/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/current/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") - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/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/current/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") _menu_ Types OBJECT # HierarchyField GraphQL type for a hierarchy. See [https://onlinehelp.tableau.com/current/pro/desktop/en-us/qs\_hierarchies.html](https://onlinehelp.tableau.com/current/pro/desktop/en-us/qs_hierarchies.html) ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type HierarchyField implements [Field](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.doc.html), [FieldReferencingField](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield.doc.html), [Node](https://help.tableau.com/current/api/metadata_api/en-us/reference/node.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/current/api/metadata_api/en-us/reference/id.doc.html)! - # Name shown in server and desktop clients - name: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Name internally used to uniquely identify fields - fullyQualifiedName: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Description of field shown in server and desktop clients - description: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # description that is shown in the Tableau UI - # - # Arguments - # **inheritanceType**: Method for selecting inherited value - # **permissionMode**: Option to select how to apply permissions. By - # default it is OBFUSCATE_RESULTS - descriptionInherited( - inheritanceType: [InheritanceType](https://help.tableau.com/current/api/metadata_api/en-us/reference/inheritancetype.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[InheritedStringResult](https://help.tableau.com/current/api/metadata_api/en-us/reference/inheritedstringresult.doc.html)] - # True if the field is hidden - isHidden: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) - # Name of folder if the field is in a folder. See - # https://onlinehelp.tableau.com/current/pro/desktop/en-us/datafields_dwfeatures.html#Organize - folderName: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # List of fields, if any, that this field references - # - # 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. - fields( - filter: [Field_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/field_filter.doc.html), - orderBy: [FieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Field](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.doc.html)!]! - # List of fields, if any, that this field references - # - # 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. - fieldsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Field_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/field_filter.doc.html), - orderBy: [FieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsconnection.doc.html) - # Columns downstream of this field - # - # 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. - downstreamColumns( - filter: [Column_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/column_filter.doc.html), - orderBy: [ColumnSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Column](https://help.tableau.com/current/api/metadata_api/en-us/reference/column.doc.html)!]! - # Columns downstream of this field - # - # 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. - downstreamColumnsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Column_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/column_filter.doc.html), - orderBy: [ColumnSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [ColumnsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnsconnection.doc.html) - # Tables downstream of this field - # - # 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. - downstreamTables( - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DatabaseTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable.doc.html)!]! - # Tables downstream of this field - # - # 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. - downstreamTablesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabaseTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesconnection.doc.html) - # Virtual connection tables downstream of this field - # - # 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/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnectionTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable.doc.html)!]! - # Virtual connection tables downstream of this field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnectionTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesconnection.doc.html) - # Virtual connections downstream of this field - # - # 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. - downstreamVirtualConnections( - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection.doc.html)!]! - # Virtual connections downstream of this field - # - # 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. - downstreamVirtualConnectionsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsconnection.doc.html) - # Databases downstream of this field - # - # 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. - downstreamDatabases( - filter: [Database_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Database](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html)!]! - # Databases downstream of this field - # - # 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. - downstreamDatabasesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Database_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabasesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesconnection.doc.html) - # Flows downstream of this field - # - # 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/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Flow](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow.doc.html)!]! - # Flows downstream of this field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Flow_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FlowsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsconnection.doc.html) - # downstream fields that reference this field - # - # 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. - downstreamFields( - filter: [Field_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/field_filter.doc.html), - orderBy: [FieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Field](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.doc.html)!]! - # downstream fields that reference this field - # - # 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. - downstreamFieldsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Field_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/field_filter.doc.html), - orderBy: [FieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsconnection.doc.html) - # Datasources connected downstream from this field - # - # 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/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[PublishedDatasource](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource.doc.html)!] - # Datasources connected downstream from this field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [PublishedDatasource_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [PublishedDatasourcesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesconnection.doc.html) - # Lenses connected downstream from this field - # - # 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/current/api/metadata_api/en-us/reference/lens_filter.doc.html), - orderBy: [LensSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/lenssortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Lens](https://help.tableau.com/current/api/metadata_api/en-us/reference/lens.doc.html)!] - # Lenses connected downstream from this field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Lens_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/lens_filter.doc.html), - orderBy: [LensSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/lenssortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [LensesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensesconnection.doc.html) - # Sheets connected downstream from the field - # - # 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/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Sheet](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html)!]! - # Sheets connected downstream from the field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Sheet_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [SheetsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsconnection.doc.html) - # Dashboards connected downstream from the field - # - # 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/current/api/metadata_api/en-us/reference/dashboard_filter.doc.html), - orderBy: [DashboardSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboardsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Dashboard](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard.doc.html)!]! - # Dashboards connected downstream from the field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Dashboard_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard_filter.doc.html), - orderBy: [DashboardSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboardsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DashboardsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboardsconnection.doc.html) - # Workbooks connected downstream from the field - # - # 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/current/api/metadata_api/en-us/reference/workbook_filter.doc.html), - orderBy: [WorkbookSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Workbook](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbook.doc.html)!] - # Workbooks connected downstream from the field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Workbook_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbook_filter.doc.html), - orderBy: [WorkbookSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [WorkbooksConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksconnection.doc.html) - # Metrics connected downstream from the field - # - # 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/current/api/metadata_api/en-us/reference/metric_filter.doc.html), - orderBy: [MetricSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Metric](https://help.tableau.com/current/api/metadata_api/en-us/reference/metric.doc.html)!] - # Metrics connected downstream from the field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Metric_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metric_filter.doc.html), - orderBy: [MetricSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [MetricsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricsconnection.doc.html) - # Workbook owners (authors) connected downstream from the field - # - # 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/current/api/metadata_api/en-us/reference/tableauuser_filter.doc.html), - orderBy: [TableauUserSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauusersortorder.doc.html) - ): [[TableauUser](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauuser.doc.html)!] - # Workbook owners (authors) connected downstream from the field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [TableauUser_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauuser_filter.doc.html), - orderBy: [TableauUserSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauusersortorder.doc.html) - ): [TableauUsersConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauusersconnection.doc.html) - # Tables connected upstream from the field - # - # 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/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DatabaseTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable.doc.html)!]! - # Tables connected upstream from the field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabaseTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesconnection.doc.html) - # Virtual connection tables upstream of this field - # - # 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/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnectionTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable.doc.html)!]! - # Virtual connection tables upstream of this field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnectionTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesconnection.doc.html) - # Virtual connections upstream of this field - # - # 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. - upstreamVirtualConnections( - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection.doc.html)!]! - # Virtual connections upstream of this field - # - # 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. - upstreamVirtualConnectionsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsconnection.doc.html) - # Databases connected upstream from the field - # - # 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/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Database](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html)!]! - # Databases connected upstream from the field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Database_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabasesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesconnection.doc.html) - # Flows connected upstream from the field - # - # 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/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Flow](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow.doc.html)!]! - # Flows connected upstream from the field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Flow_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FlowsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsconnection.doc.html) - # Datasources connected upstream from the field - # - # 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/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[PublishedDatasource](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource.doc.html)!]! - # Datasources connected upstream from the field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [PublishedDatasource_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [PublishedDatasourcesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesconnection.doc.html) - # The field that references this field - # - # 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. - referencedByFields( - filter: [FieldReferencingField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield_filter.doc.html), - orderBy: [FieldReferencingFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[FieldReferencingField](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield.doc.html)] - # The field that references this field - # - # 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. - referencedByFieldsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [FieldReferencingField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield_filter.doc.html), - orderBy: [FieldReferencingFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FieldReferencingFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfieldsconnection.doc.html) - # Data source that contains this field - datasource: [Datasource](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasource.doc.html) - # Metric definitions that reference this data source field. - # - # 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. - metricDefinitions( - filter: [MetricDefinition_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinition_filter.doc.html), - orderBy: [MetricDefinitionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[MetricDefinition](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinition.doc.html)] - # Metric definitions that reference this data source field. - # - # 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. - metricDefinitionsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [MetricDefinition_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinition_filter.doc.html), - orderBy: [MetricDefinitionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [MetricDefinitionsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsconnection.doc.html) - # The data source filters that include this field - # - # 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. - referencedByFilters( - filter: [DatasourceFilter_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefilter_filter.doc.html), - orderBy: [DatasourceFilterSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefiltersortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DatasourceFilter](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefilter.doc.html)] - # The data source filters that include this field - # - # 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. - referencedByFiltersConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DatasourceFilter_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefilter_filter.doc.html), - orderBy: [DatasourceFilterSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefiltersortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatasourceFiltersConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefiltersconnection.doc.html) - # The bin field that references this field - # - # 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. - referencedByBins( - filter: [BinField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/binfield_filter.doc.html), - orderBy: [BinFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/binfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[BinField](https://help.tableau.com/current/api/metadata_api/en-us/reference/binfield.doc.html)] - # The bin field that references this field - # - # 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. - referencedByBinsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [BinField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/binfield_filter.doc.html), - orderBy: [BinFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/binfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [BinFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/binfieldsconnection.doc.html) - # The calculated field that references this field - # - # 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. - referencedByCalculations( - filter: [CalculatedField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/calculatedfield_filter.doc.html), - orderBy: [CalculatedFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/calculatedfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[CalculatedField](https://help.tableau.com/current/api/metadata_api/en-us/reference/calculatedfield.doc.html)] - # The calculated field that references this field - # - # 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. - referencedByCalculationsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [CalculatedField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/calculatedfield_filter.doc.html), - orderBy: [CalculatedFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/calculatedfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [CalculatedFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/calculatedfieldsconnection.doc.html) - # The combined field that references this field - # - # 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. - referencedByCombinedFields( - filter: [CombinedField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedfield_filter.doc.html), - orderBy: [CombinedFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[CombinedField](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedfield.doc.html)] - # The combined field that references this field - # - # 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. - referencedByCombinedFieldsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [CombinedField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedfield_filter.doc.html), - orderBy: [CombinedFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [CombinedFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedfieldsconnection.doc.html) - # Thie combined set field that references this field - # - # 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. - referencedByCombinedSets( - filter: [CombinedSetField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedsetfield_filter.doc.html), - orderBy: [CombinedSetFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedsetfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[CombinedSetField](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedsetfield.doc.html)] - # Thie combined set field that references this field - # - # 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. - referencedByCombinedSetsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [CombinedSetField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedsetfield_filter.doc.html), - orderBy: [CombinedSetFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedsetfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [CombinedSetFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedsetfieldsconnection.doc.html) - # The field that references this remote field - # - # 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. - referencedByRemoteFields( - filter: [DatasourceField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefield_filter.doc.html), - orderBy: [DatasourceFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DatasourceField](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefield.doc.html)] - # The field that references this remote field - # - # 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. - referencedByRemoteFieldsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DatasourceField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefield_filter.doc.html), - orderBy: [DatasourceFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatasourceFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefieldsconnection.doc.html) - # The group field that references this field - # - # 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. - referencedByGroups( - filter: [GroupField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/groupfield_filter.doc.html), - orderBy: [GroupFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/groupfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[GroupField](https://help.tableau.com/current/api/metadata_api/en-us/reference/groupfield.doc.html)] - # The group field that references this field - # - # 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. - referencedByGroupsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [GroupField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/groupfield_filter.doc.html), - orderBy: [GroupFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/groupfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [GroupFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/groupfieldsconnection.doc.html) - # The set field that this field references - # - # 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. - referencedBySets( - filter: [SetField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/setfield_filter.doc.html), - orderBy: [SetFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/setfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[SetField](https://help.tableau.com/current/api/metadata_api/en-us/reference/setfield.doc.html)] - # The set field that this field references - # - # 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. - referencedBySetsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [SetField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/setfield_filter.doc.html), - orderBy: [SetFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/setfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [SetFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/setfieldsconnection.doc.html) - # The hierarchy field that references this field - # - # 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. - referencedByHierarchies( - filter: [HierarchyField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/hierarchyfield_filter.doc.html), - orderBy: [HierarchyFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/hierarchyfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[HierarchyField](https://help.tableau.com/current/api/metadata_api/en-us/reference/hierarchyfield.doc.html)] - # The hierarchy field that references this field - # - # 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. - referencedByHierarchiesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [HierarchyField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/hierarchyfield_filter.doc.html), - orderBy: [HierarchyFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/hierarchyfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [HierarchyFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/hierarchyfieldsconnection.doc.html) - # Sheets that reference this data source field - # - # 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. - sheets( - filter: [Sheet_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Sheet](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html)] - # Sheets that reference this data source field - # - # 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. - sheetsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Sheet_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [SheetsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsconnection.doc.html) - # Sheets that reference this field - # - # 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. - directSheets( - filter: [Sheet_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Sheet](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html)] - # Sheets that reference this field - # - # 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. - directSheetsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Sheet_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [SheetsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsconnection.doc.html) - # List of lens fields which are derived from this field - # - # 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. - derivedLensFields( - filter: [LensField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensfield_filter.doc.html), - orderBy: [LensFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[LensField](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensfield.doc.html)] - # List of lens fields which are derived from this field - # - # 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. - derivedLensFieldsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [LensField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensfield_filter.doc.html), - orderBy: [LensFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [LensFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensfieldsconnection.doc.html) - # A flow input field that wraps this field - # - # 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. - referencedByFlowFieldInputField( - filter: [FlowFieldInputField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfield_filter.doc.html), - orderBy: [FlowFieldInputFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfieldsortorder.doc.html) - ): [[FlowFieldInputField](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfield.doc.html)] - # A flow input field that wraps this field - # - # 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. - referencedByFlowFieldInputFieldConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [FlowFieldInputField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfield_filter.doc.html), - orderBy: [FlowFieldInputFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfieldsortorder.doc.html) - ): [FlowFieldInputFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfieldsconnection.doc.html) - # A flow output field that wraps this field - # - # 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. - referencedByFlowFieldOutputField( - filter: [FlowFieldOutputField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfield_filter.doc.html), - orderBy: [FlowFieldOutputFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[FlowFieldOutputField](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfield.doc.html)] - # A flow output field that wraps this field - # - # 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. - referencedByFlowFieldOutputFieldConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [FlowFieldOutputField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfield_filter.doc.html), - orderBy: [FlowFieldOutputFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FlowFieldOutputFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfieldsconnection.doc.html) - # fields that are upstream of this field - # - # 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. - upstreamFields( - filter: [Field_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/field_filter.doc.html), - orderBy: [FieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Field](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.doc.html)]! - # fields that are upstream of this field - # - # 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. - upstreamFieldsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Field_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/field_filter.doc.html), - orderBy: [FieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsconnection.doc.html) - # Metric definitions downstream from this field. - # - # 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/current/api/metadata_api/en-us/reference/metricdefinition_filter.doc.html), - orderBy: [MetricDefinitionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[MetricDefinition](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinition.doc.html)] - # Metric definitions downstream from this field. - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [MetricDefinition_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinition_filter.doc.html), - orderBy: [MetricDefinitionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [MetricDefinitionsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsconnection.doc.html) - # All upstream columns this field references - # - # 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. - upstreamColumns( - filter: [Column_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/column_filter.doc.html), - orderBy: [ColumnSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Column](https://help.tableau.com/current/api/metadata_api/en-us/reference/column.doc.html)]! - # All upstream columns this field references - # - # 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. - upstreamColumnsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Column_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/column_filter.doc.html), - orderBy: [ColumnSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [ColumnsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnsconnection.doc.html) - } ` ## [_link_](#require-by) Require by - [AnalyticsField_Base GraphQL type for a field containing analytics metadata_](https://help.tableau.com/current/api/metadata_api/en-us/reference/analyticsfield.doc.html "AnalyticsField - Base GraphQL type for a field containing analytics metadata") - [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/current/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/current/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") - [ColumnField_ColumnFields are a type of field which directly connects to a column in some type of table._](https://help.tableau.com/current/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/current/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/current/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") - [DataField_Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField._](https://help.tableau.com/current/api/metadata_api/en-us/reference/datafield.doc.html "DataField - Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField.") - [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/current/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/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [FieldReferencingField_Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula._](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield.doc.html "FieldReferencingField - Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula.") - [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/current/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/current/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") - [HierarchyFieldsConnection_Connection Type for HierarchyField_](https://help.tableau.com/current/api/metadata_api/en-us/reference/hierarchyfieldsconnection.doc.html "HierarchyFieldsConnection - Connection Type for HierarchyField") - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/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/current/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") _menu_ Types INPUT\_OBJECT # HierarchyField\_Filter Filter by GraphQL field and given value ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input HierarchyField_Filter { - # Name shown in server and desktop clients - name: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Name shown in server and desktop clients - nameWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.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/current/api/metadata_api/en-us/reference/id.doc.html) - # Unique identifier used by the metadata API. Not the same as the numeric ID used - # on server - idWithin: [[ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html)] - # True if the field is hidden - isHidden: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) - # True if the field is hidden - isHiddenWithin: [[Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html)] - # Filter the output based on text query. - text: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - } ` ## [_link_](#require-by) Require by - [AnalyticsField_Base GraphQL type for a field containing analytics metadata_](https://help.tableau.com/current/api/metadata_api/en-us/reference/analyticsfield.doc.html "AnalyticsField - Base GraphQL type for a field containing analytics metadata") - [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/current/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/current/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") - [ColumnField_ColumnFields are a type of field which directly connects to a column in some type of table._](https://help.tableau.com/current/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/current/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/current/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") - [DataField_Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField._](https://help.tableau.com/current/api/metadata_api/en-us/reference/datafield.doc.html "DataField - Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField.") - [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/current/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/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [FieldReferencingField_Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula._](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield.doc.html "FieldReferencingField - Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula.") - [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/current/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/current/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") - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/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/current/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") _menu_ Types INPUT\_OBJECT # HierarchyField\_Required\_Filter Filter by GraphQL field and given value ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input HierarchyField_Required_Filter { - # Name shown in server and desktop clients - name: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Name shown in server and desktop clients - nameWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.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/current/api/metadata_api/en-us/reference/id.doc.html) - # Unique identifier used by the metadata API. Not the same as the numeric ID used - # on server - idWithin: [[ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html)] - } ` ## [_link_](#require-by) Require by This element is not required by anyone _menu_ Types ENUM # HierarchyFieldOrderField Enum for fields that can be used for sorting ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - enum HierarchyFieldOrderField { - # Sort by downstreamSheets count - DOWNSTREAM_SHEETS_COUNT - # Sort by fields count - FIELDS_COUNT - # Sort by id - ID - # Sort by isHidden - IS_HIDDEN - # Sort by name - NAME - } ` ## [_link_](#require-by) Require by - [HierarchyFieldSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/hierarchyfieldsortorder.doc.html "HierarchyFieldSortOrder - 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.") _menu_ Types OBJECT # HierarchyFieldsConnection Connection Type for HierarchyField ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type HierarchyFieldsConnection { - # List of nodes - nodes: [[HierarchyField](https://help.tableau.com/current/api/metadata_api/en-us/reference/hierarchyfield.doc.html)!]! - # Information for pagination - pageInfo: [PageInfo](https://help.tableau.com/current/api/metadata_api/en-us/reference/pageinfo.doc.html)! - # Total number of objects in connection - totalCount: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html)! - } ` ## [_link_](#require-by) Require by - [AnalyticsField_Base GraphQL type for a field containing analytics metadata_](https://help.tableau.com/current/api/metadata_api/en-us/reference/analyticsfield.doc.html "AnalyticsField - Base GraphQL type for a field containing analytics metadata") - [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/current/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/current/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") - [ColumnField_ColumnFields are a type of field which directly connects to a column in some type of table._](https://help.tableau.com/current/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/current/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/current/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") - [DataField_Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField._](https://help.tableau.com/current/api/metadata_api/en-us/reference/datafield.doc.html "DataField - Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField.") - [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/current/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/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [FieldReferencingField_Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula._](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield.doc.html "FieldReferencingField - Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula.") - [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/current/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/current/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") - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/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/current/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") _menu_ Types INPUT\_OBJECT # HierarchyFieldSortOrder 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. ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input HierarchyFieldSortOrder { - # GraphQL field to sort on - field: [HierarchyFieldOrderField](https://help.tableau.com/current/api/metadata_api/en-us/reference/hierarchyfieldorderfield.doc.html)! - # Order direction to sort output - direction: [OrderDirection](https://help.tableau.com/current/api/metadata_api/en-us/reference/orderdirection.doc.html)! - } ` ## [_link_](#require-by) Require by - [AnalyticsField_Base GraphQL type for a field containing analytics metadata_](https://help.tableau.com/current/api/metadata_api/en-us/reference/analyticsfield.doc.html "AnalyticsField - Base GraphQL type for a field containing analytics metadata") - [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/current/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/current/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") - [ColumnField_ColumnFields are a type of field which directly connects to a column in some type of table._](https://help.tableau.com/current/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/current/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/current/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") - [DataField_Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField._](https://help.tableau.com/current/api/metadata_api/en-us/reference/datafield.doc.html "DataField - Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField.") - [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/current/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/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [FieldReferencingField_Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula._](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield.doc.html "FieldReferencingField - Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula.") - [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/current/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/current/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") - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/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/current/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") # How Permissions Work Tableau Cloud and Tableau Server provide a space for accessing and managing published content. Beginning with version 2019.3, using the Tableau Metadata API, you have the ability to track and manage metadata and lineage of external assets used by the content published to your Tableau Cloud site or Tableau Server. In addition, when your Tableau Cloud site or Tableau Server has Data Management, you have access to features like data quality warnings, which are enabled by [Tableau Catalog \[↗\]](https://help.tableau.com/current/server/en-us/dm_catalog_overview.htm). **In this section** ## Tableau Catalog indexes content, assets, and metadata Metadata API contains indexed content, assets, and metadata from the content that has been published to your Tableau Cloud site or Tableau Server. You can query the Metadata API for all content and assets that it indexes. The Metadata API exposes metadata for the following: - **Tableau content**: workbooks, data sources, virtual connections, virtual connection tables, flows, projects, users, and sites. - **External assets**: databases and tables associated with Tableau content Metadata API classifies the metadata of any data that comes from outside the Tableau environment as external assets. The data that comes from outside the Tableau environment can be stored in many different formats, such as a database server or local .json files. The Metadata API only tracks metadata about assets; it doesn’t track the data in them. Metadata includes the following: - **Lineage information** or the relationship between items. For example, the Sales table is used by Superstore data source and Superstore Sample workbook. - **Schema information**. Some examples include: - Table names, column names, and column types. For example, Table A contains Columns A, B, and C, which are types INT, VARCHAR, and VARCHAR. - Database name and server location. For example, Database\_1 is a SQL Server database at http://example.net. - Data source name, and the names and types of the fields the data source contains. For example, Superstore data source has fields AA, BB, and CC. Field CC is a calculated field that refers back to both field AA and field BB. - **User curated, added, or managed information**. For example, asset descriptions, certifications, user contacts, data quality warnings, and more. ## Permissions on assets and their metadata Permissions control who is allowed to see and manage the data that is accessible from the Metadata API, for example who can see and manage external assets or who can see relationships shown through lineage queries. ### Access metadata about content and assets The permissions used to access metadata through the Metadata API work similarly to permissions for accessing content through Tableau Cloud or Tableau Server, with some additional considerations for external assets. The Metadata API uses the same View capability that Tableau Server uses to control the information you can see, with one fundamental difference. In general, when you don’t have View capabilities to access information, Tableau Server omits (also called filters) that information from your results. However, when you don’t have View capabilities to access information, the Metadata API by default hides (also called obfuscates) that information from your results. If you would rather omit any detail about the related assets that you do not have View capability to access, you can specify the “filter” mode in a query. If you specify the filter permissions mode, only the results whose attributes of external assets you have permissions to see are returned. For an example, see [Filter mode](/current/api/metadata_api/en-us/docs/meta_api_examples.html#filter-mode) section of the Example Queries topic. For more information, see one of the following topics: - For Tableau Cloud: [Permissions on metadata \[↗\]](https://help.tableau.com/current/online/en-us/dm_perms_assets.htm#permissions-on-metadata) - For Tableau Server: [Permissions on metadata \[↗\]](https://help.tableau.com/current/server/en-us/dm_perms_assets.htm#permissions-on-metadata) #### Permissions on Tableau content As mentioned above, the Metadata API uses view and manage capabilities that are already used by existing Tableau content to control the information you can see and manage on Tableau content. For more general information on View capabilities, see one of the following topics: - For Tableau Cloud: [How Permissions are Evaluated \[↗\]](https://help.tableau.com/current/online/en-us/permissions.htm#permissioncapabilities) - For Tableau Server: [How Permissions are Evaluated \[↗\]](https://help.tableau.com/current/server/en-us/permissions.htm#permissioncapabilities) #### Permissions on external assets using derived permissions You are automatically granted View capability to external assets when the derived permissions site setting has been turned on for a site. This site setting is enabled by default if Tableau Cloud or Tableau Server has Data Management. Without Data Management, the site setting must be enabled manually for Tableau Server by the Tableau Server admin. In addition, if your site has Data Management, it’s possible to explicitly grant permissions for external assets. For more information and details around permissions, see one of the following topics: - For Tableau Cloud: [Permissions on external assets using derived permissions \[↗\]](https://help.tableau.com/current/online/en-us/dm_perms_assets.htm#derived) - For Tableau Server: [Permissions on external assets using derived permissions \[↗\]](https://help.tableau.com/current/server/en-us/dm_perms_assets.htm#derived) **Note:** If you are the owner of a flow, derived permissions enable Overwrite and Set Permissions capabilities as well. You can edit and manage permissions for the database and table metadata used by the flow output. For these flow scenarios, the capabilities apply only after there has been at least one successful flow run under you as the current owner of the flow. # How to Authenticate There are two primary ways you can use the Tableau Metadata API: - **Interactively through GraphiQL**. GraphiQL is an in-browser query tool. For more information, see [Explore the GraphQL schema using GraphiQL](/current/api/metadata_api/en-us/docs/meta_api_start.html#explore-the-graphql-schema-using-graphiql). - **Programmatically through the GraphQL endpoint**: For this, you need to get an authentication token, as described in the [Authenticate using Tableau REST API](#signin) method. Tableau Cloud and Tableau Server have different requirements for accessing the Metadata API. Tableau Cloud requires Data Management to access the Metadata API, but Tableau Server does not. This requirement started with Tableau Cloud October 2026. If you were using the Metadata API without Data Management at that time, you can continue doing so until June 2027. - **If licensed with Data Management:** You can start using the GraphiQL tool immediately or review the section below to learn how to get an authentication token so you can programmatically use the Metadata API. - **If Tableau Server is _not_ licensed with Data Management:** After the Metadata API has been enabled, review the section below to learn how to get an authentication token so you can programmatically use the Metadata API. **In this section** ## Authenticate through Sign In method The Metadata API requires that you send an authentication token with each query sent. The token lets Tableau Cloud or Tableau Server verify your identity and makes sure that you’re signed in. To get a token, you can call the Sign In method, in one of three ways, using the Tableau REST API versions 3.6 or later. ### Sign in using a personal access token (PAT) Refer to [Make a Sign In Request with a Personal Access Token \[↗\]](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_auth.htm#make-a-sign-in-request-with-a-personal-access-token) in the Tableau REST API Help for more information. ### Sign in using a JSON web token (JWT) Starting in Tableau Cloud October 2023 / Server 2023.3, the Metadata API respects credentials tokens that were obtained via a JSON web token (JWT) and Tableau connected apps. Set scope (scp) in the JWT to “tableau:content:read”. The permissions of the user in the JWT determine query results. Refer to [Make a Sign In Request with a JWT \[↗\]](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_auth.htm#make-a-sign-in-request-with-jwt) in the Tableau REST API Help for more information on using a JWT to create a credentials token that you can use with the Metadata API. ### Sign in using username and password Refer to [Make a Sign In Request with Username and Password \[↗\]](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_auth.htm#make-a-sign-in-request-with-username-and-password) in the Tableau REST API Help for more information. For more information about token expiration, changing the token timeout value, and more, see [Using the Authentication Token In Subsequent Calls \[↗\]](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_auth.htm#using_auth_token) topic in the Tableau REST API Help. _menu_ Types SCALAR # ID Built-in ID ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - scalar ID ` ## [_link_](#require-by) Require by - [AnalyticsField\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/analyticsfield_filter.doc.html "AnalyticsField_Filter - Filter by GraphQL field and given value") - [AskDataExtension_AskDataExtensions to base Tableau functionality._](https://help.tableau.com/current/api/metadata_api/en-us/reference/askdataextension.doc.html "AskDataExtension - AskDataExtensions to base Tableau functionality.") - [AskDataExtension\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/askdataextension_filter.doc.html "AskDataExtension_Filter - Filter by GraphQL field and given value") - [AskDataExtension\_Required\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/askdataextension_required_filter.doc.html "AskDataExtension_Required_Filter - Filter by GraphQL field and given value") - [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/current/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") - [BinField\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/binfield_filter.doc.html "BinField_Filter - Filter by GraphQL field and given value") - [BinField\_Required\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/binfield_required_filter.doc.html "BinField_Required_Filter - Filter by GraphQL field and given value") - [CalculatedField_GraphQL type for a calculated field. See https://onlinehelp.tableau.com/current/pro/desktop/en-us/calculations\_calculatedfields.html_](https://help.tableau.com/current/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") - [CalculatedField\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/calculatedfield_filter.doc.html "CalculatedField_Filter - Filter by GraphQL field and given value") - [CalculatedField\_Required\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/calculatedfield_required_filter.doc.html "CalculatedField_Required_Filter - Filter by GraphQL field and given value") - [CanHaveLabels_A content item that can have labels. \*Available in Tableau Cloud March 2023 / Server 2023.1 and later.\*_](canhavelabels.doc.html "CanHaveLabels - A content item that can have labels. *Available in Tableau Cloud March 2023 / Server 2023.1 and later.*") - [CanHaveLabels\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/canhavelabels_filter.doc.html "CanHaveLabels_Filter - Filter by GraphQL field and given value") - [Certifiable_A content item that can be certified_](https://help.tableau.com/current/api/metadata_api/en-us/reference/certifiable.doc.html "Certifiable - A content item that can be certified") - [Certifiable\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/certifiable_filter.doc.html "Certifiable_Filter - Filter by GraphQL field and given value") - [CloudFile_A cloud file connection_](https://help.tableau.com/current/api/metadata_api/en-us/reference/cloudfile.doc.html "CloudFile - A cloud file connection") - [CloudFile\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/cloudfile_filter.doc.html "CloudFile_Filter - Filter by GraphQL field and given value") - [Column_GraphQL type for a table column_](https://help.tableau.com/current/api/metadata_api/en-us/reference/column.doc.html "Column - GraphQL type for a table column") - [Column\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/column_filter.doc.html "Column_Filter - Filter by GraphQL field and given value") - [Column\_Required\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/column_required_filter.doc.html "Column_Required_Filter - Filter by GraphQL field and given value") - [ColumnField_ColumnFields are a type of field which directly connects to a column in some type of table._](https://help.tableau.com/current/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.") - [ColumnField\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnfield_filter.doc.html "ColumnField_Filter - Filter by GraphQL field and given value") - [ColumnField\_Required\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnfield_required_filter.doc.html "ColumnField_Required_Filter - Filter by GraphQL field and given value") - [CombinedField_GraphQL type for a combined field. Combined fields concatanate fields together into one string._](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedfield.doc.html "CombinedField - GraphQL type for a combined field. Combined fields concatanate fields together into one string.") - [CombinedField\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedfield_filter.doc.html "CombinedField_Filter - Filter by GraphQL field and given value") - [CombinedField\_Required\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedfield_required_filter.doc.html "CombinedField_Required_Filter - Filter by GraphQL field and given value") - [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/current/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") - [CombinedSetField\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedsetfield_filter.doc.html "CombinedSetField_Filter - Filter by GraphQL field and given value") - [CombinedSetField\_Required\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedsetfield_required_filter.doc.html "CombinedSetField_Required_Filter - Filter by GraphQL field and given value") - [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/current/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.") - [CustomSQLTable\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/customsqltable_filter.doc.html "CustomSQLTable_Filter - Filter by GraphQL field and given value") - [Dashboard_A dashboard contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard.doc.html "Dashboard - A dashboard contained in a published workbook.") - [Dashboard\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard_filter.doc.html "Dashboard_Filter - Filter by GraphQL field and given value") - [Database_A database containing tables_](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html "Database - A database containing tables") - [Database\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/database_filter.doc.html "Database_Filter - Filter by GraphQL field and given value") - [DatabaseServer_A database server connection_](https://help.tableau.com/current/api/metadata_api/en-us/reference/databaseserver.doc.html "DatabaseServer - A database server connection") - [DatabaseServer\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/databaseserver_filter.doc.html "DatabaseServer_Filter - Filter by GraphQL field and given value") - [DatabaseTable_A table that is contained in a database_](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable.doc.html "DatabaseTable - A table that is contained in a database") - [DatabaseTable\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html "DatabaseTable_Filter - Filter by GraphQL field and given value") - [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.*") - [DataCloud\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/datacloud_filter.doc.html "DataCloud_Filter - Filter by GraphQL field and given value") - [DataField\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/datafield_filter.doc.html "DataField_Filter - Filter by GraphQL field and given value") - [DataQualityCertification_A data quality certification associated with a content item_](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitycertification.doc.html "DataQualityCertification - A data quality certification associated with a content item") - [DataQualityCertification\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitycertification_filter.doc.html "DataQualityCertification_Filter - Filter by GraphQL field and given value") - [DataQualityWarning_A data quality warning associated with a content item_](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarning.doc.html "DataQualityWarning - A data quality warning associated with a content item") - [DataQualityWarning\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarning_filter.doc.html "DataQualityWarning_Filter - Filter by GraphQL field and given value") - [Datasource_Root GraphQL type for embedded and published data sources Data sources are a way to represent how Tableau Desktop and Tableau Server model and connect to data. Data sources can be published separately, as a published data source, or may be contained in a workbook as an embedded data source. See https://onlinehelp.tableau.com/current/server/en-us/datasource.htm_](datasource.doc.html "Datasource - Root GraphQL type for embedded and published data sources Data sources are a way to represent how Tableau Desktop and Tableau Server model and connect to data. Data sources can be published separately, as a published data source, or may be contained in a workbook as an embedded data source. See https://onlinehelp.tableau.com/current/server/en-us/datasource.htm") - [Datasource\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasource_filter.doc.html "Datasource_Filter - Filter by GraphQL field and given value") - [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/current/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.") - [DatasourceField\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefield_filter.doc.html "DatasourceField_Filter - Filter by GraphQL field and given value") - [DatasourceField\_Required\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefield_required_filter.doc.html "DatasourceField_Required_Filter - Filter by GraphQL field and given value") - [DatasourceFilter_Data source filters include/exclude certain values from a single field to filter out rows of data from this data source. For data security reasons, we don't track the values used in the filter in this schema, but you can see the field used in the filter. See https://onlinehelp.tableau.com/current/pro/desktop/en-us/filtering\_datasource.html_](datasourcefilter.doc.html "DatasourceFilter - Data source filters include/exclude certain values from a single field to filter out rows of data from this data source. For data security reasons, we don't track the values used in the filter in this schema, but you can see the field used in the filter. See https://onlinehelp.tableau.com/current/pro/desktop/en-us/filtering_datasource.html") - [DatasourceFilter\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefilter_filter.doc.html "DatasourceFilter_Filter - Filter by GraphQL field and given value") - [EmbeddedDatasource_A data source embedded in a workbook_](https://help.tableau.com/current/api/metadata_api/en-us/reference/embeddeddatasource.doc.html "EmbeddedDatasource - A data source embedded in a workbook") - [EmbeddedDatasource\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/embeddeddatasource_filter.doc.html "EmbeddedDatasource_Filter - Filter by GraphQL field and given value") - [ExtractType\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/extracttype_filter.doc.html "ExtractType_Filter - Filter by GraphQL field and given value") - [Field_Base GraphQL type for a field_](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [Field\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/field_filter.doc.html "Field_Filter - Filter by GraphQL field and given value") - [Field\_Required\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/field_required_filter.doc.html "Field_Required_Filter - Filter by GraphQL field and given value") - [FieldDataType\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/fielddatatype_filter.doc.html "FieldDataType_Filter - Filter by GraphQL field and given value") - [FieldReferencingField_Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula._](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield.doc.html "FieldReferencingField - Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula.") - [FieldReferencingField\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield_filter.doc.html "FieldReferencingField_Filter - Filter by GraphQL field and given value") - [FieldRole\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldrole_filter.doc.html "FieldRole_Filter - Filter by GraphQL field and given value") - [FieldRoleCategory\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldrolecategory_filter.doc.html "FieldRoleCategory_Filter - Filter by GraphQL field and given value") - [File_A file connection_](https://help.tableau.com/current/api/metadata_api/en-us/reference/file.doc.html "File - A file connection") - [File\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/file_filter.doc.html "File_Filter - Filter by GraphQL field and given value") - [Flow_Flows are used to prepare data, which can include aggregation, cleaning, preprocessing, etc._](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow.doc.html "Flow - Flows are used to prepare data, which can include aggregation, cleaning, preprocessing, etc.") - [Flow\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow_filter.doc.html "Flow_Filter - Filter by GraphQL field and given value") - [FlowColumnInputField_Column input field implementation_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowcolumninputfield.doc.html "FlowColumnInputField - Column input field implementation") - [FlowColumnInputField\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowcolumninputfield_filter.doc.html "FlowColumnInputField_Filter - Filter by GraphQL field and given value") - [FlowColumnOutputField_Column output field implementation_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowcolumnoutputfield.doc.html "FlowColumnOutputField - Column output field implementation") - [FlowColumnOutputField\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowcolumnoutputfield_filter.doc.html "FlowColumnOutputField_Filter - Filter by GraphQL field and given value") - [FlowFieldInputField_Field input field implementation_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfield.doc.html "FlowFieldInputField - Field input field implementation") - [FlowFieldInputField\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfield_filter.doc.html "FlowFieldInputField_Filter - Filter by GraphQL field and given value") - [FlowFieldOutputField_Field output field implementation_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfield.doc.html "FlowFieldOutputField - Field output field implementation") - [FlowFieldOutputField\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfield_filter.doc.html "FlowFieldOutputField_Filter - Filter by GraphQL field and given value") - [FlowInputField_A wrapper for an input field contained in a published flow._](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowinputfield.doc.html "FlowInputField - A wrapper for an input field contained in a published flow.") - [FlowInputField\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowinputfield_filter.doc.html "FlowInputField_Filter - Filter by GraphQL field and given value") - [FlowOutputField_A wrapper for an output field contained in a published flow._](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowoutputfield.doc.html "FlowOutputField - A wrapper for an output field contained in a published flow.") - [FlowOutputField\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowoutputfield_filter.doc.html "FlowOutputField_Filter - Filter by GraphQL field and given value") - [FlowOutputStep_A flow output step_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowoutputstep.doc.html "FlowOutputStep - A flow output step") - [FlowOutputStep\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowoutputstep_filter.doc.html "FlowOutputStep_Filter - Filter by GraphQL field and given value") - [GenericLabel_A label that can be attached to assets. \*Available in Tableau Cloud March 2023 / Server 2023.1 and later.\*_](genericlabel.doc.html "GenericLabel - A label that can be attached to assets. *Available in Tableau Cloud March 2023 / Server 2023.1 and later.*") - [GenericLabel\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/genericlabel_filter.doc.html "GenericLabel_Filter - Filter by GraphQL field and given value") - [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/current/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") - [GroupField\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/groupfield_filter.doc.html "GroupField_Filter - Filter by GraphQL field and given value") - [GroupField\_Required\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/groupfield_required_filter.doc.html "GroupField_Required_Filter - Filter by GraphQL field and given value") - [HierarchyField_GraphQL type for a hierarchy. See https://onlinehelp.tableau.com/current/pro/desktop/en-us/qs\_hierarchies.html_](https://help.tableau.com/current/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") - [HierarchyField\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/hierarchyfield_filter.doc.html "HierarchyField_Filter - Filter by GraphQL field and given value") - [HierarchyField\_Required\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/hierarchyfield_required_filter.doc.html "HierarchyField_Required_Filter - Filter by GraphQL field and given value") - [Label_A label that can be attached to assets. \*Available in Tableau Cloud March 2023 / Server 2023.1 and later.\*_](label.doc.html "Label - A label that can be attached to assets. *Available in Tableau Cloud March 2023 / Server 2023.1 and later.*") - [Label\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/label_filter.doc.html "Label_Filter - Filter by GraphQL field and given value") - [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.*") - [Lens\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/lens_filter.doc.html "Lens_Filter - Filter by GraphQL field and given value") - [LensField_Lens Fields contain extra information based on an underlying datasource field_](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensfield.doc.html "LensField - Lens Fields contain extra information based on an underlying datasource field") - [LensField\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensfield_filter.doc.html "LensField_Filter - Filter by GraphQL field and given value") - [LensField\_Required\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensfield_required_filter.doc.html "LensField_Required_Filter - Filter by GraphQL field and given value") - [LinkedFlow\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/linkedflow_filter.doc.html "LinkedFlow_Filter - Filter by GraphQL field and given value") - [Metric_Metrics are time series data constructed from fields contained in views. \*Retired in Tableau Cloud February 2024 / Server 2024.2.\*_](metric.doc.html "Metric - Metrics are time series data constructed from fields contained in views. *Retired in Tableau Cloud February 2024 / Server 2024.2.*") - [Metric\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/metric_filter.doc.html "Metric_Filter - Filter by GraphQL field and given value") - [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.*") - [MetricDefinition\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinition_filter.doc.html "MetricDefinition_Filter - Filter by GraphQL field and given value") - [Node_Inheritance target_](https://help.tableau.com/current/api/metadata_api/en-us/reference/node.doc.html "Node - Inheritance target") - [Node\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/node_filter.doc.html "Node_Filter - Filter by GraphQL field and given value") - [Parameter_Tableau Parameter. For more info see https://onlinehelp.tableau.com/current/pro/desktop/en-us/parameters\_create.html_](https://help.tableau.com/current/api/metadata_api/en-us/reference/parameter.doc.html "Parameter - Tableau Parameter. For more info see https://onlinehelp.tableau.com/current/pro/desktop/en-us/parameters_create.html") - [Parameter\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/parameter_filter.doc.html "Parameter_Filter - Filter by GraphQL field and given value") - [PublishedDatasource_A Tableau data source that has been published separately to Tableau Server. It can be used by multiple workbooks._](https://help.tableau.com/current/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.") - [PublishedDatasource\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html "PublishedDatasource_Filter - Filter by GraphQL field and given value") - [RemoteType\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/remotetype_filter.doc.html "RemoteType_Filter - Filter by GraphQL field and given value") - [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/current/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") - [SetField\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/setfield_filter.doc.html "SetField_Filter - Filter by GraphQL field and given value") - [SetField\_Required\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/setfield_required_filter.doc.html "SetField_Required_Filter - Filter by GraphQL field and given value") - [Sheet_A sheet contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html "Sheet - A sheet contained in a published workbook.") - [Sheet\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet_filter.doc.html "Sheet_Filter - Filter by GraphQL field and given value") - [Table_A table containing columns_](https://help.tableau.com/current/api/metadata_api/en-us/reference/table.doc.html "Table - A table containing columns") - [Table\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/table_filter.doc.html "Table_Filter - Filter by GraphQL field and given value") - [TableAdditionalDetails_Additional details for the DatabaseTable type \*Available in Tableau Cloud February 2024 / Server 2024.2 and later.\*_](tableadditionaldetails.doc.html "TableAdditionalDetails - Additional details for the DatabaseTable type *Available in Tableau Cloud February 2024 / Server 2024.2 and later.*") - [TableAdditionalDetails\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableadditionaldetails_filter.doc.html "TableAdditionalDetails_Filter - Filter by GraphQL field and given value") - [TableauSite_Site on Tableau server_](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableausite.doc.html "TableauSite - Site on Tableau server") - [TableauSite\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableausite_filter.doc.html "TableauSite_Filter - Filter by GraphQL field and given value") - [TableauUser_User on a site on Tableau server_](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauuser.doc.html "TableauUser - User on a site on Tableau server") - [TableauUser\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauuser_filter.doc.html "TableauUser_Filter - Filter by GraphQL field and given value") - [TableType\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/tabletype_filter.doc.html "TableType_Filter - Filter by GraphQL field and given value") - [Tag_A tag associated with content items_](https://help.tableau.com/current/api/metadata_api/en-us/reference/tag.doc.html "Tag - A tag associated with content items") - [Tag\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/tag_filter.doc.html "Tag_Filter - Filter by GraphQL field and given value") - [Taggable_A content item that has a list of tags_](https://help.tableau.com/current/api/metadata_api/en-us/reference/taggable.doc.html "Taggable - A content item that has a list of tags") - [Taggable\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/taggable_filter.doc.html "Taggable_Filter - Filter by GraphQL field and given value") - [View_A view contained in a published workbook. Views can be sheets or dashboards._](https://help.tableau.com/current/api/metadata_api/en-us/reference/view.doc.html "View - A view contained in a published workbook. Views can be sheets or dashboards.") - [View\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/view_filter.doc.html "View_Filter - Filter by GraphQL field and given value") - [VirtualConnection_A virtual connection. \*Available in Tableau Cloud March 2022 / Server 2022.1 and later.\*_](virtualconnection.doc.html "VirtualConnection - A virtual connection. *Available in Tableau Cloud March 2022 / Server 2022.1 and later.*") - [VirtualConnection\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html "VirtualConnection_Filter - Filter by GraphQL field and given value") - [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.*") - [VirtualConnectionTable\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html "VirtualConnectionTable_Filter - Filter by GraphQL field and given value") - [Warnable_A content item that can have data quality warnings_](https://help.tableau.com/current/api/metadata_api/en-us/reference/warnable.doc.html "Warnable - A content item that can have data quality warnings") - [Warnable\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/warnable_filter.doc.html "Warnable_Filter - Filter by GraphQL field and given value") - [WebDataConnector_A web data connector_](https://help.tableau.com/current/api/metadata_api/en-us/reference/webdataconnector.doc.html "WebDataConnector - A web data connector") - [WebDataConnector\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/webdataconnector_filter.doc.html "WebDataConnector_Filter - Filter by GraphQL field and given value") - [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/current/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).") - [Workbook\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbook_filter.doc.html "Workbook_Filter - Filter by GraphQL field and given value") _menu_ Types # include Directs the executor to include this field or fragment only when the `if` argument is true ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - directive @include(if: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html)!) on FIELD | FRAGMENT_SPREAD | INLINE_FRAGMENT ` ## [_link_](#require-by) Require by This element is not required by anyone _menu_ Types ENUM # InheritanceType Method of selecting the objects (i.e., inheritance sources) to inherit from ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - enum InheritanceType { - # Inherit from the closest unambiguous upstream object - FIRST - } ` ## [_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/current/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/current/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") - [Column_GraphQL type for a table column_](https://help.tableau.com/current/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/current/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/current/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/current/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") - [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/current/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/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [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/current/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/current/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") - [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/current/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") _menu_ Types OBJECT # InheritedStringResult Wrapper type containing the inherited result ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type InheritedStringResult { - # Unique identifier of the object (i.e., inheritance source) that is providing the - # inherited attribute - assetId: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)! - # Name of the property that is being inherited - attribute: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)! - # Inherited value - value: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Number of edges in between the inheritance source and inheritance target - distance: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html) - # The edges between inheritance source and inheritance target - edges: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)!] - # The object (i.e., inheritance source) where the attribute was inherited from - asset: [Node](https://help.tableau.com/current/api/metadata_api/en-us/reference/node.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/current/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/current/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") - [Column_GraphQL type for a table column_](https://help.tableau.com/current/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/current/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/current/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/current/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") - [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/current/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/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [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/current/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/current/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") - [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/current/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") _menu_ Types SCALAR # Int Built-in Int ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - scalar Int ` ## [_link_](#require-by) Require by - [AnalyticsField_Base GraphQL type for a field containing analytics metadata_](https://help.tableau.com/current/api/metadata_api/en-us/reference/analyticsfield.doc.html "AnalyticsField - Base GraphQL type for a field containing analytics metadata") - [AnalyticsFieldsConnection_Connection Type for AnalyticsField_](https://help.tableau.com/current/api/metadata_api/en-us/reference/analyticsfieldsconnection.doc.html "AnalyticsFieldsConnection - Connection Type for AnalyticsField") - [AskDataExtensionsConnection_Connection Type for AskDataExtension_](https://help.tableau.com/current/api/metadata_api/en-us/reference/askdataextensionsconnection.doc.html "AskDataExtensionsConnection - Connection Type for AskDataExtension") - [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/current/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") - [BinFieldsConnection_Connection Type for BinField_](https://help.tableau.com/current/api/metadata_api/en-us/reference/binfieldsconnection.doc.html "BinFieldsConnection - Connection Type for BinField") - [CalculatedField_GraphQL type for a calculated field. See https://onlinehelp.tableau.com/current/pro/desktop/en-us/calculations\_calculatedfields.html_](https://help.tableau.com/current/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") - [CalculatedFieldsConnection_Connection Type for CalculatedField_](https://help.tableau.com/current/api/metadata_api/en-us/reference/calculatedfieldsconnection.doc.html "CalculatedFieldsConnection - Connection Type for CalculatedField") - [CanHaveLabels_A content item that can have labels. \*Available in Tableau Cloud March 2023 / Server 2023.1 and later.\*_](canhavelabels.doc.html "CanHaveLabels - A content item that can have labels. *Available in Tableau Cloud March 2023 / Server 2023.1 and later.*") - [CanHaveLabelsesConnection_Connection Type for CanHaveLabels_](https://help.tableau.com/current/api/metadata_api/en-us/reference/canhavelabelsesconnection.doc.html "CanHaveLabelsesConnection - Connection Type for CanHaveLabels") - [Certifiable_A content item that can be certified_](https://help.tableau.com/current/api/metadata_api/en-us/reference/certifiable.doc.html "Certifiable - A content item that can be certified") - [CertifiablesConnection_Connection Type for Certifiable_](https://help.tableau.com/current/api/metadata_api/en-us/reference/certifiablesconnection.doc.html "CertifiablesConnection - Connection Type for Certifiable") - [CloudFile_A cloud file connection_](https://help.tableau.com/current/api/metadata_api/en-us/reference/cloudfile.doc.html "CloudFile - A cloud file connection") - [CloudFilesConnection_Connection Type for CloudFile_](https://help.tableau.com/current/api/metadata_api/en-us/reference/cloudfilesconnection.doc.html "CloudFilesConnection - Connection Type for CloudFile") - [Column_GraphQL type for a table column_](https://help.tableau.com/current/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/current/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.") - [ColumnFieldsConnection_Connection Type for ColumnField_](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnfieldsconnection.doc.html "ColumnFieldsConnection - Connection Type for ColumnField") - [ColumnsConnection_Connection Type for Column_](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnsconnection.doc.html "ColumnsConnection - Connection Type for Column") - [CombinedField_GraphQL type for a combined field. Combined fields concatanate fields together into one string._](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedfield.doc.html "CombinedField - GraphQL type for a combined field. Combined fields concatanate fields together into one string.") - [CombinedFieldsConnection_Connection Type for CombinedField_](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedfieldsconnection.doc.html "CombinedFieldsConnection - Connection Type for CombinedField") - [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/current/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") - [CombinedSetFieldsConnection_Connection Type for CombinedSetField_](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedsetfieldsconnection.doc.html "CombinedSetFieldsConnection - Connection Type for CombinedSetField") - [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/current/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.") - [CustomSQLTablesConnection_Connection Type for CustomSQLTable_](https://help.tableau.com/current/api/metadata_api/en-us/reference/customsqltablesconnection.doc.html "CustomSQLTablesConnection - Connection Type for CustomSQLTable") - [Dashboard_A dashboard contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard.doc.html "Dashboard - A dashboard contained in a published workbook.") - [DashboardsConnection_Connection Type for Dashboard_](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboardsconnection.doc.html "DashboardsConnection - Connection Type for Dashboard") - [Database_A database containing tables_](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html "Database - A database containing tables") - [DatabasesConnection_Connection Type for Database_](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesconnection.doc.html "DatabasesConnection - Connection Type for Database") - [DatabaseServer_A database server connection_](https://help.tableau.com/current/api/metadata_api/en-us/reference/databaseserver.doc.html "DatabaseServer - A database server connection") - [DatabaseServersConnection_Connection Type for DatabaseServer_](https://help.tableau.com/current/api/metadata_api/en-us/reference/databaseserversconnection.doc.html "DatabaseServersConnection - Connection Type for DatabaseServer") - [DatabaseTable_A table that is contained in a database_](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable.doc.html "DatabaseTable - A table that is contained in a database") - [DatabaseTablesConnection_Connection Type for DatabaseTable_](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesconnection.doc.html "DatabaseTablesConnection - Connection Type for DatabaseTable") - [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.*") - [DataCloudsConnection_Connection Type for DataCloud_](https://help.tableau.com/current/api/metadata_api/en-us/reference/datacloudsconnection.doc.html "DataCloudsConnection - Connection Type for DataCloud") - [DataField_Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField._](https://help.tableau.com/current/api/metadata_api/en-us/reference/datafield.doc.html "DataField - Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField.") - [DataFieldsConnection_Connection Type for DataField_](https://help.tableau.com/current/api/metadata_api/en-us/reference/datafieldsconnection.doc.html "DataFieldsConnection - Connection Type for DataField") - [DataQualityCertificationsConnection_Connection Type for DataQualityCertification_](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitycertificationsconnection.doc.html "DataQualityCertificationsConnection - Connection Type for DataQualityCertification") - [DataQualityWarningsConnection_Connection Type for DataQualityWarning_](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarningsconnection.doc.html "DataQualityWarningsConnection - Connection Type for DataQualityWarning") - [Datasource_Root GraphQL type for embedded and published data sources Data sources are a way to represent how Tableau Desktop and Tableau Server model and connect to data. Data sources can be published separately, as a published data source, or may be contained in a workbook as an embedded data source. See https://onlinehelp.tableau.com/current/server/en-us/datasource.htm_](datasource.doc.html "Datasource - Root GraphQL type for embedded and published data sources Data sources are a way to represent how Tableau Desktop and Tableau Server model and connect to data. Data sources can be published separately, as a published data source, or may be contained in a workbook as an embedded data source. See https://onlinehelp.tableau.com/current/server/en-us/datasource.htm") - [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/current/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.") - [DatasourceFieldsConnection_Connection Type for DatasourceField_](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefieldsconnection.doc.html "DatasourceFieldsConnection - Connection Type for DatasourceField") - [DatasourceFiltersConnection_Connection Type for DatasourceFilter_](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefiltersconnection.doc.html "DatasourceFiltersConnection - Connection Type for DatasourceFilter") - [DatasourcesConnection_Connection Type for Datasource_](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcesconnection.doc.html "DatasourcesConnection - Connection Type for Datasource") - [EmbeddedDatasource_A data source embedded in a workbook_](https://help.tableau.com/current/api/metadata_api/en-us/reference/embeddeddatasource.doc.html "EmbeddedDatasource - A data source embedded in a workbook") - [EmbeddedDatasourcesConnection_Connection Type for EmbeddedDatasource_](https://help.tableau.com/current/api/metadata_api/en-us/reference/embeddeddatasourcesconnection.doc.html "EmbeddedDatasourcesConnection - Connection Type for EmbeddedDatasource") - [Field_Base GraphQL type for a field_](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [FieldReferencingField_Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula._](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield.doc.html "FieldReferencingField - Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula.") - [FieldReferencingFieldsConnection_Connection Type for FieldReferencingField_](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfieldsconnection.doc.html "FieldReferencingFieldsConnection - Connection Type for FieldReferencingField") - [FieldsConnection_Connection Type for Field_](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsconnection.doc.html "FieldsConnection - Connection Type for Field") - [File_A file connection_](https://help.tableau.com/current/api/metadata_api/en-us/reference/file.doc.html "File - A file connection") - [FilesConnection_Connection Type for File_](https://help.tableau.com/current/api/metadata_api/en-us/reference/filesconnection.doc.html "FilesConnection - Connection Type for File") - [Flow_Flows are used to prepare data, which can include aggregation, cleaning, preprocessing, etc._](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow.doc.html "Flow - Flows are used to prepare data, which can include aggregation, cleaning, preprocessing, etc.") - [FlowColumnInputField_Column input field implementation_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowcolumninputfield.doc.html "FlowColumnInputField - Column input field implementation") - [FlowColumnInputFieldsConnection_Connection Type for FlowColumnInputField_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowcolumninputfieldsconnection.doc.html "FlowColumnInputFieldsConnection - Connection Type for FlowColumnInputField") - [FlowColumnOutputField_Column output field implementation_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowcolumnoutputfield.doc.html "FlowColumnOutputField - Column output field implementation") - [FlowColumnOutputFieldsConnection_Connection Type for FlowColumnOutputField_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowcolumnoutputfieldsconnection.doc.html "FlowColumnOutputFieldsConnection - Connection Type for FlowColumnOutputField") - [FlowFieldInputField_Field input field implementation_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfield.doc.html "FlowFieldInputField - Field input field implementation") - [FlowFieldInputFieldsConnection_Connection Type for FlowFieldInputField_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfieldsconnection.doc.html "FlowFieldInputFieldsConnection - Connection Type for FlowFieldInputField") - [FlowFieldOutputField_Field output field implementation_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfield.doc.html "FlowFieldOutputField - Field output field implementation") - [FlowFieldOutputFieldsConnection_Connection Type for FlowFieldOutputField_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfieldsconnection.doc.html "FlowFieldOutputFieldsConnection - Connection Type for FlowFieldOutputField") - [FlowInputField_A wrapper for an input field contained in a published flow._](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowinputfield.doc.html "FlowInputField - A wrapper for an input field contained in a published flow.") - [FlowInputFieldsConnection_Connection Type for FlowInputField_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowinputfieldsconnection.doc.html "FlowInputFieldsConnection - Connection Type for FlowInputField") - [FlowOutputField_A wrapper for an output field contained in a published flow._](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowoutputfield.doc.html "FlowOutputField - A wrapper for an output field contained in a published flow.") - [FlowOutputFieldsConnection_Connection Type for FlowOutputField_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowoutputfieldsconnection.doc.html "FlowOutputFieldsConnection - Connection Type for FlowOutputField") - [FlowOutputStep_A flow output step_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowoutputstep.doc.html "FlowOutputStep - A flow output step") - [FlowOutputStepsConnection_Connection Type for FlowOutputStep_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowoutputstepsconnection.doc.html "FlowOutputStepsConnection - Connection Type for FlowOutputStep") - [FlowsConnection_Connection Type for Flow_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsconnection.doc.html "FlowsConnection - Connection Type for Flow") - [GenericLabelsConnection_Connection Type for GenericLabel_](https://help.tableau.com/current/api/metadata_api/en-us/reference/genericlabelsconnection.doc.html "GenericLabelsConnection - Connection Type for GenericLabel") - [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/current/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") - [GroupFieldsConnection_Connection Type for GroupField_](https://help.tableau.com/current/api/metadata_api/en-us/reference/groupfieldsconnection.doc.html "GroupFieldsConnection - Connection Type for GroupField") - [HierarchyField_GraphQL type for a hierarchy. See https://onlinehelp.tableau.com/current/pro/desktop/en-us/qs\_hierarchies.html_](https://help.tableau.com/current/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") - [HierarchyFieldsConnection_Connection Type for HierarchyField_](https://help.tableau.com/current/api/metadata_api/en-us/reference/hierarchyfieldsconnection.doc.html "HierarchyFieldsConnection - Connection Type for HierarchyField") - [InheritedStringResult_Wrapper type containing the inherited result_](https://help.tableau.com/current/api/metadata_api/en-us/reference/inheritedstringresult.doc.html "InheritedStringResult - Wrapper type containing the inherited result") - [LabelsConnection_Connection Type for Label_](https://help.tableau.com/current/api/metadata_api/en-us/reference/labelsconnection.doc.html "LabelsConnection - Connection Type for Label") - [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.*") - [LensesConnection_Connection Type for Lens_](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensesconnection.doc.html "LensesConnection - Connection Type for Lens") - [LensFieldsConnection_Connection Type for LensField_](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensfieldsconnection.doc.html "LensFieldsConnection - Connection Type for LensField") - [LinkedFlowsConnection_Connection Type for LinkedFlow_](https://help.tableau.com/current/api/metadata_api/en-us/reference/linkedflowsconnection.doc.html "LinkedFlowsConnection - Connection Type for LinkedFlow") - [Metric_Metrics are time series data constructed from fields contained in views. \*Retired in Tableau Cloud February 2024 / Server 2024.2.\*_](metric.doc.html "Metric - Metrics are time series data constructed from fields contained in views. *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.*") - [MetricDefinitionsConnection_Connection Type for MetricDefinition_](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsconnection.doc.html "MetricDefinitionsConnection - Connection Type for MetricDefinition") - [MetricsConnection_Connection Type for Metric_](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricsconnection.doc.html "MetricsConnection - Connection Type for Metric") - [NodesConnection_Connection Type for Node_](https://help.tableau.com/current/api/metadata_api/en-us/reference/nodesconnection.doc.html "NodesConnection - Connection Type for Node") - [Parameter_Tableau Parameter. For more info see https://onlinehelp.tableau.com/current/pro/desktop/en-us/parameters\_create.html_](https://help.tableau.com/current/api/metadata_api/en-us/reference/parameter.doc.html "Parameter - Tableau Parameter. For more info see https://onlinehelp.tableau.com/current/pro/desktop/en-us/parameters_create.html") - [ParametersConnection_Connection Type for Parameter_](https://help.tableau.com/current/api/metadata_api/en-us/reference/parametersconnection.doc.html "ParametersConnection - Connection Type for Parameter") - [PublishedDatasource_A Tableau data source that has been published separately to Tableau Server. It can be used by multiple workbooks._](https://help.tableau.com/current/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.") - [PublishedDatasourcesConnection_Connection Type for PublishedDatasource_](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesconnection.doc.html "PublishedDatasourcesConnection - Connection Type for PublishedDatasource") - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/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/current/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") - [SetFieldsConnection_Connection Type for SetField_](https://help.tableau.com/current/api/metadata_api/en-us/reference/setfieldsconnection.doc.html "SetFieldsConnection - Connection Type for SetField") - [Sheet_A sheet contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html "Sheet - A sheet contained in a published workbook.") - [SheetsConnection_Connection Type for Sheet_](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsconnection.doc.html "SheetsConnection - Connection Type for Sheet") - [Table_A table containing columns_](https://help.tableau.com/current/api/metadata_api/en-us/reference/table.doc.html "Table - A table containing columns") - [TableAdditionalDetails_Additional details for the DatabaseTable type \*Available in Tableau Cloud February 2024 / Server 2024.2 and later.\*_](tableadditionaldetails.doc.html "TableAdditionalDetails - Additional details for the DatabaseTable type *Available in Tableau Cloud February 2024 / Server 2024.2 and later.*") - [TableAdditionalDetailsesConnection_Connection Type for TableAdditionalDetails_](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableadditionaldetailsesconnection.doc.html "TableAdditionalDetailsesConnection - Connection Type for TableAdditionalDetails") - [TableauSite_Site on Tableau server_](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableausite.doc.html "TableauSite - Site on Tableau server") - [TableauSitesConnection_Connection Type for TableauSite_](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableausitesconnection.doc.html "TableauSitesConnection - Connection Type for TableauSite") - [TableauUser_User on a site on Tableau server_](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauuser.doc.html "TableauUser - User on a site on Tableau server") - [TableauUsersConnection_Connection Type for TableauUser_](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauusersconnection.doc.html "TableauUsersConnection - Connection Type for TableauUser") - [TablesConnection_Connection Type for Table_](https://help.tableau.com/current/api/metadata_api/en-us/reference/tablesconnection.doc.html "TablesConnection - Connection Type for Table") - [Tag_A tag associated with content items_](https://help.tableau.com/current/api/metadata_api/en-us/reference/tag.doc.html "Tag - A tag associated with content items") - [Taggable_A content item that has a list of tags_](https://help.tableau.com/current/api/metadata_api/en-us/reference/taggable.doc.html "Taggable - A content item that has a list of tags") - [TaggablesConnection_Connection Type for Taggable_](https://help.tableau.com/current/api/metadata_api/en-us/reference/taggablesconnection.doc.html "TaggablesConnection - Connection Type for Taggable") - [TagsConnection_Connection Type for Tag_](https://help.tableau.com/current/api/metadata_api/en-us/reference/tagsconnection.doc.html "TagsConnection - Connection Type for Tag") - [View_A view contained in a published workbook. Views can be sheets or dashboards._](https://help.tableau.com/current/api/metadata_api/en-us/reference/view.doc.html "View - A view contained in a published workbook. Views can be sheets or dashboards.") - [ViewsConnection_Connection Type for View_](https://help.tableau.com/current/api/metadata_api/en-us/reference/viewsconnection.doc.html "ViewsConnection - Connection Type for View") - [VirtualConnection_A virtual connection. \*Available in Tableau Cloud March 2022 / Server 2022.1 and later.\*_](virtualconnection.doc.html "VirtualConnection - A virtual connection. *Available in Tableau Cloud March 2022 / Server 2022.1 and later.*") - [VirtualConnectionsConnection_Connection Type for VirtualConnection_](https://help.tableau.com/current/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.*") - [VirtualConnectionTablesConnection_Connection Type for VirtualConnectionTable_](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesconnection.doc.html "VirtualConnectionTablesConnection - Connection Type for VirtualConnectionTable") - [Warnable_A content item that can have data quality warnings_](https://help.tableau.com/current/api/metadata_api/en-us/reference/warnable.doc.html "Warnable - A content item that can have data quality warnings") - [WarnablesConnection_Connection Type for Warnable_](https://help.tableau.com/current/api/metadata_api/en-us/reference/warnablesconnection.doc.html "WarnablesConnection - Connection Type for Warnable") - [WebDataConnector_A web data connector_](https://help.tableau.com/current/api/metadata_api/en-us/reference/webdataconnector.doc.html "WebDataConnector - A web data connector") - [WebDataConnectorsConnection_Connection Type for WebDataConnector_](https://help.tableau.com/current/api/metadata_api/en-us/reference/webdataconnectorsconnection.doc.html "WebDataConnectorsConnection - Connection Type for WebDataConnector") - [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/current/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).") - [WorkbooksConnection_Connection Type for Workbook_](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksconnection.doc.html "WorkbooksConnection - Connection Type for Workbook") # Introduction to Tableau Metadata API The Tableau Metadata API discovers and indexes all of the content on your Tableau Cloud site or Tableau Server, including workbooks, data sources, flows, and metrics. Indexing is used to gather information about Tableau content, or metadata, about the schema and lineage of the content. Then from the metadata, Metadata API identifies all of the databases, files, and tables used by the content on your Tableau Cloud site or Tableau Server. You can do the following tasks using the Metadata API: - **Discover data** that’s associated with the content published to your Tableau Cloud site or your Tableau Server. Search for external assets like tables, databases, and data sources. - **Track lineage** or the relationships between content and external assets, like data sources and workbooks. For example, identify which workbooks use a specific published data source. - **Perform impact analysis**. Using upstream and downstream lineage information, you can evaluate impact of changes to content. For example, find all worksheets that depend on a database table column or identify the authors you should notify when a data source change occurs. **In this section** ## What is Tableau metadata? The Metadata API discovers, tracks, stores, and then surfaces information about Tableau content. The content can be categorized by type (e.g., table or workbook). The content can be unique to Tableau (e.g., embedded data sources and calculated fields) and its external assets not unique to Tableau (e.g., database tables and columns). Both content and external assets can have information attached to them (e.g., tags and ratings). Both content and external assets can also have relationships to other content and external assets. The relationships among the content and external assets and the information about each is the metadata. ## Metadata API and GraphQL The Metadata API uses GraphQL, a query language for APIs that describes how to ask for and return only the data that you’re interested in. For general information about GraphQL and what you can do with it, see [GraphQL.org \[↗\]](https://graphql.org). ## When to use the Metadata API? The Metadata API is fast and flexible. Use the Metadata API when you are looking to find out specific information about the relationships between content and assets or their structures. ## When to use the Tableau REST API? With regard to metadata, you can use the Tableau REST API to make similar queries as with the Metadata API. However, if your Tableau Cloud site or Tableau Server is licensed with Data Management, you can use the REST API to perform various write operations, such as add, update, or remove external assets; and add additional metadata to the external assets like descriptions, certifications, and data quality warnings. For more information, see [Metadata Methods \[↗\]](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_metadata.htm) topic in the Tableau REST API. **Note:** You can always use the Tableau REST API for additional tasks like publishing workbooks or data sources, or for administrative tasks, such as creating groups and adding or removing users. ## Differences between using GraphQL and REST If you’re familiar with REST APIs then you understand the concepts of endpoints (or resources) and HTTP requests. For example, if you are using the Tableau REST API and you want to find all the workbooks on your Tableau Cloud site or Tableau Server, you can make a GET request to return that information. If you want to find out something else, you need to make another request to a different endpoint. Like REST APIs, GraphQL is also served over HTTP. However, instead of sending requests to multiple endpoints to return the data of interest, you can make one query to one endpoint and have that filtered to return only what you ask for. A GraphQL server is associated with one endpoint. GraphQL is based on the concept of a graph (queries) and the relationship between the types (objects) defined by the GraphQL schema. _menu_ Types INTERFACE # Label A label that can be attached to assets. _Available in Tableau Cloud March 2023 / Server 2023.1 and later._ ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - interface Label { - # Unique identifier used by the metadata API. Not the same as the numeric ID used - # on server - id: [ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html)! - # User who last updated this label - author: [TableauUser](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauuser.doc.html) - # Name of the user who last updated this label - authorDisplayName: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Vizportal ID of this label, for use in client-to-server communications - vizportalId: [String](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/string.doc.html)! - # True if the label is active - isActive: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html)! - # True if the label is elevated - isElevated: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html)! - # Value of the label - value: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)! - # Category of the label - category: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)! - # Message of the label - message: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Time the label was created - createdAt: [DateTime](https://help.tableau.com/current/api/metadata_api/en-us/reference/datetime.doc.html)! - # Time the label was last updated - updatedAt: [DateTime](https://help.tableau.com/current/api/metadata_api/en-us/reference/datetime.doc.html)! - # The asset that contains the label - asset: [CanHaveLabels](https://help.tableau.com/current/api/metadata_api/en-us/reference/canhavelabels.doc.html) - } ` ## [_link_](#require-by) Require by - [CanHaveLabels_A content item that can have labels. \*Available in Tableau Cloud March 2023 / Server 2023.1 and later.\*_](canhavelabels.doc.html "CanHaveLabels - A content item that can have labels. *Available in Tableau Cloud March 2023 / Server 2023.1 and later.*") - [CloudFile_A cloud file connection_](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/column.doc.html "Column - GraphQL type for a table column") - [Dashboard_A dashboard contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard.doc.html "Dashboard - A dashboard contained in a published workbook.") - [Database_A database containing tables_](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html "Database - A database containing tables") - [DatabaseServer_A database server connection_](https://help.tableau.com/current/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/current/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.*") - [DataQualityCertification_A data quality certification associated with a content item_](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitycertification.doc.html "DataQualityCertification - A data quality certification associated with a content item") - [DataQualityWarning_A data quality warning associated with a content item_](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarning.doc.html "DataQualityWarning - A data quality warning associated with a content item") - [EmbeddedDatasource_A data source embedded in a workbook_](https://help.tableau.com/current/api/metadata_api/en-us/reference/embeddeddatasource.doc.html "EmbeddedDatasource - A data source embedded in a workbook") - [File_A file connection_](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/flow.doc.html "Flow - Flows are used to prepare data, which can include aggregation, cleaning, preprocessing, etc.") - [GenericLabel_A label that can be attached to assets. \*Available in Tableau Cloud March 2023 / Server 2023.1 and later.\*_](genericlabel.doc.html "GenericLabel - A label that can be attached to assets. *Available in Tableau Cloud March 2023 / Server 2023.1 and later.*") - [LabelsConnection_Connection Type for Label_](https://help.tableau.com/current/api/metadata_api/en-us/reference/labelsconnection.doc.html "LabelsConnection - Connection Type for Label") - [Metric_Metrics are time series data constructed from fields contained in views. \*Retired in Tableau Cloud February 2024 / Server 2024.2.\*_](metric.doc.html "Metric - Metrics are time series data constructed from fields contained in views. *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/current/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.") - [Sheet_A sheet contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html "Sheet - A sheet contained in a published workbook.") - [TableauUser_User on a site on Tableau server_](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauuser.doc.html "TableauUser - User on a site on Tableau server") - [View_A view contained in a published workbook. Views can be sheets or dashboards._](https://help.tableau.com/current/api/metadata_api/en-us/reference/view.doc.html "View - A view contained in a published workbook. Views can be sheets or dashboards.") - [VirtualConnection_A virtual connection. \*Available in Tableau Cloud March 2022 / Server 2022.1 and later.\*_](virtualconnection.doc.html "VirtualConnection - A virtual connection. *Available in Tableau Cloud March 2022 / Server 2022.1 and later.*") - [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/current/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/current/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).") _menu_ Types INPUT\_OBJECT # Label\_Filter Filter by GraphQL field and given value ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input Label_Filter { - # True if the label is elevated - isElevated: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) - # True if the label is elevated - isElevatedWithin: [[Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html)] - # Locally unique identifier used for the REST API on the Tableau Server - luid: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Locally unique identifier used for the REST API on the Tableau Server - luidWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.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/current/api/metadata_api/en-us/reference/id.doc.html) - # Unique identifier used by the metadata API. Not the same as the numeric ID used - # on server - idWithin: [[ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html)] - # True if the label is active - isActive: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) - # True if the label is active - isActiveWithin: [[Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html)] - # Category of the label - category: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Category of the label - categoryWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)] - # Value of the label - value: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Value of the label - valueWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)] - } ` ## [_link_](#require-by) Require by - [CanHaveLabels_A content item that can have labels. \*Available in Tableau Cloud March 2023 / Server 2023.1 and later.\*_](canhavelabels.doc.html "CanHaveLabels - A content item that can have labels. *Available in Tableau Cloud March 2023 / Server 2023.1 and later.*") - [CloudFile_A cloud file connection_](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/column.doc.html "Column - GraphQL type for a table column") - [Dashboard_A dashboard contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard.doc.html "Dashboard - A dashboard contained in a published workbook.") - [Database_A database containing tables_](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html "Database - A database containing tables") - [DatabaseServer_A database server connection_](https://help.tableau.com/current/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/current/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.*") - [EmbeddedDatasource_A data source embedded in a workbook_](https://help.tableau.com/current/api/metadata_api/en-us/reference/embeddeddatasource.doc.html "EmbeddedDatasource - A data source embedded in a workbook") - [File_A file connection_](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/flow.doc.html "Flow - Flows are used to prepare data, which can include aggregation, cleaning, preprocessing, etc.") - [Metric_Metrics are time series data constructed from fields contained in views. \*Retired in Tableau Cloud February 2024 / Server 2024.2.\*_](metric.doc.html "Metric - Metrics are time series data constructed from fields contained in views. *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/current/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.") - [Sheet_A sheet contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html "Sheet - A sheet contained in a published workbook.") - [TableauUser_User on a site on Tableau server_](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauuser.doc.html "TableauUser - User on a site on Tableau server") - [View_A view contained in a published workbook. Views can be sheets or dashboards._](https://help.tableau.com/current/api/metadata_api/en-us/reference/view.doc.html "View - A view contained in a published workbook. Views can be sheets or dashboards.") - [VirtualConnection_A virtual connection. \*Available in Tableau Cloud March 2022 / Server 2022.1 and later.\*_](virtualconnection.doc.html "VirtualConnection - A virtual connection. *Available in Tableau Cloud March 2022 / Server 2022.1 and later.*") - [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/current/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/current/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).") _menu_ Types ENUM # LabelOrderField Enum for fields that can be used for sorting ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - enum LabelOrderField { - # Sort by category - CATEGORY - # Sort by id - ID - # Sort by isActive - IS_ACTIVE - # Sort by isElevated - IS_ELEVATED - # Sort by luid - LUID - # Sort by value - VALUE - } ` ## [_link_](#require-by) Require by - [LabelSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/labelsortorder.doc.html "LabelSortOrder - 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.") _menu_ Types OBJECT # LabelsConnection Connection Type for Label ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type LabelsConnection { - # List of nodes - nodes: [[Label](https://help.tableau.com/current/api/metadata_api/en-us/reference/label.doc.html)!]! - # Information for pagination - pageInfo: [PageInfo](https://help.tableau.com/current/api/metadata_api/en-us/reference/pageinfo.doc.html)! - # Total number of objects in connection - totalCount: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html)! - } ` ## [_link_](#require-by) Require by - [CanHaveLabels_A content item that can have labels. \*Available in Tableau Cloud March 2023 / Server 2023.1 and later.\*_](canhavelabels.doc.html "CanHaveLabels - A content item that can have labels. *Available in Tableau Cloud March 2023 / Server 2023.1 and later.*") - [CloudFile_A cloud file connection_](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/column.doc.html "Column - GraphQL type for a table column") - [Dashboard_A dashboard contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard.doc.html "Dashboard - A dashboard contained in a published workbook.") - [Database_A database containing tables_](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html "Database - A database containing tables") - [DatabaseServer_A database server connection_](https://help.tableau.com/current/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/current/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.*") - [EmbeddedDatasource_A data source embedded in a workbook_](https://help.tableau.com/current/api/metadata_api/en-us/reference/embeddeddatasource.doc.html "EmbeddedDatasource - A data source embedded in a workbook") - [File_A file connection_](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/flow.doc.html "Flow - Flows are used to prepare data, which can include aggregation, cleaning, preprocessing, etc.") - [Metric_Metrics are time series data constructed from fields contained in views. \*Retired in Tableau Cloud February 2024 / Server 2024.2.\*_](metric.doc.html "Metric - Metrics are time series data constructed from fields contained in views. *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/current/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.") - [Sheet_A sheet contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html "Sheet - A sheet contained in a published workbook.") - [TableauUser_User on a site on Tableau server_](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauuser.doc.html "TableauUser - User on a site on Tableau server") - [View_A view contained in a published workbook. Views can be sheets or dashboards._](https://help.tableau.com/current/api/metadata_api/en-us/reference/view.doc.html "View - A view contained in a published workbook. Views can be sheets or dashboards.") - [VirtualConnection_A virtual connection. \*Available in Tableau Cloud March 2022 / Server 2022.1 and later.\*_](virtualconnection.doc.html "VirtualConnection - A virtual connection. *Available in Tableau Cloud March 2022 / Server 2022.1 and later.*") - [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/current/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/current/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).") _menu_ Types INPUT\_OBJECT # LabelSortOrder 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. ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input LabelSortOrder { - # GraphQL field to sort on - field: [LabelOrderField](https://help.tableau.com/current/api/metadata_api/en-us/reference/labelorderfield.doc.html)! - # Order direction to sort output - direction: [OrderDirection](https://help.tableau.com/current/api/metadata_api/en-us/reference/orderdirection.doc.html)! - } ` ## [_link_](#require-by) Require by - [CanHaveLabels_A content item that can have labels. \*Available in Tableau Cloud March 2023 / Server 2023.1 and later.\*_](canhavelabels.doc.html "CanHaveLabels - A content item that can have labels. *Available in Tableau Cloud March 2023 / Server 2023.1 and later.*") - [CloudFile_A cloud file connection_](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/column.doc.html "Column - GraphQL type for a table column") - [Dashboard_A dashboard contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard.doc.html "Dashboard - A dashboard contained in a published workbook.") - [Database_A database containing tables_](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html "Database - A database containing tables") - [DatabaseServer_A database server connection_](https://help.tableau.com/current/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/current/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.*") - [EmbeddedDatasource_A data source embedded in a workbook_](https://help.tableau.com/current/api/metadata_api/en-us/reference/embeddeddatasource.doc.html "EmbeddedDatasource - A data source embedded in a workbook") - [File_A file connection_](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/flow.doc.html "Flow - Flows are used to prepare data, which can include aggregation, cleaning, preprocessing, etc.") - [Metric_Metrics are time series data constructed from fields contained in views. \*Retired in Tableau Cloud February 2024 / Server 2024.2.\*_](metric.doc.html "Metric - Metrics are time series data constructed from fields contained in views. *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/current/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.") - [Sheet_A sheet contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html "Sheet - A sheet contained in a published workbook.") - [TableauUser_User on a site on Tableau server_](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauuser.doc.html "TableauUser - User on a site on Tableau server") - [View_A view contained in a published workbook. Views can be sheets or dashboards._](https://help.tableau.com/current/api/metadata_api/en-us/reference/view.doc.html "View - A view contained in a published workbook. Views can be sheets or dashboards.") - [VirtualConnection_A virtual connection. \*Available in Tableau Cloud March 2022 / Server 2022.1 and later.\*_](virtualconnection.doc.html "VirtualConnection - A virtual connection. *Available in Tableau Cloud March 2022 / Server 2022.1 and later.*") - [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/current/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/current/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).") _menu_ Types OBJECT # 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._ ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type Lens { - # Unique identifier used by the metadata API. Not the same as the numeric ID used - # on server - id: [ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html)! - # Name shown in server - name: [String](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/string.doc.html)! - # The site in which the Lens is visible and usable - site: [TableauSite](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableausite.doc.html)! - # The list of fields - # - # 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. - fields( - filter: [LensField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensfield_filter.doc.html), - orderBy: [LensFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[LensField](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensfield.doc.html)!]! - # The list of fields - # - # 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. - fieldsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [LensField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensfield_filter.doc.html), - orderBy: [LensFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [LensFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensfieldsconnection.doc.html) - # The ID of the project in which the Lens is visible and usable. - projectVizportalUrlId: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)! - # VizPortal URL ID; used for URL generation - vizportalUrlId: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)! - # Datasource this lens is derived from - datasource: [Datasource](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasource.doc.html)! - # User who owns this Lens - owner: [TableauUser](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauuser.doc.html)! - # Description of the Lens - description: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Time the Lens was created - createdAt: [DateTime](https://help.tableau.com/current/api/metadata_api/en-us/reference/datetime.doc.html)! - # Time the Lens was last updated - updatedAt: [DateTime](https://help.tableau.com/current/api/metadata_api/en-us/reference/datetime.doc.html)! - # "Dashboards connected to the Lens" - # - # 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/current/api/metadata_api/en-us/reference/dashboard_filter.doc.html), - orderBy: [DashboardSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboardsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Dashboard](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard.doc.html)!]! - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Dashboard_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard_filter.doc.html), - orderBy: [DashboardSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboardsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DashboardsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboardsconnection.doc.html) - # "Workbooks connected to the Lens" - # - # 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/current/api/metadata_api/en-us/reference/workbook_filter.doc.html), - orderBy: [WorkbookSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Workbook](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbook.doc.html)!]! - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Workbook_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbook_filter.doc.html), - orderBy: [WorkbookSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [WorkbooksConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksconnection.doc.html) - # "Metrics connected to the Lens" - # - # 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/current/api/metadata_api/en-us/reference/metric_filter.doc.html), - orderBy: [MetricSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Metric](https://help.tableau.com/current/api/metadata_api/en-us/reference/metric.doc.html)!]! - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Metric_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metric_filter.doc.html), - orderBy: [MetricSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [MetricsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricsconnection.doc.html) - # Owners of contents connected to the Lens - # - # 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/current/api/metadata_api/en-us/reference/tableauuser_filter.doc.html), - orderBy: [TableauUserSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauusersortorder.doc.html) - ): [[TableauUser](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauuser.doc.html)!]! - # Owners of contents connected to the Lens - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [TableauUser_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauuser_filter.doc.html), - orderBy: [TableauUserSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauusersortorder.doc.html) - ): [TableauUsersConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauusersconnection.doc.html) - # Tables that are upstream of this Lens - # - # 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: [Table_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/table_filter.doc.html), - orderBy: [TableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Table](https://help.tableau.com/current/api/metadata_api/en-us/reference/table.doc.html)!]! - # Tables that are upstream of this Lens - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Table_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/table_filter.doc.html), - orderBy: [TableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [TablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/tablesconnection.doc.html) - # The lens configured in askData extension - # - # 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. - askDataExtensions( - filter: [AskDataExtension_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/askdataextension_filter.doc.html), - orderBy: [AskDataExtensionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/askdataextensionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[AskDataExtension](https://help.tableau.com/current/api/metadata_api/en-us/reference/askdataextension.doc.html)] - # The lens configured in askData extension - # - # 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. - askDataExtensionsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [AskDataExtension_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/askdataextension_filter.doc.html), - orderBy: [AskDataExtensionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/askdataextensionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [AskDataExtensionsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/askdataextensionsconnection.doc.html) - # The fields that are upstream of this lens - # - # 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. - upstreamFields( - filter: [Field_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/field_filter.doc.html), - orderBy: [FieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Field](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.doc.html)] - # The fields that are upstream of this lens - # - # 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. - upstreamFieldsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Field_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/field_filter.doc.html), - orderBy: [FieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsconnection.doc.html) - # The Databases that are upstream to this Lens - # - # 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/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Database](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html)] - # The Databases that are upstream to this Lens - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Database_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabasesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesconnection.doc.html) - # The datasource that are upstream of this lens - # - # 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/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[PublishedDatasource](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource.doc.html)] - # The datasource that are upstream of this lens - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [PublishedDatasource_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [PublishedDatasourcesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesconnection.doc.html) - # The flows that are upstream of this Lens - # - # 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/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Flow](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow.doc.html)] - # The flows that are upstream of this Lens - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Flow_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FlowsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsconnection.doc.html) - # The virtual connection upstream to this Lens - # - # 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. - upstreamVirtualConnections( - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection.doc.html)] - # The virtual connection upstream to this Lens - # - # 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. - upstreamVirtualConnectionsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsconnection.doc.html) - # The virtual connection table upstream to this Lens - # - # 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/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnectionTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable.doc.html)] - # The virtual connection table upstream to this Lens - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnectionTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesconnection.doc.html) - } ` ## [_link_](#require-by) Require by - [AskDataExtension_AskDataExtensions to base Tableau functionality._](https://help.tableau.com/current/api/metadata_api/en-us/reference/askdataextension.doc.html "AskDataExtension - AskDataExtensions to base Tableau functionality.") - [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/current/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/current/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/current/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/current/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/current/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/current/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/current/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/current/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.") - [Dashboard_A dashboard contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard.doc.html "Dashboard - A dashboard contained in a published workbook.") - [Database_A database containing tables_](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html "Database - A database containing tables") - [DatabaseServer_A database server connection_](https://help.tableau.com/current/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/current/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.*") - [Datasource_Root GraphQL type for embedded and published data sources Data sources are a way to represent how Tableau Desktop and Tableau Server model and connect to data. Data sources can be published separately, as a published data source, or may be contained in a workbook as an embedded data source. See https://onlinehelp.tableau.com/current/server/en-us/datasource.htm_](datasource.doc.html "Datasource - Root GraphQL type for embedded and published data sources Data sources are a way to represent how Tableau Desktop and Tableau Server model and connect to data. Data sources can be published separately, as a published data source, or may be contained in a workbook as an embedded data source. See https://onlinehelp.tableau.com/current/server/en-us/datasource.htm") - [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/current/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.") - [EmbeddedDatasource_A data source embedded in a workbook_](https://help.tableau.com/current/api/metadata_api/en-us/reference/embeddeddatasource.doc.html "EmbeddedDatasource - A data source embedded in a workbook") - [Field_Base GraphQL type for a field_](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [File_A file connection_](https://help.tableau.com/current/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/current/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/current/api/metadata_api/en-us/reference/flowcolumnoutputfield.doc.html "FlowColumnOutputField - Column output field implementation") - [FlowFieldOutputField_Field output field implementation_](https://help.tableau.com/current/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/current/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/current/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/current/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") - [LensesConnection_Connection Type for Lens_](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensesconnection.doc.html "LensesConnection - Connection Type for Lens") - [LensField_Lens Fields contain extra information based on an underlying datasource field_](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensfield.doc.html "LensField - Lens Fields contain extra information based on an underlying datasource field") - [Metric_Metrics are time series data constructed from fields contained in views. \*Retired in Tableau Cloud February 2024 / Server 2024.2.\*_](metric.doc.html "Metric - Metrics are time series data constructed from fields contained in views. *Retired in Tableau Cloud February 2024 / Server 2024.2.*") - [PublishedDatasource_A Tableau data source that has been published separately to Tableau Server. It can be used by multiple workbooks._](https://help.tableau.com/current/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/current/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/current/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/current/api/metadata_api/en-us/reference/table.doc.html "Table - A table containing columns") - [TableauSite_Site on Tableau server_](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/tableauuser.doc.html "TableauUser - User on a site on Tableau server") - [VirtualConnection_A virtual connection. \*Available in Tableau Cloud March 2022 / Server 2022.1 and later.\*_](virtualconnection.doc.html "VirtualConnection - A virtual connection. *Available in Tableau Cloud March 2022 / Server 2022.1 and later.*") - [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/current/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/current/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).") _menu_ Types INPUT\_OBJECT # Lens\_Filter Filter by GraphQL field and given value ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input Lens_Filter { - # VizPortal URL ID; used for URL generation - vizportalUrlId: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # VizPortal URL ID; used for URL generation - vizportalUrlIdWithin: [[String](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/string.doc.html) - # Locally unique identifier used for the REST API on the Tableau Server - luidWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)] - # Name shown in server - name: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Name shown in server - nameWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.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/current/api/metadata_api/en-us/reference/id.doc.html) - # Unique identifier used by the metadata API. Not the same as the numeric ID used - # on server - idWithin: [[ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.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/current/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/current/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/current/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/current/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/current/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/current/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/current/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/current/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.") - [Dashboard_A dashboard contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard.doc.html "Dashboard - A dashboard contained in a published workbook.") - [Database_A database containing tables_](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html "Database - A database containing tables") - [DatabaseServer_A database server connection_](https://help.tableau.com/current/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/current/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.*") - [Datasource_Root GraphQL type for embedded and published data sources Data sources are a way to represent how Tableau Desktop and Tableau Server model and connect to data. Data sources can be published separately, as a published data source, or may be contained in a workbook as an embedded data source. See https://onlinehelp.tableau.com/current/server/en-us/datasource.htm_](datasource.doc.html "Datasource - Root GraphQL type for embedded and published data sources Data sources are a way to represent how Tableau Desktop and Tableau Server model and connect to data. Data sources can be published separately, as a published data source, or may be contained in a workbook as an embedded data source. See https://onlinehelp.tableau.com/current/server/en-us/datasource.htm") - [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/current/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.") - [EmbeddedDatasource_A data source embedded in a workbook_](https://help.tableau.com/current/api/metadata_api/en-us/reference/embeddeddatasource.doc.html "EmbeddedDatasource - A data source embedded in a workbook") - [Field_Base GraphQL type for a field_](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [File_A file connection_](https://help.tableau.com/current/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/current/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/current/api/metadata_api/en-us/reference/flowcolumnoutputfield.doc.html "FlowColumnOutputField - Column output field implementation") - [FlowFieldOutputField_Field output field implementation_](https://help.tableau.com/current/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/current/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/current/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/current/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") - [Metric_Metrics are time series data constructed from fields contained in views. \*Retired in Tableau Cloud February 2024 / Server 2024.2.\*_](metric.doc.html "Metric - Metrics are time series data constructed from fields contained in views. *Retired in Tableau Cloud February 2024 / Server 2024.2.*") - [PublishedDatasource_A Tableau data source that has been published separately to Tableau Server. It can be used by multiple workbooks._](https://help.tableau.com/current/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/current/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/current/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/current/api/metadata_api/en-us/reference/table.doc.html "Table - A table containing columns") - [TableauSite_Site on Tableau server_](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/tableauuser.doc.html "TableauUser - User on a site on Tableau server") - [VirtualConnection_A virtual connection. \*Available in Tableau Cloud March 2022 / Server 2022.1 and later.\*_](virtualconnection.doc.html "VirtualConnection - A virtual connection. *Available in Tableau Cloud March 2022 / Server 2022.1 and later.*") - [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/current/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/current/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).") _menu_ Types OBJECT # LensesConnection Connection Type for Lens ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type LensesConnection { - # List of nodes - nodes: [[Lens](https://help.tableau.com/current/api/metadata_api/en-us/reference/lens.doc.html)!]! - # Information for pagination - pageInfo: [PageInfo](https://help.tableau.com/current/api/metadata_api/en-us/reference/pageinfo.doc.html)! - # Total number of objects in connection - totalCount: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.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/current/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/current/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/current/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/current/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/current/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/current/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/current/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/current/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.") - [Dashboard_A dashboard contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard.doc.html "Dashboard - A dashboard contained in a published workbook.") - [Database_A database containing tables_](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html "Database - A database containing tables") - [DatabaseServer_A database server connection_](https://help.tableau.com/current/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/current/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.*") - [Datasource_Root GraphQL type for embedded and published data sources Data sources are a way to represent how Tableau Desktop and Tableau Server model and connect to data. Data sources can be published separately, as a published data source, or may be contained in a workbook as an embedded data source. See https://onlinehelp.tableau.com/current/server/en-us/datasource.htm_](datasource.doc.html "Datasource - Root GraphQL type for embedded and published data sources Data sources are a way to represent how Tableau Desktop and Tableau Server model and connect to data. Data sources can be published separately, as a published data source, or may be contained in a workbook as an embedded data source. See https://onlinehelp.tableau.com/current/server/en-us/datasource.htm") - [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/current/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.") - [EmbeddedDatasource_A data source embedded in a workbook_](https://help.tableau.com/current/api/metadata_api/en-us/reference/embeddeddatasource.doc.html "EmbeddedDatasource - A data source embedded in a workbook") - [Field_Base GraphQL type for a field_](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [File_A file connection_](https://help.tableau.com/current/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/current/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/current/api/metadata_api/en-us/reference/flowcolumnoutputfield.doc.html "FlowColumnOutputField - Column output field implementation") - [FlowFieldOutputField_Field output field implementation_](https://help.tableau.com/current/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/current/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/current/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/current/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") - [Metric_Metrics are time series data constructed from fields contained in views. \*Retired in Tableau Cloud February 2024 / Server 2024.2.\*_](metric.doc.html "Metric - Metrics are time series data constructed from fields contained in views. *Retired in Tableau Cloud February 2024 / Server 2024.2.*") - [PublishedDatasource_A Tableau data source that has been published separately to Tableau Server. It can be used by multiple workbooks._](https://help.tableau.com/current/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/current/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/current/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/current/api/metadata_api/en-us/reference/table.doc.html "Table - A table containing columns") - [TableauSite_Site on Tableau server_](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/tableauuser.doc.html "TableauUser - User on a site on Tableau server") - [VirtualConnection_A virtual connection. \*Available in Tableau Cloud March 2022 / Server 2022.1 and later.\*_](virtualconnection.doc.html "VirtualConnection - A virtual connection. *Available in Tableau Cloud March 2022 / Server 2022.1 and later.*") - [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/current/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/current/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).") _menu_ Types OBJECT # LensField Lens Fields contain extra information based on an underlying datasource field ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type LensField { - # Unique identifier used by the metadata API. Not the same as the numeric ID used - # on server - id: [ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html)! - # Name of field shown locally in Ask Data. If null or empty, use name inherited - # from datasource field. - name: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Description of field shown in Ask Data. If null or empty, use description - # inherited from datasource field. - description: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Underlying datasource field this lens field is based on - datasourceField: [Field](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.doc.html)! - # The Lens which contains this lens field - containingLens: [Lens](https://help.tableau.com/current/api/metadata_api/en-us/reference/lens.doc.html) - } ` ## [_link_](#require-by) Require by - [AnalyticsField_Base GraphQL type for a field containing analytics metadata_](https://help.tableau.com/current/api/metadata_api/en-us/reference/analyticsfield.doc.html "AnalyticsField - Base GraphQL type for a field containing analytics metadata") - [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/current/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/current/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") - [ColumnField_ColumnFields are a type of field which directly connects to a column in some type of table._](https://help.tableau.com/current/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/current/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/current/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") - [DataField_Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField._](https://help.tableau.com/current/api/metadata_api/en-us/reference/datafield.doc.html "DataField - Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField.") - [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/current/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/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [FieldReferencingField_Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula._](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield.doc.html "FieldReferencingField - Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula.") - [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/current/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/current/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.*") - [LensFieldsConnection_Connection Type for LensField_](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensfieldsconnection.doc.html "LensFieldsConnection - Connection Type for LensField") - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/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/current/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") _menu_ Types INPUT\_OBJECT # LensField\_Filter Filter by GraphQL field and given value ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input LensField_Filter { - # Name of field shown locally in Ask Data. If null or empty, use name inherited - # from datasource field. - name: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Name of field shown locally in Ask Data. If null or empty, use name inherited - # from datasource field. - nameWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.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/current/api/metadata_api/en-us/reference/id.doc.html) - # Unique identifier used by the metadata API. Not the same as the numeric ID used - # on server - idWithin: [[ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html)] - } ` ## [_link_](#require-by) Require by - [AnalyticsField_Base GraphQL type for a field containing analytics metadata_](https://help.tableau.com/current/api/metadata_api/en-us/reference/analyticsfield.doc.html "AnalyticsField - Base GraphQL type for a field containing analytics metadata") - [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/current/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/current/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") - [ColumnField_ColumnFields are a type of field which directly connects to a column in some type of table._](https://help.tableau.com/current/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/current/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/current/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") - [DataField_Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField._](https://help.tableau.com/current/api/metadata_api/en-us/reference/datafield.doc.html "DataField - Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField.") - [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/current/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/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [FieldReferencingField_Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula._](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield.doc.html "FieldReferencingField - Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula.") - [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/current/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/current/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.*") - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/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/current/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") _menu_ Types INPUT\_OBJECT # LensField\_Required\_Filter Filter by GraphQL field and given value ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input LensField_Required_Filter { - # Unique identifier used by the metadata API. Not the same as the numeric ID used - # on server - id: [ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html) - # Unique identifier used by the metadata API. Not the same as the numeric ID used - # on server - idWithin: [[ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html)] - } ` ## [_link_](#require-by) Require by This element is not required by anyone _menu_ Types ENUM # LensFieldOrderField Enum for fields that can be used for sorting ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - enum LensFieldOrderField { - # Sort by id - ID - # Sort by name - NAME - } ` ## [_link_](#require-by) Require by - [LensFieldSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensfieldsortorder.doc.html "LensFieldSortOrder - 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.") _menu_ Types OBJECT # LensFieldsConnection Connection Type for LensField ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type LensFieldsConnection { - # List of nodes - nodes: [[LensField](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensfield.doc.html)!]! - # Information for pagination - pageInfo: [PageInfo](https://help.tableau.com/current/api/metadata_api/en-us/reference/pageinfo.doc.html)! - # Total number of objects in connection - totalCount: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html)! - } ` ## [_link_](#require-by) Require by - [AnalyticsField_Base GraphQL type for a field containing analytics metadata_](https://help.tableau.com/current/api/metadata_api/en-us/reference/analyticsfield.doc.html "AnalyticsField - Base GraphQL type for a field containing analytics metadata") - [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/current/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/current/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") - [ColumnField_ColumnFields are a type of field which directly connects to a column in some type of table._](https://help.tableau.com/current/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/current/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/current/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") - [DataField_Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField._](https://help.tableau.com/current/api/metadata_api/en-us/reference/datafield.doc.html "DataField - Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField.") - [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/current/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/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [FieldReferencingField_Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula._](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield.doc.html "FieldReferencingField - Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula.") - [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/current/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/current/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.*") - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/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/current/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") _menu_ Types INPUT\_OBJECT # LensFieldSortOrder 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. ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input LensFieldSortOrder { - # GraphQL field to sort on - field: [LensFieldOrderField](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensfieldorderfield.doc.html)! - # Order direction to sort output - direction: [OrderDirection](https://help.tableau.com/current/api/metadata_api/en-us/reference/orderdirection.doc.html)! - } ` ## [_link_](#require-by) Require by - [AnalyticsField_Base GraphQL type for a field containing analytics metadata_](https://help.tableau.com/current/api/metadata_api/en-us/reference/analyticsfield.doc.html "AnalyticsField - Base GraphQL type for a field containing analytics metadata") - [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/current/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/current/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") - [ColumnField_ColumnFields are a type of field which directly connects to a column in some type of table._](https://help.tableau.com/current/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/current/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/current/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") - [DataField_Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField._](https://help.tableau.com/current/api/metadata_api/en-us/reference/datafield.doc.html "DataField - Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField.") - [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/current/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/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [FieldReferencingField_Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula._](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield.doc.html "FieldReferencingField - Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula.") - [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/current/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/current/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.*") - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/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/current/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") _menu_ Types ENUM # LensOrderField Enum for fields that can be used for sorting ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - enum LensOrderField { - # Sort by fields count - FIELDS_COUNT - # Sort by owner count - OWNER_COUNT - # Sort by id - ID - # Sort by luid - LUID - # Sort by name - NAME - # Sort by vizportalUrlId - VIZPORTAL_URL_ID - } ` ## [_link_](#require-by) Require by - [LensSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/lenssortorder.doc.html "LensSortOrder - 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.") _menu_ Types INPUT\_OBJECT # LensSortOrder 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. ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input LensSortOrder { - # GraphQL field to sort on - field: [LensOrderField](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensorderfield.doc.html)! - # Order direction to sort output - direction: [OrderDirection](https://help.tableau.com/current/api/metadata_api/en-us/reference/orderdirection.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/current/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/current/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/current/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/current/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/current/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/current/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/current/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/current/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.") - [Dashboard_A dashboard contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard.doc.html "Dashboard - A dashboard contained in a published workbook.") - [Database_A database containing tables_](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html "Database - A database containing tables") - [DatabaseServer_A database server connection_](https://help.tableau.com/current/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/current/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.*") - [Datasource_Root GraphQL type for embedded and published data sources Data sources are a way to represent how Tableau Desktop and Tableau Server model and connect to data. Data sources can be published separately, as a published data source, or may be contained in a workbook as an embedded data source. See https://onlinehelp.tableau.com/current/server/en-us/datasource.htm_](datasource.doc.html "Datasource - Root GraphQL type for embedded and published data sources Data sources are a way to represent how Tableau Desktop and Tableau Server model and connect to data. Data sources can be published separately, as a published data source, or may be contained in a workbook as an embedded data source. See https://onlinehelp.tableau.com/current/server/en-us/datasource.htm") - [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/current/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.") - [EmbeddedDatasource_A data source embedded in a workbook_](https://help.tableau.com/current/api/metadata_api/en-us/reference/embeddeddatasource.doc.html "EmbeddedDatasource - A data source embedded in a workbook") - [Field_Base GraphQL type for a field_](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [File_A file connection_](https://help.tableau.com/current/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/current/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/current/api/metadata_api/en-us/reference/flowcolumnoutputfield.doc.html "FlowColumnOutputField - Column output field implementation") - [FlowFieldOutputField_Field output field implementation_](https://help.tableau.com/current/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/current/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/current/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/current/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") - [Metric_Metrics are time series data constructed from fields contained in views. \*Retired in Tableau Cloud February 2024 / Server 2024.2.\*_](metric.doc.html "Metric - Metrics are time series data constructed from fields contained in views. *Retired in Tableau Cloud February 2024 / Server 2024.2.*") - [PublishedDatasource_A Tableau data source that has been published separately to Tableau Server. It can be used by multiple workbooks._](https://help.tableau.com/current/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/current/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/current/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/current/api/metadata_api/en-us/reference/table.doc.html "Table - A table containing columns") - [TableauSite_Site on Tableau server_](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/tableauuser.doc.html "TableauUser - User on a site on Tableau server") - [VirtualConnection_A virtual connection. \*Available in Tableau Cloud March 2022 / Server 2022.1 and later.\*_](virtualconnection.doc.html "VirtualConnection - A virtual connection. *Available in Tableau Cloud March 2022 / Server 2022.1 and later.*") - [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/current/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/current/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).") _menu_ Types OBJECT # LinkedFlow Wrapper type including edge information ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type LinkedFlow { - # Unique identifier of the object in this linked flow - assetId: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)! - # Object in this linked flow - asset: [Flow](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow.doc.html)! - # The nodes following this node - toEdges: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)!] - # The nodes preceding this node - fromEdges: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)!] - } ` ## [_link_](#require-by) Require by - [Flow_Flows are used to prepare data, which can include aggregation, cleaning, preprocessing, etc._](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow.doc.html "Flow - Flows are used to prepare data, which can include aggregation, cleaning, preprocessing, etc.") - [LinkedFlowsConnection_Connection Type for LinkedFlow_](https://help.tableau.com/current/api/metadata_api/en-us/reference/linkedflowsconnection.doc.html "LinkedFlowsConnection - Connection Type for LinkedFlow") _menu_ Types INPUT\_OBJECT # LinkedFlow\_Filter Filter by GraphQL field and given value ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input LinkedFlow_Filter { - # Unique Identifier of object to retrieve - id: [ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html) - # Unique Identifier of object to retrieve - idWithin: [[ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html)] - } ` ## [_link_](#require-by) Require by - [Flow_Flows are used to prepare data, which can include aggregation, cleaning, preprocessing, etc._](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow.doc.html "Flow - Flows are used to prepare data, which can include aggregation, cleaning, preprocessing, etc.") _menu_ Types ENUM # LinkedFlowOrderField Enum for fields that can be used for sorting ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - enum LinkedFlowOrderField { - # Sort by id - ID - } ` ## [_link_](#require-by) Require by - [LinkedFlowSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/linkedflowsortorder.doc.html "LinkedFlowSortOrder - 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.") _menu_ Types OBJECT # LinkedFlowsConnection Connection Type for LinkedFlow ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type LinkedFlowsConnection { - # List of nodes - nodes: [[LinkedFlow](https://help.tableau.com/current/api/metadata_api/en-us/reference/linkedflow.doc.html)!]! - # Information for pagination - pageInfo: [PageInfo](https://help.tableau.com/current/api/metadata_api/en-us/reference/pageinfo.doc.html)! - # Total number of objects in connection - totalCount: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html)! - } ` ## [_link_](#require-by) Require by - [Flow_Flows are used to prepare data, which can include aggregation, cleaning, preprocessing, etc._](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow.doc.html "Flow - Flows are used to prepare data, which can include aggregation, cleaning, preprocessing, etc.") _menu_ Types INPUT\_OBJECT # LinkedFlowSortOrder 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. ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input LinkedFlowSortOrder { - # GraphQL field to sort on - field: [LinkedFlowOrderField](https://help.tableau.com/current/api/metadata_api/en-us/reference/linkedfloworderfield.doc.html)! - # Order direction to sort output - direction: [OrderDirection](https://help.tableau.com/current/api/metadata_api/en-us/reference/orderdirection.doc.html)! - } ` ## [_link_](#require-by) Require by - [Flow_Flows are used to prepare data, which can include aggregation, cleaning, preprocessing, etc._](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow.doc.html "Flow - Flows are used to prepare data, which can include aggregation, cleaning, preprocessing, etc.") _menu_ Types OBJECT # Metric Metrics are time series data constructed from fields contained in views. _Retired in Tableau Cloud February 2024 / Server 2024.2._ ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type Metric implements [Taggable](https://help.tableau.com/current/api/metadata_api/en-us/reference/taggable.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/current/api/metadata_api/en-us/reference/id.doc.html)! - # Name shown in server and desktop clients - name: [String](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/string.doc.html)! - # The site in which the Metric is visible and usable - site: [TableauSite](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableausite.doc.html)! - # The ID of the project in which the Metric is visible and usable. - projectVizportalUrlId: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)! - # VizPortal URL ID; used for URL generation - vizportalUrlId: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)! - # The name of the project in which the Metric is visible and usable. - projectName: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # The type of the container in which the metric is visible and usable. This is - # always a project. - containerType: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)! - # The name of the container in which the metric is visible and usable. This is - # always a project. - containerName: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # User who owns this Metric - owner: [TableauUser](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauuser.doc.html)! - # The original View off of which the Metric is based - underlyingView: [View](https://help.tableau.com/current/api/metadata_api/en-us/reference/view.doc.html) - # Description of the Metric - description: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Time the Metric was created - createdAt: [DateTime](https://help.tableau.com/current/api/metadata_api/en-us/reference/datetime.doc.html)! - # Time the Metric was last updated - updatedAt: [DateTime](https://help.tableau.com/current/api/metadata_api/en-us/reference/datetime.doc.html)! - # Tags associated with the Metric - # - # 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/current/api/metadata_api/en-us/reference/tag_filter.doc.html), orderBy: [TagSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tagsortorder.doc.html)): [[Tag](https://help.tableau.com/current/api/metadata_api/en-us/reference/tag.doc.html)!]! - # Tags associated with the Metric - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Tag_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/tag_filter.doc.html), - orderBy: [TagSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tagsortorder.doc.html) - ): [TagsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/tagsconnection.doc.html) - # Data quality warnings upstream from this Metric - # - # 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/current/api/metadata_api/en-us/reference/dataqualitywarning_filter.doc.html), - orderBy: [DataQualityWarningSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarningsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DataQualityWarning](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarning.doc.html)!]! - # Data quality warnings upstream from this Metric - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DataQualityWarning_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarning_filter.doc.html), - orderBy: [DataQualityWarningSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarningsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DataQualityWarningsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarningsconnection.doc.html) - # Labels upstream from this Metric. 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/current/api/metadata_api/en-us/reference/label_filter.doc.html), - orderBy: [LabelSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/labelsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Label](https://help.tableau.com/current/api/metadata_api/en-us/reference/label.doc.html)!]! - # Labels upstream from this Metric. 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Label_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/label_filter.doc.html), - orderBy: [LabelSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/labelsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [LabelsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/labelsconnection.doc.html) - # fields that are upstream of this metric - # - # 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. - upstreamFields( - filter: [Field_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/field_filter.doc.html), - orderBy: [FieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Field](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.doc.html)] - # fields that are upstream of this metric - # - # 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. - upstreamFieldsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Field_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/field_filter.doc.html), - orderBy: [FieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsconnection.doc.html) - # OutputFields that are upstream of this Metric - # - # 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. - upstreamFlowOutputFields( - filter: [FlowOutputField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowoutputfield_filter.doc.html), - orderBy: [FlowOutputFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowoutputfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[FlowOutputField](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowoutputfield.doc.html)] - # OutputFields that are upstream of this Metric - # - # 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. - upstreamFlowOutputFieldsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [FlowOutputField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowoutputfield_filter.doc.html), - orderBy: [FlowOutputFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowoutputfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FlowOutputFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowoutputfieldsconnection.doc.html) - # Databases that are upstream of this metric - # - # 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/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Database](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html)] - # Databases that are upstream of this metric - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Database_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabasesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesconnection.doc.html) - # The Published Datasources that are upstream to this Metric - # - # 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/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[PublishedDatasource](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource.doc.html)] - # The Published Datasources that are upstream to this Metric - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [PublishedDatasource_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [PublishedDatasourcesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesconnection.doc.html) - # Columns that are upstream of this metric - # - # 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. - upstreamColumns( - filter: [Column_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/column_filter.doc.html), - orderBy: [ColumnSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Column](https://help.tableau.com/current/api/metadata_api/en-us/reference/column.doc.html)] - # Columns that are upstream of this metric - # - # 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. - upstreamColumnsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Column_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/column_filter.doc.html), - orderBy: [ColumnSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [ColumnsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnsconnection.doc.html) - # Workbooks that are upstream of this metric - # - # 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. - upstreamWorkbooks( - filter: [Workbook_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbook_filter.doc.html), - orderBy: [WorkbookSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Workbook](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbook.doc.html)] - # Workbooks that are upstream of this metric - # - # 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. - upstreamWorkbooksConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Workbook_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbook_filter.doc.html), - orderBy: [WorkbookSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [WorkbooksConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksconnection.doc.html) - # The Lenses that are upstream of this workbook - # - # 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. - upstreamLenses( - filter: [Lens_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/lens_filter.doc.html), - orderBy: [LensSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/lenssortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Lens](https://help.tableau.com/current/api/metadata_api/en-us/reference/lens.doc.html)] - # The Lenses that are upstream of this workbook - # - # 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. - upstreamLensesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Lens_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/lens_filter.doc.html), - orderBy: [LensSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/lenssortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [LensesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensesconnection.doc.html) - # The flows that are upstream of this metric - # - # 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/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Flow](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow.doc.html)] - # The flows that are upstream of this metric - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Flow_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FlowsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsconnection.doc.html) - # OutputFields that are upstream of this Metric - # - # 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. - upstreamFlowColumnOutputFields( - filter: [FlowColumnOutputField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowcolumnoutputfield_filter.doc.html), - orderBy: [FlowColumnOutputFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowcolumnoutputfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[FlowColumnOutputField](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowcolumnoutputfield.doc.html)] - # OutputFields that are upstream of this Metric - # - # 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. - upstreamFlowColumnOutputFieldsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [FlowColumnOutputField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowcolumnoutputfield_filter.doc.html), - orderBy: [FlowColumnOutputFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowcolumnoutputfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FlowColumnOutputFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowcolumnoutputfieldsconnection.doc.html) - # OutputFields that are upstream of this Metric - # - # 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. - upstreamFlowFieldOutputFields( - filter: [FlowFieldOutputField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfield_filter.doc.html), - orderBy: [FlowFieldOutputFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[FlowFieldOutputField](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfield.doc.html)] - # OutputFields that are upstream of this Metric - # - # 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. - upstreamFlowFieldOutputFieldsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [FlowFieldOutputField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfield_filter.doc.html), - orderBy: [FlowFieldOutputFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FlowFieldOutputFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfieldsconnection.doc.html) - # tables that are upstream of this metric - # - # 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/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DatabaseTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable.doc.html)]! - # tables that are upstream of this metric - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabaseTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesconnection.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/current/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/current/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/current/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/current/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/current/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/current/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/current/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/current/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.") - [Dashboard_A dashboard contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard.doc.html "Dashboard - A dashboard contained in a published workbook.") - [Database_A database containing tables_](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html "Database - A database containing tables") - [DatabaseServer_A database server connection_](https://help.tableau.com/current/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/current/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/current/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/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [File_A file connection_](https://help.tableau.com/current/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/current/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/current/api/metadata_api/en-us/reference/flowcolumnoutputfield.doc.html "FlowColumnOutputField - Column output field implementation") - [FlowFieldOutputField_Field output field implementation_](https://help.tableau.com/current/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/current/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/current/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/current/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.*") - [MetricsConnection_Connection Type for Metric_](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricsconnection.doc.html "MetricsConnection - Connection Type for Metric") - [PublishedDatasource_A Tableau data source that has been published separately to Tableau Server. It can be used by multiple workbooks._](https://help.tableau.com/current/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/current/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/current/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") - [Sheet_A sheet contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html "Sheet - A sheet contained in a published workbook.") - [Table_A table containing columns_](https://help.tableau.com/current/api/metadata_api/en-us/reference/table.doc.html "Table - A table containing columns") - [TableauSite_Site on Tableau server_](https://help.tableau.com/current/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/current/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/current/api/metadata_api/en-us/reference/tag.doc.html "Tag - A tag associated with content items") - [View_A view contained in a published workbook. Views can be sheets or dashboards._](https://help.tableau.com/current/api/metadata_api/en-us/reference/view.doc.html "View - A view contained in a published workbook. Views can be sheets or dashboards.") - [VirtualConnection_A virtual connection. \*Available in Tableau Cloud March 2022 / Server 2022.1 and later.\*_](virtualconnection.doc.html "VirtualConnection - A virtual connection. *Available in Tableau Cloud March 2022 / Server 2022.1 and later.*") - [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/current/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/current/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).") _menu_ Types INPUT\_OBJECT # Metric\_Filter Filter by GraphQL field and given value ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input Metric_Filter { - # VizPortal URL ID; used for URL generation - vizportalUrlId: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # VizPortal URL ID; used for URL generation - vizportalUrlIdWithin: [[String](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/string.doc.html) - # Locally unique identifier used for the REST API on the Tableau Server - luidWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)] - # The name of the container in which the metric is visible and usable. This is - # always a project. - containerName: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # The name of the container in which the metric is visible and usable. This is - # always a project. - containerNameWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)] - # Name shown in server and desktop clients - name: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Name shown in server and desktop clients - nameWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.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/current/api/metadata_api/en-us/reference/id.doc.html) - # Unique identifier used by the metadata API. Not the same as the numeric ID used - # on server - idWithin: [[ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html)] - # The name of the project in which the Metric is visible and usable. - projectName: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # The name of the project in which the Metric is visible and usable. - projectNameWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.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/current/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/current/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/current/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/current/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/current/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/current/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/current/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/current/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.") - [Dashboard_A dashboard contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard.doc.html "Dashboard - A dashboard contained in a published workbook.") - [Database_A database containing tables_](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html "Database - A database containing tables") - [DatabaseServer_A database server connection_](https://help.tableau.com/current/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/current/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/current/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/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [File_A file connection_](https://help.tableau.com/current/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/current/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/current/api/metadata_api/en-us/reference/flowcolumnoutputfield.doc.html "FlowColumnOutputField - Column output field implementation") - [FlowFieldOutputField_Field output field implementation_](https://help.tableau.com/current/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/current/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/current/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/current/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.*") - [PublishedDatasource_A Tableau data source that has been published separately to Tableau Server. It can be used by multiple workbooks._](https://help.tableau.com/current/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/current/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/current/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") - [Sheet_A sheet contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html "Sheet - A sheet contained in a published workbook.") - [Table_A table containing columns_](https://help.tableau.com/current/api/metadata_api/en-us/reference/table.doc.html "Table - A table containing columns") - [TableauSite_Site on Tableau server_](https://help.tableau.com/current/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/current/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/current/api/metadata_api/en-us/reference/tag.doc.html "Tag - A tag associated with content items") - [View_A view contained in a published workbook. Views can be sheets or dashboards._](https://help.tableau.com/current/api/metadata_api/en-us/reference/view.doc.html "View - A view contained in a published workbook. Views can be sheets or dashboards.") - [VirtualConnection_A virtual connection. \*Available in Tableau Cloud March 2022 / Server 2022.1 and later.\*_](virtualconnection.doc.html "VirtualConnection - A virtual connection. *Available in Tableau Cloud March 2022 / Server 2022.1 and later.*") - [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/current/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/current/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).") _menu_ Types OBJECT # MetricDefinition A Tableau Pulse metric definition. _Available in Tableau Cloud June 2024 and later. Tableau Pulse is not available in Tableau Server._ ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type MetricDefinition { - # Unique identifier used by the Metadata API. Not the same as the locally unique - # identifier used with the REST API. - id: [ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html)! - # Name of the metric definition. - name: [String](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/string.doc.html)! - # The site which contains the metric definition. - site: [TableauSite](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableausite.doc.html)! - # Fields contained in the metric definition - # - # 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. - fields( - filter: [Field_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/field_filter.doc.html), - orderBy: [FieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Field](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.doc.html)!]! - # Fields contained in the metric definition - # - # 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. - fieldsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Field_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/field_filter.doc.html), - orderBy: [FieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsconnection.doc.html) - # Data sources upstream from the metric definition. - # - # 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/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[PublishedDatasource](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource.doc.html)!]! - # Data sources upstream from the metric definition. - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [PublishedDatasource_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [PublishedDatasourcesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesconnection.doc.html) - # Labels upstream from the metric definition. - # - # 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/current/api/metadata_api/en-us/reference/label_filter.doc.html), - orderBy: [LabelSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/labelsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Label](https://help.tableau.com/current/api/metadata_api/en-us/reference/label.doc.html)!]! - # Labels upstream from the metric definition. - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Label_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/label_filter.doc.html), - orderBy: [LabelSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/labelsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [LabelsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/labelsconnection.doc.html) - # Flows upstream from the metric definition. - # - # 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/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Flow](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow.doc.html)!]! - # Flows upstream from the metric definition. - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Flow_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FlowsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsconnection.doc.html) - # Databases upstream from the metric definition - # - # 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/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Database](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html)!]! - # Databases upstream from the metric definition - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Database_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabasesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesconnection.doc.html) - # Tables upstream from the metric definition. - # - # 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/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DatabaseTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable.doc.html)!]! - # Tables upstream from the metric definition. - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabaseTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesconnection.doc.html) - # Virtual connection tables upstream from the metric definition. - # - # 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/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnectionTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable.doc.html)!]! - # Virtual connection tables upstream from the metric definition. - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnectionTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesconnection.doc.html) - # Fields upstream from the metric definition. - # - # 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. - upstreamFields( - filter: [Field_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/field_filter.doc.html), - orderBy: [FieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Field](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.doc.html)!]! - # Fields upstream from the metric definition. - # - # 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. - upstreamFieldsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Field_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/field_filter.doc.html), - orderBy: [FieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsconnection.doc.html) - # Flow output fields upstream from the metric definition. - # - # 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. - upstreamFlowOutputFields( - filter: [FlowOutputField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowoutputfield_filter.doc.html), - orderBy: [FlowOutputFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowoutputfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[FlowOutputField](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowoutputfield.doc.html)!]! - # Flow output fields upstream from the metric definition. - # - # 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. - upstreamFlowOutputFieldsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [FlowOutputField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowoutputfield_filter.doc.html), - orderBy: [FlowOutputFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowoutputfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FlowOutputFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowoutputfieldsconnection.doc.html) - # Columns upstream from the metric definition. - # - # 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. - upstreamColumns( - filter: [Column_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/column_filter.doc.html), - orderBy: [ColumnSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Column](https://help.tableau.com/current/api/metadata_api/en-us/reference/column.doc.html)!]! - # Columns upstream from the metric definition. - # - # 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. - upstreamColumnsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Column_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/column_filter.doc.html), - orderBy: [ColumnSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [ColumnsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnsconnection.doc.html) - # Virtual connections upstream from the metric definition. - # - # 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. - upstreamVirtualConnections( - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection.doc.html)!]! - # Virtual connections upstream from the metric definition. - # - # 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. - upstreamVirtualConnectionsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsconnection.doc.html) - } ` ## [_link_](#require-by) Require by - [AnalyticsField_Base GraphQL type for a field containing analytics metadata_](https://help.tableau.com/current/api/metadata_api/en-us/reference/analyticsfield.doc.html "AnalyticsField - Base GraphQL type for a field containing analytics metadata") - [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/current/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/current/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/current/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/current/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/current/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/current/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/current/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") - [Database_A database containing tables_](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html "Database - A database containing tables") - [DatabaseServer_A database server connection_](https://help.tableau.com/current/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/current/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.*") - [DataField_Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField._](https://help.tableau.com/current/api/metadata_api/en-us/reference/datafield.doc.html "DataField - Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField.") - [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/current/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/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [FieldReferencingField_Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula._](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield.doc.html "FieldReferencingField - Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula.") - [File_A file connection_](https://help.tableau.com/current/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/current/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/current/api/metadata_api/en-us/reference/flowcolumnoutputfield.doc.html "FlowColumnOutputField - Column output field implementation") - [FlowFieldOutputField_Field output field implementation_](https://help.tableau.com/current/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/current/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/current/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/current/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") - [MetricDefinitionsConnection_Connection Type for MetricDefinition_](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsconnection.doc.html "MetricDefinitionsConnection - Connection Type for MetricDefinition") - [PublishedDatasource_A Tableau data source that has been published separately to Tableau Server. It can be used by multiple workbooks._](https://help.tableau.com/current/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/current/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/current/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") - [TableauSite_Site on Tableau server_](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableausite.doc.html "TableauSite - Site on Tableau server") - [VirtualConnection_A virtual connection. \*Available in Tableau Cloud March 2022 / Server 2022.1 and later.\*_](virtualconnection.doc.html "VirtualConnection - A virtual connection. *Available in Tableau Cloud March 2022 / Server 2022.1 and later.*") - [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/current/api/metadata_api/en-us/reference/webdataconnector.doc.html "WebDataConnector - A web data connector") _menu_ Types INPUT\_OBJECT # MetricDefinition\_Filter Filter by GraphQL field and given value ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input MetricDefinition_Filter { - # Locally unique identifier used for the REST API on the Tableau Server. - luid: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Locally unique identifier used for the REST API on the Tableau Server. - luidWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)] - # Name of the metric definition. - name: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Name of the metric definition. - nameWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)] - # Unique identifier used by the Metadata API. Not the same as the locally unique - # identifier used with the REST API. - id: [ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html) - # Unique identifier used by the Metadata API. Not the same as the locally unique - # identifier used with the REST API. - idWithin: [[ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html)] - } ` ## [_link_](#require-by) Require by - [AnalyticsField_Base GraphQL type for a field containing analytics metadata_](https://help.tableau.com/current/api/metadata_api/en-us/reference/analyticsfield.doc.html "AnalyticsField - Base GraphQL type for a field containing analytics metadata") - [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/current/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/current/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/current/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/current/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/current/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/current/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/current/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") - [Database_A database containing tables_](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html "Database - A database containing tables") - [DatabaseServer_A database server connection_](https://help.tableau.com/current/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/current/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.*") - [DataField_Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField._](https://help.tableau.com/current/api/metadata_api/en-us/reference/datafield.doc.html "DataField - Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField.") - [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/current/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/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [FieldReferencingField_Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula._](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield.doc.html "FieldReferencingField - Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula.") - [File_A file connection_](https://help.tableau.com/current/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/current/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/current/api/metadata_api/en-us/reference/flowcolumnoutputfield.doc.html "FlowColumnOutputField - Column output field implementation") - [FlowFieldOutputField_Field output field implementation_](https://help.tableau.com/current/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/current/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/current/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/current/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") - [PublishedDatasource_A Tableau data source that has been published separately to Tableau Server. It can be used by multiple workbooks._](https://help.tableau.com/current/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/current/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/current/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") - [TableauSite_Site on Tableau server_](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableausite.doc.html "TableauSite - Site on Tableau server") - [VirtualConnection_A virtual connection. \*Available in Tableau Cloud March 2022 / Server 2022.1 and later.\*_](virtualconnection.doc.html "VirtualConnection - A virtual connection. *Available in Tableau Cloud March 2022 / Server 2022.1 and later.*") - [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/current/api/metadata_api/en-us/reference/webdataconnector.doc.html "WebDataConnector - A web data connector") _menu_ Types ENUM # MetricDefinitionOrderField Enum for fields that can be used for sorting ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - enum MetricDefinitionOrderField { - # Sort by fields count - FIELDS_COUNT - # Sort by id - ID - # Sort by luid - LUID - # Sort by name - NAME - } ` ## [_link_](#require-by) Require by - [MetricDefinitionSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsortorder.doc.html "MetricDefinitionSortOrder - 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.") _menu_ Types OBJECT # MetricDefinitionsConnection Connection Type for MetricDefinition ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type MetricDefinitionsConnection { - # List of nodes - nodes: [[MetricDefinition](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinition.doc.html)!]! - # Information for pagination - pageInfo: [PageInfo](https://help.tableau.com/current/api/metadata_api/en-us/reference/pageinfo.doc.html)! - # Total number of objects in connection - totalCount: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html)! - } ` ## [_link_](#require-by) Require by - [AnalyticsField_Base GraphQL type for a field containing analytics metadata_](https://help.tableau.com/current/api/metadata_api/en-us/reference/analyticsfield.doc.html "AnalyticsField - Base GraphQL type for a field containing analytics metadata") - [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/current/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/current/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/current/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/current/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/current/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/current/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/current/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") - [Database_A database containing tables_](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html "Database - A database containing tables") - [DatabaseServer_A database server connection_](https://help.tableau.com/current/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/current/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.*") - [DataField_Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField._](https://help.tableau.com/current/api/metadata_api/en-us/reference/datafield.doc.html "DataField - Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField.") - [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/current/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/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [FieldReferencingField_Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula._](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield.doc.html "FieldReferencingField - Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula.") - [File_A file connection_](https://help.tableau.com/current/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/current/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/current/api/metadata_api/en-us/reference/flowcolumnoutputfield.doc.html "FlowColumnOutputField - Column output field implementation") - [FlowFieldOutputField_Field output field implementation_](https://help.tableau.com/current/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/current/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/current/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/current/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") - [PublishedDatasource_A Tableau data source that has been published separately to Tableau Server. It can be used by multiple workbooks._](https://help.tableau.com/current/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/current/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/current/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") - [TableauSite_Site on Tableau server_](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableausite.doc.html "TableauSite - Site on Tableau server") - [VirtualConnection_A virtual connection. \*Available in Tableau Cloud March 2022 / Server 2022.1 and later.\*_](virtualconnection.doc.html "VirtualConnection - A virtual connection. *Available in Tableau Cloud March 2022 / Server 2022.1 and later.*") - [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/current/api/metadata_api/en-us/reference/webdataconnector.doc.html "WebDataConnector - A web data connector") _menu_ Types INPUT\_OBJECT # MetricDefinitionSortOrder 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. ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input MetricDefinitionSortOrder { - # GraphQL field to sort on - field: [MetricDefinitionOrderField](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionorderfield.doc.html)! - # Order direction to sort output - direction: [OrderDirection](https://help.tableau.com/current/api/metadata_api/en-us/reference/orderdirection.doc.html)! - } ` ## [_link_](#require-by) Require by - [AnalyticsField_Base GraphQL type for a field containing analytics metadata_](https://help.tableau.com/current/api/metadata_api/en-us/reference/analyticsfield.doc.html "AnalyticsField - Base GraphQL type for a field containing analytics metadata") - [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/current/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/current/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/current/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/current/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/current/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/current/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/current/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") - [Database_A database containing tables_](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html "Database - A database containing tables") - [DatabaseServer_A database server connection_](https://help.tableau.com/current/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/current/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.*") - [DataField_Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField._](https://help.tableau.com/current/api/metadata_api/en-us/reference/datafield.doc.html "DataField - Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField.") - [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/current/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/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [FieldReferencingField_Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula._](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield.doc.html "FieldReferencingField - Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula.") - [File_A file connection_](https://help.tableau.com/current/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/current/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/current/api/metadata_api/en-us/reference/flowcolumnoutputfield.doc.html "FlowColumnOutputField - Column output field implementation") - [FlowFieldOutputField_Field output field implementation_](https://help.tableau.com/current/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/current/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/current/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/current/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") - [PublishedDatasource_A Tableau data source that has been published separately to Tableau Server. It can be used by multiple workbooks._](https://help.tableau.com/current/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/current/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/current/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") - [TableauSite_Site on Tableau server_](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableausite.doc.html "TableauSite - Site on Tableau server") - [VirtualConnection_A virtual connection. \*Available in Tableau Cloud March 2022 / Server 2022.1 and later.\*_](virtualconnection.doc.html "VirtualConnection - A virtual connection. *Available in Tableau Cloud March 2022 / Server 2022.1 and later.*") - [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/current/api/metadata_api/en-us/reference/webdataconnector.doc.html "WebDataConnector - A web data connector") _menu_ Types ENUM # MetricOrderField Enum for fields that can be used for sorting ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - enum MetricOrderField { - # Sort by owner count - OWNER_COUNT - # Sort by containerName - CONTAINER_NAME - # Sort by id - ID - # Sort by luid - LUID - # Sort by name - NAME - # Sort by projectName - PROJECT_NAME - # Sort by vizportalUrlId - VIZPORTAL_URL_ID - } ` ## [_link_](#require-by) Require by - [MetricSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricsortorder.doc.html "MetricSortOrder - 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.") _menu_ Types OBJECT # MetricsConnection Connection Type for Metric ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type MetricsConnection { - # List of nodes - nodes: [[Metric](https://help.tableau.com/current/api/metadata_api/en-us/reference/metric.doc.html)!]! - # Information for pagination - pageInfo: [PageInfo](https://help.tableau.com/current/api/metadata_api/en-us/reference/pageinfo.doc.html)! - # Total number of objects in connection - totalCount: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.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/current/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/current/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/current/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/current/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/current/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/current/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/current/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/current/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.") - [Dashboard_A dashboard contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard.doc.html "Dashboard - A dashboard contained in a published workbook.") - [Database_A database containing tables_](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html "Database - A database containing tables") - [DatabaseServer_A database server connection_](https://help.tableau.com/current/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/current/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/current/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/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [File_A file connection_](https://help.tableau.com/current/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/current/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/current/api/metadata_api/en-us/reference/flowcolumnoutputfield.doc.html "FlowColumnOutputField - Column output field implementation") - [FlowFieldOutputField_Field output field implementation_](https://help.tableau.com/current/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/current/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/current/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/current/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.*") - [PublishedDatasource_A Tableau data source that has been published separately to Tableau Server. It can be used by multiple workbooks._](https://help.tableau.com/current/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/current/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/current/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") - [Sheet_A sheet contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html "Sheet - A sheet contained in a published workbook.") - [Table_A table containing columns_](https://help.tableau.com/current/api/metadata_api/en-us/reference/table.doc.html "Table - A table containing columns") - [TableauSite_Site on Tableau server_](https://help.tableau.com/current/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/current/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/current/api/metadata_api/en-us/reference/tag.doc.html "Tag - A tag associated with content items") - [View_A view contained in a published workbook. Views can be sheets or dashboards._](https://help.tableau.com/current/api/metadata_api/en-us/reference/view.doc.html "View - A view contained in a published workbook. Views can be sheets or dashboards.") - [VirtualConnection_A virtual connection. \*Available in Tableau Cloud March 2022 / Server 2022.1 and later.\*_](virtualconnection.doc.html "VirtualConnection - A virtual connection. *Available in Tableau Cloud March 2022 / Server 2022.1 and later.*") - [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/current/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/current/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).") _menu_ Types INPUT\_OBJECT # MetricSortOrder 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. ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input MetricSortOrder { - # GraphQL field to sort on - field: [MetricOrderField](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricorderfield.doc.html)! - # Order direction to sort output - direction: [OrderDirection](https://help.tableau.com/current/api/metadata_api/en-us/reference/orderdirection.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/current/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/current/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/current/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/current/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/current/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/current/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/current/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/current/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.") - [Dashboard_A dashboard contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard.doc.html "Dashboard - A dashboard contained in a published workbook.") - [Database_A database containing tables_](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html "Database - A database containing tables") - [DatabaseServer_A database server connection_](https://help.tableau.com/current/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/current/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/current/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/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [File_A file connection_](https://help.tableau.com/current/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/current/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/current/api/metadata_api/en-us/reference/flowcolumnoutputfield.doc.html "FlowColumnOutputField - Column output field implementation") - [FlowFieldOutputField_Field output field implementation_](https://help.tableau.com/current/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/current/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/current/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/current/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.*") - [PublishedDatasource_A Tableau data source that has been published separately to Tableau Server. It can be used by multiple workbooks._](https://help.tableau.com/current/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/current/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/current/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") - [Sheet_A sheet contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html "Sheet - A sheet contained in a published workbook.") - [Table_A table containing columns_](https://help.tableau.com/current/api/metadata_api/en-us/reference/table.doc.html "Table - A table containing columns") - [TableauSite_Site on Tableau server_](https://help.tableau.com/current/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/current/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/current/api/metadata_api/en-us/reference/tag.doc.html "Tag - A tag associated with content items") - [View_A view contained in a published workbook. Views can be sheets or dashboards._](https://help.tableau.com/current/api/metadata_api/en-us/reference/view.doc.html "View - A view contained in a published workbook. Views can be sheets or dashboards.") - [VirtualConnection_A virtual connection. \*Available in Tableau Cloud March 2022 / Server 2022.1 and later.\*_](virtualconnection.doc.html "VirtualConnection - A virtual connection. *Available in Tableau Cloud March 2022 / Server 2022.1 and later.*") - [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/current/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/current/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).") _menu_ Types INTERFACE # Node Inheritance target ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - interface Node { - # Unique identifier used by the metadata API. Not the same as the numeric ID used - # on server - id: [ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.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/current/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/current/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") - [Column_GraphQL type for a table column_](https://help.tableau.com/current/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/current/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/current/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/current/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") - [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/current/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.") - [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/current/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/current/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") - [InheritedStringResult_Wrapper type containing the inherited result_](https://help.tableau.com/current/api/metadata_api/en-us/reference/inheritedstringresult.doc.html "InheritedStringResult - Wrapper type containing the inherited result") - [NodesConnection_Connection Type for Node_](https://help.tableau.com/current/api/metadata_api/en-us/reference/nodesconnection.doc.html "NodesConnection - Connection Type for Node") - [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/current/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") _menu_ Types INPUT\_OBJECT # Node\_Filter Filter by GraphQL field and given value ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input Node_Filter { - # Unique identifier used by the metadata API. Not the same as the numeric ID used - # on server - id: [ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html) - # Unique identifier used by the metadata API. Not the same as the numeric ID used - # on server - idWithin: [[ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html)] - } ` ## [_link_](#require-by) Require by This element is not required by anyone _menu_ Types ENUM # NodeOrderField Enum for fields that can be used for sorting ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - enum NodeOrderField { - # Sort by id - ID - } ` ## [_link_](#require-by) Require by - [NodeSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/nodesortorder.doc.html "NodeSortOrder - 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.") _menu_ Types OBJECT # NodesConnection Connection Type for Node ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type NodesConnection { - # List of nodes - nodes: [[Node](https://help.tableau.com/current/api/metadata_api/en-us/reference/node.doc.html)!]! - # Information for pagination - pageInfo: [PageInfo](https://help.tableau.com/current/api/metadata_api/en-us/reference/pageinfo.doc.html)! - # Total number of objects in connection - totalCount: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html)! - } ` ## [_link_](#require-by) Require by This element is not required by anyone _menu_ Types INPUT\_OBJECT # NodeSortOrder 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. ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input NodeSortOrder { - # GraphQL field to sort on - field: [NodeOrderField](https://help.tableau.com/current/api/metadata_api/en-us/reference/nodeorderfield.doc.html)! - # Order direction to sort output - direction: [OrderDirection](https://help.tableau.com/current/api/metadata_api/en-us/reference/orderdirection.doc.html)! - } ` ## [_link_](#require-by) Require by This element is not required by anyone _menu_ Types ENUM # OrderDirection General object for sorting ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - enum OrderDirection { - # Sort in an ascending order. - ASC - # Sort in a descending order. - DESC - } ` ## [_link_](#require-by) Require by - [AnalyticsFieldSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/analyticsfieldsortorder.doc.html "AnalyticsFieldSortOrder - 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.") - [AskDataExtensionSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/askdataextensionsortorder.doc.html "AskDataExtensionSortOrder - 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.") - [BinFieldSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/binfieldsortorder.doc.html "BinFieldSortOrder - 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.") - [CalculatedFieldSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/calculatedfieldsortorder.doc.html "CalculatedFieldSortOrder - 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.") - [CanHaveLabelsSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/canhavelabelssortorder.doc.html "CanHaveLabelsSortOrder - 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.") - [CertifiableSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/certifiablesortorder.doc.html "CertifiableSortOrder - 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.") - [CloudFileSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/cloudfilesortorder.doc.html "CloudFileSortOrder - 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.") - [ColumnFieldSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnfieldsortorder.doc.html "ColumnFieldSortOrder - 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.") - [ColumnSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnsortorder.doc.html "ColumnSortOrder - 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.") - [CombinedFieldSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedfieldsortorder.doc.html "CombinedFieldSortOrder - 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.") - [CombinedSetFieldSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedsetfieldsortorder.doc.html "CombinedSetFieldSortOrder - 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.") - [CustomSQLTableSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/customsqltablesortorder.doc.html "CustomSQLTableSortOrder - 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.") - [DashboardSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboardsortorder.doc.html "DashboardSortOrder - 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.") - [DatabaseServerSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/databaseserversortorder.doc.html "DatabaseServerSortOrder - 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.") - [DatabaseSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html "DatabaseSortOrder - 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.") - [DatabaseTableSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html "DatabaseTableSortOrder - 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.") - [DataCloudSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/datacloudsortorder.doc.html "DataCloudSortOrder - 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.") - [DataFieldSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/datafieldsortorder.doc.html "DataFieldSortOrder - 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.") - [DataQualityCertificationSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitycertificationsortorder.doc.html "DataQualityCertificationSortOrder - 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.") - [DataQualityWarningSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarningsortorder.doc.html "DataQualityWarningSortOrder - 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.") - [DatasourceFieldSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefieldsortorder.doc.html "DatasourceFieldSortOrder - 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.") - [DatasourceFilterSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefiltersortorder.doc.html "DatasourceFilterSortOrder - 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.") - [DatasourceSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcesortorder.doc.html "DatasourceSortOrder - 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.") - [EmbeddedDatasourceSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/embeddeddatasourcesortorder.doc.html "EmbeddedDatasourceSortOrder - 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.") - [FieldReferencingFieldSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfieldsortorder.doc.html "FieldReferencingFieldSortOrder - 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.") - [FieldSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsortorder.doc.html "FieldSortOrder - 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.") - [FileSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/filesortorder.doc.html "FileSortOrder - 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.") - [FlowColumnInputFieldSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowcolumninputfieldsortorder.doc.html "FlowColumnInputFieldSortOrder - 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.") - [FlowColumnOutputFieldSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowcolumnoutputfieldsortorder.doc.html "FlowColumnOutputFieldSortOrder - 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.") - [FlowFieldInputFieldSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfieldsortorder.doc.html "FlowFieldInputFieldSortOrder - 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.") - [FlowFieldOutputFieldSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfieldsortorder.doc.html "FlowFieldOutputFieldSortOrder - 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.") - [FlowInputFieldSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowinputfieldsortorder.doc.html "FlowInputFieldSortOrder - 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.") - [FlowOutputFieldSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowoutputfieldsortorder.doc.html "FlowOutputFieldSortOrder - 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.") - [FlowOutputStepSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowoutputstepsortorder.doc.html "FlowOutputStepSortOrder - 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.") - [FlowSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html "FlowSortOrder - 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.") - [GenericLabelSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/genericlabelsortorder.doc.html "GenericLabelSortOrder - 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.") - [GroupFieldSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/groupfieldsortorder.doc.html "GroupFieldSortOrder - 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.") - [HierarchyFieldSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/hierarchyfieldsortorder.doc.html "HierarchyFieldSortOrder - 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.") - [LabelSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/labelsortorder.doc.html "LabelSortOrder - 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.") - [LensFieldSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensfieldsortorder.doc.html "LensFieldSortOrder - 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.") - [LensSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/lenssortorder.doc.html "LensSortOrder - 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.") - [LinkedFlowSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/linkedflowsortorder.doc.html "LinkedFlowSortOrder - 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.") - [MetricDefinitionSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsortorder.doc.html "MetricDefinitionSortOrder - 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.") - [MetricSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricsortorder.doc.html "MetricSortOrder - 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.") - [NodeSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/nodesortorder.doc.html "NodeSortOrder - 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.") - [ParameterSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/parametersortorder.doc.html "ParameterSortOrder - 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.") - [PublishedDatasourceSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html "PublishedDatasourceSortOrder - 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.") - [SetFieldSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/setfieldsortorder.doc.html "SetFieldSortOrder - 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.") - [SheetSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html "SheetSortOrder - 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.") - [TableAdditionalDetailsSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableadditionaldetailssortorder.doc.html "TableAdditionalDetailsSortOrder - 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.") - [TableauSiteSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableausitesortorder.doc.html "TableauSiteSortOrder - 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.") - [TableauUserSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauusersortorder.doc.html "TableauUserSortOrder - 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.") - [TableSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/tablesortorder.doc.html "TableSortOrder - 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.") - [TaggableSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/taggablesortorder.doc.html "TaggableSortOrder - 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.") - [TagSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/tagsortorder.doc.html "TagSortOrder - 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.") - [ViewSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/viewsortorder.doc.html "ViewSortOrder - 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.") - [VirtualConnectionSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html "VirtualConnectionSortOrder - 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.") - [VirtualConnectionTableSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html "VirtualConnectionTableSortOrder - 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.") - [WarnableSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/warnablesortorder.doc.html "WarnableSortOrder - 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.") - [WebDataConnectorSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/webdataconnectorsortorder.doc.html "WebDataConnectorSortOrder - 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.") - [WorkbookSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksortorder.doc.html "WorkbookSortOrder - 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.") _menu_ Types OBJECT # PageInfo Information about pagination in a connection ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type PageInfo { - # Indicates if there are more objects to fetch - hasNextPage: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html)! - # Cursor to use in subsequent query to fetch next page of objects - endCursor: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - } ` ## [_link_](#require-by) Require by - [AnalyticsFieldsConnection_Connection Type for AnalyticsField_](https://help.tableau.com/current/api/metadata_api/en-us/reference/analyticsfieldsconnection.doc.html "AnalyticsFieldsConnection - Connection Type for AnalyticsField") - [AskDataExtensionsConnection_Connection Type for AskDataExtension_](https://help.tableau.com/current/api/metadata_api/en-us/reference/askdataextensionsconnection.doc.html "AskDataExtensionsConnection - Connection Type for AskDataExtension") - [BinFieldsConnection_Connection Type for BinField_](https://help.tableau.com/current/api/metadata_api/en-us/reference/binfieldsconnection.doc.html "BinFieldsConnection - Connection Type for BinField") - [CalculatedFieldsConnection_Connection Type for CalculatedField_](https://help.tableau.com/current/api/metadata_api/en-us/reference/calculatedfieldsconnection.doc.html "CalculatedFieldsConnection - Connection Type for CalculatedField") - [CanHaveLabelsesConnection_Connection Type for CanHaveLabels_](https://help.tableau.com/current/api/metadata_api/en-us/reference/canhavelabelsesconnection.doc.html "CanHaveLabelsesConnection - Connection Type for CanHaveLabels") - [CertifiablesConnection_Connection Type for Certifiable_](https://help.tableau.com/current/api/metadata_api/en-us/reference/certifiablesconnection.doc.html "CertifiablesConnection - Connection Type for Certifiable") - [CloudFilesConnection_Connection Type for CloudFile_](https://help.tableau.com/current/api/metadata_api/en-us/reference/cloudfilesconnection.doc.html "CloudFilesConnection - Connection Type for CloudFile") - [ColumnFieldsConnection_Connection Type for ColumnField_](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnfieldsconnection.doc.html "ColumnFieldsConnection - Connection Type for ColumnField") - [ColumnsConnection_Connection Type for Column_](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnsconnection.doc.html "ColumnsConnection - Connection Type for Column") - [CombinedFieldsConnection_Connection Type for CombinedField_](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedfieldsconnection.doc.html "CombinedFieldsConnection - Connection Type for CombinedField") - [CombinedSetFieldsConnection_Connection Type for CombinedSetField_](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedsetfieldsconnection.doc.html "CombinedSetFieldsConnection - Connection Type for CombinedSetField") - [CustomSQLTablesConnection_Connection Type for CustomSQLTable_](https://help.tableau.com/current/api/metadata_api/en-us/reference/customsqltablesconnection.doc.html "CustomSQLTablesConnection - Connection Type for CustomSQLTable") - [DashboardsConnection_Connection Type for Dashboard_](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboardsconnection.doc.html "DashboardsConnection - Connection Type for Dashboard") - [DatabasesConnection_Connection Type for Database_](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesconnection.doc.html "DatabasesConnection - Connection Type for Database") - [DatabaseServersConnection_Connection Type for DatabaseServer_](https://help.tableau.com/current/api/metadata_api/en-us/reference/databaseserversconnection.doc.html "DatabaseServersConnection - Connection Type for DatabaseServer") - [DatabaseTablesConnection_Connection Type for DatabaseTable_](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesconnection.doc.html "DatabaseTablesConnection - Connection Type for DatabaseTable") - [DataCloudsConnection_Connection Type for DataCloud_](https://help.tableau.com/current/api/metadata_api/en-us/reference/datacloudsconnection.doc.html "DataCloudsConnection - Connection Type for DataCloud") - [DataFieldsConnection_Connection Type for DataField_](https://help.tableau.com/current/api/metadata_api/en-us/reference/datafieldsconnection.doc.html "DataFieldsConnection - Connection Type for DataField") - [DataQualityCertificationsConnection_Connection Type for DataQualityCertification_](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitycertificationsconnection.doc.html "DataQualityCertificationsConnection - Connection Type for DataQualityCertification") - [DataQualityWarningsConnection_Connection Type for DataQualityWarning_](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarningsconnection.doc.html "DataQualityWarningsConnection - Connection Type for DataQualityWarning") - [DatasourceFieldsConnection_Connection Type for DatasourceField_](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefieldsconnection.doc.html "DatasourceFieldsConnection - Connection Type for DatasourceField") - [DatasourceFiltersConnection_Connection Type for DatasourceFilter_](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefiltersconnection.doc.html "DatasourceFiltersConnection - Connection Type for DatasourceFilter") - [DatasourcesConnection_Connection Type for Datasource_](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcesconnection.doc.html "DatasourcesConnection - Connection Type for Datasource") - [EmbeddedDatasourcesConnection_Connection Type for EmbeddedDatasource_](https://help.tableau.com/current/api/metadata_api/en-us/reference/embeddeddatasourcesconnection.doc.html "EmbeddedDatasourcesConnection - Connection Type for EmbeddedDatasource") - [FieldReferencingFieldsConnection_Connection Type for FieldReferencingField_](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfieldsconnection.doc.html "FieldReferencingFieldsConnection - Connection Type for FieldReferencingField") - [FieldsConnection_Connection Type for Field_](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsconnection.doc.html "FieldsConnection - Connection Type for Field") - [FilesConnection_Connection Type for File_](https://help.tableau.com/current/api/metadata_api/en-us/reference/filesconnection.doc.html "FilesConnection - Connection Type for File") - [FlowColumnInputFieldsConnection_Connection Type for FlowColumnInputField_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowcolumninputfieldsconnection.doc.html "FlowColumnInputFieldsConnection - Connection Type for FlowColumnInputField") - [FlowColumnOutputFieldsConnection_Connection Type for FlowColumnOutputField_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowcolumnoutputfieldsconnection.doc.html "FlowColumnOutputFieldsConnection - Connection Type for FlowColumnOutputField") - [FlowFieldInputFieldsConnection_Connection Type for FlowFieldInputField_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfieldsconnection.doc.html "FlowFieldInputFieldsConnection - Connection Type for FlowFieldInputField") - [FlowFieldOutputFieldsConnection_Connection Type for FlowFieldOutputField_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfieldsconnection.doc.html "FlowFieldOutputFieldsConnection - Connection Type for FlowFieldOutputField") - [FlowInputFieldsConnection_Connection Type for FlowInputField_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowinputfieldsconnection.doc.html "FlowInputFieldsConnection - Connection Type for FlowInputField") - [FlowOutputFieldsConnection_Connection Type for FlowOutputField_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowoutputfieldsconnection.doc.html "FlowOutputFieldsConnection - Connection Type for FlowOutputField") - [FlowOutputStepsConnection_Connection Type for FlowOutputStep_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowoutputstepsconnection.doc.html "FlowOutputStepsConnection - Connection Type for FlowOutputStep") - [FlowsConnection_Connection Type for Flow_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsconnection.doc.html "FlowsConnection - Connection Type for Flow") - [GenericLabelsConnection_Connection Type for GenericLabel_](https://help.tableau.com/current/api/metadata_api/en-us/reference/genericlabelsconnection.doc.html "GenericLabelsConnection - Connection Type for GenericLabel") - [GroupFieldsConnection_Connection Type for GroupField_](https://help.tableau.com/current/api/metadata_api/en-us/reference/groupfieldsconnection.doc.html "GroupFieldsConnection - Connection Type for GroupField") - [HierarchyFieldsConnection_Connection Type for HierarchyField_](https://help.tableau.com/current/api/metadata_api/en-us/reference/hierarchyfieldsconnection.doc.html "HierarchyFieldsConnection - Connection Type for HierarchyField") - [LabelsConnection_Connection Type for Label_](https://help.tableau.com/current/api/metadata_api/en-us/reference/labelsconnection.doc.html "LabelsConnection - Connection Type for Label") - [LensesConnection_Connection Type for Lens_](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensesconnection.doc.html "LensesConnection - Connection Type for Lens") - [LensFieldsConnection_Connection Type for LensField_](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensfieldsconnection.doc.html "LensFieldsConnection - Connection Type for LensField") - [LinkedFlowsConnection_Connection Type for LinkedFlow_](https://help.tableau.com/current/api/metadata_api/en-us/reference/linkedflowsconnection.doc.html "LinkedFlowsConnection - Connection Type for LinkedFlow") - [MetricDefinitionsConnection_Connection Type for MetricDefinition_](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsconnection.doc.html "MetricDefinitionsConnection - Connection Type for MetricDefinition") - [MetricsConnection_Connection Type for Metric_](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricsconnection.doc.html "MetricsConnection - Connection Type for Metric") - [NodesConnection_Connection Type for Node_](https://help.tableau.com/current/api/metadata_api/en-us/reference/nodesconnection.doc.html "NodesConnection - Connection Type for Node") - [ParametersConnection_Connection Type for Parameter_](https://help.tableau.com/current/api/metadata_api/en-us/reference/parametersconnection.doc.html "ParametersConnection - Connection Type for Parameter") - [PublishedDatasourcesConnection_Connection Type for PublishedDatasource_](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesconnection.doc.html "PublishedDatasourcesConnection - Connection Type for PublishedDatasource") - [SetFieldsConnection_Connection Type for SetField_](https://help.tableau.com/current/api/metadata_api/en-us/reference/setfieldsconnection.doc.html "SetFieldsConnection - Connection Type for SetField") - [SheetsConnection_Connection Type for Sheet_](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsconnection.doc.html "SheetsConnection - Connection Type for Sheet") - [TableAdditionalDetailsesConnection_Connection Type for TableAdditionalDetails_](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableadditionaldetailsesconnection.doc.html "TableAdditionalDetailsesConnection - Connection Type for TableAdditionalDetails") - [TableauSitesConnection_Connection Type for TableauSite_](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableausitesconnection.doc.html "TableauSitesConnection - Connection Type for TableauSite") - [TableauUsersConnection_Connection Type for TableauUser_](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauusersconnection.doc.html "TableauUsersConnection - Connection Type for TableauUser") - [TablesConnection_Connection Type for Table_](https://help.tableau.com/current/api/metadata_api/en-us/reference/tablesconnection.doc.html "TablesConnection - Connection Type for Table") - [TaggablesConnection_Connection Type for Taggable_](https://help.tableau.com/current/api/metadata_api/en-us/reference/taggablesconnection.doc.html "TaggablesConnection - Connection Type for Taggable") - [TagsConnection_Connection Type for Tag_](https://help.tableau.com/current/api/metadata_api/en-us/reference/tagsconnection.doc.html "TagsConnection - Connection Type for Tag") - [ViewsConnection_Connection Type for View_](https://help.tableau.com/current/api/metadata_api/en-us/reference/viewsconnection.doc.html "ViewsConnection - Connection Type for View") - [VirtualConnectionsConnection_Connection Type for VirtualConnection_](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsconnection.doc.html "VirtualConnectionsConnection - Connection Type for VirtualConnection") - [VirtualConnectionTablesConnection_Connection Type for VirtualConnectionTable_](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesconnection.doc.html "VirtualConnectionTablesConnection - Connection Type for VirtualConnectionTable") - [WarnablesConnection_Connection Type for Warnable_](https://help.tableau.com/current/api/metadata_api/en-us/reference/warnablesconnection.doc.html "WarnablesConnection - Connection Type for Warnable") - [WebDataConnectorsConnection_Connection Type for WebDataConnector_](https://help.tableau.com/current/api/metadata_api/en-us/reference/webdataconnectorsconnection.doc.html "WebDataConnectorsConnection - Connection Type for WebDataConnector") - [WorkbooksConnection_Connection Type for Workbook_](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksconnection.doc.html "WorkbooksConnection - Connection Type for Workbook") _menu_ Types OBJECT # Parameter Tableau Parameter. For more info see [https://onlinehelp.tableau.com/current/pro/desktop/en-us/parameters\_create.html](https://onlinehelp.tableau.com/current/pro/desktop/en-us/parameters_create.html) ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type Parameter { - # Unique identifier used by the metadata API. Not the same as the numeric ID used - # on server - id: [ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html)! - # Name of parameter - name: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Name of the parameter's parent - parentName: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Published data source that contains this parameter - datasource: [PublishedDatasource](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource.doc.html) - # The bin field that references this parameter - # - # 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. - referencedByBins( - filter: [BinField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/binfield_filter.doc.html), - orderBy: [BinFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/binfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[BinField](https://help.tableau.com/current/api/metadata_api/en-us/reference/binfield.doc.html)] - # The bin field that references this parameter - # - # 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. - referencedByBinsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [BinField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/binfield_filter.doc.html), - orderBy: [BinFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/binfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [BinFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/binfieldsconnection.doc.html) - # The calculated field that references this parameter - # - # 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. - referencedByCalculations( - filter: [CalculatedField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/calculatedfield_filter.doc.html), - orderBy: [CalculatedFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/calculatedfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[CalculatedField](https://help.tableau.com/current/api/metadata_api/en-us/reference/calculatedfield.doc.html)] - # The calculated field that references this parameter - # - # 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. - referencedByCalculationsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [CalculatedField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/calculatedfield_filter.doc.html), - orderBy: [CalculatedFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/calculatedfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [CalculatedFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/calculatedfieldsconnection.doc.html) - # The set field that this parameter references - # - # 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. - referencedBySets( - filter: [SetField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/setfield_filter.doc.html), - orderBy: [SetFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/setfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[SetField](https://help.tableau.com/current/api/metadata_api/en-us/reference/setfield.doc.html)] - # The set field that this parameter references - # - # 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. - referencedBySetsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [SetField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/setfield_filter.doc.html), - orderBy: [SetFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/setfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [SetFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/setfieldsconnection.doc.html) - # Workbook that contains this parameter - workbook: [Workbook](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbook.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/current/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/current/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") - [ParametersConnection_Connection Type for Parameter_](https://help.tableau.com/current/api/metadata_api/en-us/reference/parametersconnection.doc.html "ParametersConnection - Connection Type for Parameter") - [PublishedDatasource_A Tableau data source that has been published separately to Tableau Server. It can be used by multiple workbooks._](https://help.tableau.com/current/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/current/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/current/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") - [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/current/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).") _menu_ Types INPUT\_OBJECT # Parameter\_Filter Filter by GraphQL field and given value ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input Parameter_Filter { - # Name of the parameter's parent - parentName: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Name of the parameter's parent - parentNameWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)] - # Name of parameter - name: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Name of parameter - nameWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.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/current/api/metadata_api/en-us/reference/id.doc.html) - # Unique identifier used by the metadata API. Not the same as the numeric ID used - # on server - idWithin: [[ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.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/current/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/current/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") - [PublishedDatasource_A Tableau data source that has been published separately to Tableau Server. It can be used by multiple workbooks._](https://help.tableau.com/current/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/current/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/current/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") - [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/current/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).") _menu_ Types ENUM # ParameterOrderField Enum for fields that can be used for sorting ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - enum ParameterOrderField { - # Sort by id - ID - # Sort by name - NAME - # Sort by parentName - PARENT_NAME - } ` ## [_link_](#require-by) Require by - [ParameterSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/parametersortorder.doc.html "ParameterSortOrder - 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.") _menu_ Types OBJECT # ParametersConnection Connection Type for Parameter ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type ParametersConnection { - # List of nodes - nodes: [[Parameter](https://help.tableau.com/current/api/metadata_api/en-us/reference/parameter.doc.html)!]! - # Information for pagination - pageInfo: [PageInfo](https://help.tableau.com/current/api/metadata_api/en-us/reference/pageinfo.doc.html)! - # Total number of objects in connection - totalCount: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.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/current/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/current/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") - [PublishedDatasource_A Tableau data source that has been published separately to Tableau Server. It can be used by multiple workbooks._](https://help.tableau.com/current/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/current/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/current/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") - [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/current/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).") _menu_ Types INPUT\_OBJECT # ParameterSortOrder 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. ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input ParameterSortOrder { - # GraphQL field to sort on - field: [ParameterOrderField](https://help.tableau.com/current/api/metadata_api/en-us/reference/parameterorderfield.doc.html)! - # Order direction to sort output - direction: [OrderDirection](https://help.tableau.com/current/api/metadata_api/en-us/reference/orderdirection.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/current/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/current/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") - [PublishedDatasource_A Tableau data source that has been published separately to Tableau Server. It can be used by multiple workbooks._](https://help.tableau.com/current/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/current/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/current/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") - [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/current/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).") _menu_ Types ENUM # PermissionMode Enum of the different ways to apply permissions. ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - enum PermissionMode { - # Include results that user is not authorized to view with sensitive information - # obfuscated. - OBFUSCATE_RESULTS - # Filter out results user is not authorized on. - FILTER_RESULTS - } ` ## [_link_](#require-by) Require by - [AnalyticsField_Base GraphQL type for a field containing analytics metadata_](https://help.tableau.com/current/api/metadata_api/en-us/reference/analyticsfield.doc.html "AnalyticsField - Base GraphQL type for a field containing analytics metadata") - [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/current/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/current/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") - [CanHaveLabels_A content item that can have labels. \*Available in Tableau Cloud March 2023 / Server 2023.1 and later.\*_](canhavelabels.doc.html "CanHaveLabels - A content item that can have labels. *Available in Tableau Cloud March 2023 / Server 2023.1 and later.*") - [Certifiable_A content item that can be certified_](https://help.tableau.com/current/api/metadata_api/en-us/reference/certifiable.doc.html "Certifiable - A content item that can be certified") - [CloudFile_A cloud file connection_](https://help.tableau.com/current/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/current/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/current/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/current/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/current/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/current/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.") - [Dashboard_A dashboard contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard.doc.html "Dashboard - A dashboard contained in a published workbook.") - [Database_A database containing tables_](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html "Database - A database containing tables") - [DatabaseServer_A database server connection_](https://help.tableau.com/current/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/current/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.*") - [DataField_Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField._](https://help.tableau.com/current/api/metadata_api/en-us/reference/datafield.doc.html "DataField - Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField.") - [Datasource_Root GraphQL type for embedded and published data sources Data sources are a way to represent how Tableau Desktop and Tableau Server model and connect to data. Data sources can be published separately, as a published data source, or may be contained in a workbook as an embedded data source. See https://onlinehelp.tableau.com/current/server/en-us/datasource.htm_](datasource.doc.html "Datasource - Root GraphQL type for embedded and published data sources Data sources are a way to represent how Tableau Desktop and Tableau Server model and connect to data. Data sources can be published separately, as a published data source, or may be contained in a workbook as an embedded data source. See https://onlinehelp.tableau.com/current/server/en-us/datasource.htm") - [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/current/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.") - [EmbeddedDatasource_A data source embedded in a workbook_](https://help.tableau.com/current/api/metadata_api/en-us/reference/embeddeddatasource.doc.html "EmbeddedDatasource - A data source embedded in a workbook") - [Field_Base GraphQL type for a field_](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [FieldReferencingField_Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula._](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield.doc.html "FieldReferencingField - Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula.") - [File_A file connection_](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/flow.doc.html "Flow - Flows are used to prepare data, which can include aggregation, cleaning, preprocessing, etc.") - [FlowColumnInputField_Column input field implementation_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowcolumninputfield.doc.html "FlowColumnInputField - Column input field implementation") - [FlowColumnOutputField_Column output field implementation_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowcolumnoutputfield.doc.html "FlowColumnOutputField - Column output field implementation") - [FlowFieldInputField_Field input field implementation_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfield.doc.html "FlowFieldInputField - Field input field implementation") - [FlowFieldOutputField_Field output field implementation_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfield.doc.html "FlowFieldOutputField - Field output field implementation") - [FlowInputField_A wrapper for an input field contained in a published flow._](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowinputfield.doc.html "FlowInputField - A wrapper for an input field contained in a published flow.") - [FlowOutputField_A wrapper for an output field contained in a published flow._](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowoutputfield.doc.html "FlowOutputField - A wrapper for an output field contained in a published flow.") - [FlowOutputStep_A flow output step_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowoutputstep.doc.html "FlowOutputStep - A flow output step") - [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/current/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/current/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.*") - [Metric_Metrics are time series data constructed from fields contained in views. \*Retired in Tableau Cloud February 2024 / Server 2024.2.\*_](metric.doc.html "Metric - Metrics are time series data constructed from fields contained in views. *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.*") - [Parameter_Tableau Parameter. For more info see https://onlinehelp.tableau.com/current/pro/desktop/en-us/parameters\_create.html_](https://help.tableau.com/current/api/metadata_api/en-us/reference/parameter.doc.html "Parameter - Tableau Parameter. For more info see https://onlinehelp.tableau.com/current/pro/desktop/en-us/parameters_create.html") - [PublishedDatasource_A Tableau data source that has been published separately to Tableau Server. It can be used by multiple workbooks._](https://help.tableau.com/current/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/current/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/current/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") - [Sheet_A sheet contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html "Sheet - A sheet contained in a published workbook.") - [Table_A table containing columns_](https://help.tableau.com/current/api/metadata_api/en-us/reference/table.doc.html "Table - A table containing columns") - [TableAdditionalDetails_Additional details for the DatabaseTable type \*Available in Tableau Cloud February 2024 / Server 2024.2 and later.\*_](tableadditionaldetails.doc.html "TableAdditionalDetails - Additional details for the DatabaseTable type *Available in Tableau Cloud February 2024 / Server 2024.2 and later.*") - [TableauSite_Site on Tableau server_](https://help.tableau.com/current/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/current/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/current/api/metadata_api/en-us/reference/tag.doc.html "Tag - A tag associated with content items") - [View_A view contained in a published workbook. Views can be sheets or dashboards._](https://help.tableau.com/current/api/metadata_api/en-us/reference/view.doc.html "View - A view contained in a published workbook. Views can be sheets or dashboards.") - [VirtualConnection_A virtual connection. \*Available in Tableau Cloud March 2022 / Server 2022.1 and later.\*_](virtualconnection.doc.html "VirtualConnection - A virtual connection. *Available in Tableau Cloud March 2022 / Server 2022.1 and later.*") - [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.*") - [Warnable_A content item that can have data quality warnings_](https://help.tableau.com/current/api/metadata_api/en-us/reference/warnable.doc.html "Warnable - A content item that can have data quality warnings") - [WebDataConnector_A web data connector_](https://help.tableau.com/current/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/current/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).") _menu_ Types OBJECT # PublishedDatasource A Tableau data source that has been published separately to Tableau Server. It can be used by multiple workbooks. ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type PublishedDatasource implements [Datasource](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasource.doc.html), [Warnable](https://help.tableau.com/current/api/metadata_api/en-us/reference/warnable.doc.html), [Certifiable](https://help.tableau.com/current/api/metadata_api/en-us/reference/certifiable.doc.html), [CanHaveLabels](https://help.tableau.com/current/api/metadata_api/en-us/reference/canhavelabels.doc.html), [Taggable](https://help.tableau.com/current/api/metadata_api/en-us/reference/taggable.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/current/api/metadata_api/en-us/reference/id.doc.html)! - # Name shown in server and desktop clients - name: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # True if data source contains a formula that involves a user function (for - # example, USERNAME or ISMEMBEROF) - hasUserReference: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) - # True if datasource contains extracted data - hasExtracts: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) - # True if the datasource contains unsupported custom SQL, in which case lineage - # may be incomplete - containsUnsupportedCustomSql: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) - # Time an extract was last fully refreshed - extractLastRefreshTime: [DateTime](https://help.tableau.com/current/api/metadata_api/en-us/reference/datetime.doc.html) - # Time an extract was last incrementally updated - extractLastIncrementalUpdateTime: [DateTime](https://help.tableau.com/current/api/metadata_api/en-us/reference/datetime.doc.html) - # Time an extract was last updated by either a full refresh, incremental update, - # or creation - extractLastUpdateTime: [DateTime](https://help.tableau.com/current/api/metadata_api/en-us/reference/datetime.doc.html) - # Locally unique identifier used for the REST API on the Tableau Server - luid: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)! - # Fields usable in workbooks connected to this data source - # - # 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. - fields( - filter: [Field_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/field_filter.doc.html), - orderBy: [FieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Field](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.doc.html)!]! - # Fields usable in workbooks connected to this data source - # - # 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. - fieldsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Field_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/field_filter.doc.html), - orderBy: [FieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsconnection.doc.html) - # Data source filters contained in this data source - # - # 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. - datasourceFilters( - filter: [DatasourceFilter_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefilter_filter.doc.html), - orderBy: [DatasourceFilterSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefiltersortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DatasourceFilter](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefilter.doc.html)!]! - # Data source filters contained in this data source - # - # 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. - datasourceFiltersConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DatasourceFilter_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefilter_filter.doc.html), - orderBy: [DatasourceFilterSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefiltersortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatasourceFiltersConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefiltersconnection.doc.html) - # List of parameters, if any, used in this data source - # - # 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. - parameters( - filter: [Parameter_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/parameter_filter.doc.html), - orderBy: [ParameterSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/parametersortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Parameter](https://help.tableau.com/current/api/metadata_api/en-us/reference/parameter.doc.html)!]! - # List of parameters, if any, used in this data source - # - # 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. - parametersConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Parameter_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/parameter_filter.doc.html), - orderBy: [ParameterSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/parametersortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [ParametersConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/parametersconnection.doc.html) - # The site which contains this published data source - site: [TableauSite](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableausite.doc.html)! - # The ID of the project in which the published data source is visible and usable. - # Will return null if the published data source is not in a project. - projectVizportalUrlId: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # The name of the project that contains this published data source. - projectName: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # The type of the container in which the published data source is visible and - # usable. Either personal space or project. - containerType: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)! - # The name of the container in which the published data source is visible and - # usable. Either a personal space or project. - containerName: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # User who owns this data source - owner: [TableauUser](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauuser.doc.html)! - # True if this data source contains an active data quality certification - isCertified: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html)! - # User who marked this data source as certified - certifier: [TableauUser](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauuser.doc.html) @deprecated( reason: "No longer supported. Use 'dataQualityCertifications'" ) - # Notes related to the data source being marked as certified - certificationNote: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) @deprecated( reason: "No longer supported. Use 'dataQualityCertifications'" ) - # Name of the user who marked this data source as certified - certifierDisplayName: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) @deprecated( reason: "No longer supported. Use 'dataQualityCertifications'" ) - # Description of the datasource - description: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # True if the data source has an active data quality warning - hasActiveWarning: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html)! - # The optional data quality warning on a published datasource - dataQualityWarning: [DataQualityWarning](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarning.doc.html) @deprecated( reason: "Use 'dataQualityWarnings'" ) - # The data quality warnings on a published datasource - # - # 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/current/api/metadata_api/en-us/reference/dataqualitywarning_filter.doc.html), - orderBy: [DataQualityWarningSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarningsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DataQualityWarning](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarning.doc.html)!]! - # The data quality warnings on a published datasource - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DataQualityWarning_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarning_filter.doc.html), - orderBy: [DataQualityWarningSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarningsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DataQualityWarningsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarningsconnection.doc.html) - # The data quality certifications on a published datasource - # - # 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/current/api/metadata_api/en-us/reference/dataqualitycertification_filter.doc.html), - orderBy: [DataQualityCertificationSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitycertificationsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DataQualityCertification](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitycertification.doc.html)!]! - # The data quality certifications on a published datasource - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DataQualityCertification_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitycertification_filter.doc.html), - orderBy: [DataQualityCertificationSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitycertificationsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DataQualityCertificationsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitycertificationsconnection.doc.html) - # The labels on a published datasource. 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/current/api/metadata_api/en-us/reference/label_filter.doc.html), - orderBy: [LabelSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/labelsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Label](https://help.tableau.com/current/api/metadata_api/en-us/reference/label.doc.html)!]! - # The labels on a published datasource. 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Label_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/label_filter.doc.html), - orderBy: [LabelSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/labelsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [LabelsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/labelsconnection.doc.html) - # Tags associated with the published datasource - # - # 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/current/api/metadata_api/en-us/reference/tag_filter.doc.html), orderBy: [TagSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tagsortorder.doc.html)): [[Tag](https://help.tableau.com/current/api/metadata_api/en-us/reference/tag.doc.html)!]! - # Tags associated with the published datasource - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Tag_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/tag_filter.doc.html), - orderBy: [TagSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tagsortorder.doc.html) - ): [TagsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/tagsconnection.doc.html) - # Uri of the datasource - uri: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Vizportal ID of this published datasource, for use in client-to-server - # communications - vizportalId: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)! - # VizPortal URL ID; used for URL generation - vizportalUrlId: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)! - # Databases upstream from this data source - # - # 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/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Database](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html)!]! - # Databases upstream from this data source - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Database_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabasesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesconnection.doc.html) - # Tables upstream from this data source - # - # 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/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DatabaseTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable.doc.html)!]! - # Tables upstream from this data source - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabaseTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesconnection.doc.html) - # Flows upstream from this data source - # - # 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/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Flow](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow.doc.html)!]! - # Flows upstream from this data source - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Flow_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FlowsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsconnection.doc.html) - # Datasources upstream from this data source - # - # 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/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[PublishedDatasource](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource.doc.html)!]! - # Datasources upstream from this data source - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [PublishedDatasource_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [PublishedDatasourcesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesconnection.doc.html) - # Data quality warnings upstream from this data source - # - # 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/current/api/metadata_api/en-us/reference/dataqualitywarning_filter.doc.html), - orderBy: [DataQualityWarningSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarningsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DataQualityWarning](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarning.doc.html)!]! - # Data quality warnings upstream from this data source - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DataQualityWarning_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarning_filter.doc.html), - orderBy: [DataQualityWarningSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarningsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DataQualityWarningsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarningsconnection.doc.html) - # Labels upstream from this data source. 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/current/api/metadata_api/en-us/reference/label_filter.doc.html), - orderBy: [LabelSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/labelsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Label](https://help.tableau.com/current/api/metadata_api/en-us/reference/label.doc.html)!]! - # Labels upstream from this data source. 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Label_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/label_filter.doc.html), - orderBy: [LabelSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/labelsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [LabelsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/labelsconnection.doc.html) - # Tables downstream from this data source - # - # 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. - downstreamTables( - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DatabaseTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable.doc.html)!]! - # Tables downstream from this data source - # - # 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. - downstreamTablesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabaseTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesconnection.doc.html) - # Databases downstream from this data source - # - # 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. - downstreamDatabases( - filter: [Database_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Database](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html)!]! - # Databases downstream from this data source - # - # 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. - downstreamDatabasesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Database_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabasesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesconnection.doc.html) - # Virtual connection tables downstream of this data source - # - # 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/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnectionTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable.doc.html)!]! - # Virtual connection tables downstream of this data source - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnectionTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesconnection.doc.html) - # Virtual connections downstream from this data source - # - # 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. - downstreamVirtualConnections( - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection.doc.html)!]! - # Virtual connections downstream from this data source - # - # 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. - downstreamVirtualConnectionsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsconnection.doc.html) - # Flows downstream from this data source - # - # 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/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Flow](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow.doc.html)!]! - # Flows downstream from this data source - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Flow_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FlowsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsconnection.doc.html) - # Datasources downstream from this data source - # - # 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/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[PublishedDatasource](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource.doc.html)!]! - # Datasources downstream from this data source - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [PublishedDatasource_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [PublishedDatasourcesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesconnection.doc.html) - # Lenses connected downstream from this field - # - # 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/current/api/metadata_api/en-us/reference/lens_filter.doc.html), - orderBy: [LensSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/lenssortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Lens](https://help.tableau.com/current/api/metadata_api/en-us/reference/lens.doc.html)!] - # Lenses connected downstream from this field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Lens_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/lens_filter.doc.html), - orderBy: [LensSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/lenssortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [LensesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensesconnection.doc.html) - # Sheets downstream from this data source - # - # 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/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Sheet](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html)!]! - # Sheets downstream from this data source - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Sheet_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [SheetsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsconnection.doc.html) - # Dashboards connected downstream from the field - # - # 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/current/api/metadata_api/en-us/reference/dashboard_filter.doc.html), - orderBy: [DashboardSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboardsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Dashboard](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard.doc.html)!]! - # Dashboards connected downstream from the field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Dashboard_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard_filter.doc.html), - orderBy: [DashboardSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboardsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DashboardsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboardsconnection.doc.html) - # Workbooks downstream from this data source - # - # 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/current/api/metadata_api/en-us/reference/workbook_filter.doc.html), - orderBy: [WorkbookSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Workbook](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbook.doc.html)!]! - # Workbooks downstream from this data source - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Workbook_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbook_filter.doc.html), - orderBy: [WorkbookSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [WorkbooksConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksconnection.doc.html) - # Metrics downstream from this data source - # - # 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/current/api/metadata_api/en-us/reference/metric_filter.doc.html), - orderBy: [MetricSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Metric](https://help.tableau.com/current/api/metadata_api/en-us/reference/metric.doc.html)!]! - # Metrics downstream from this data source - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Metric_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metric_filter.doc.html), - orderBy: [MetricSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [MetricsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricsconnection.doc.html) - # Workbook owners downstream from this data source - # - # 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/current/api/metadata_api/en-us/reference/tableauuser_filter.doc.html), - orderBy: [TableauUserSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauusersortorder.doc.html) - ): [[TableauUser](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauuser.doc.html)!]! - # Workbook owners downstream from this data source - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [TableauUser_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauuser_filter.doc.html), - orderBy: [TableauUserSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauusersortorder.doc.html) - ): [TableauUsersConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauusersconnection.doc.html) - # Time the datasource was created. Available in Tableau Cloud June 2022 / Server - # 2022.3 and later. - createdAt: [DateTime](https://help.tableau.com/current/api/metadata_api/en-us/reference/datetime.doc.html) - # Time the datasource was last updated. Available in Tableau Cloud June 2022 / - # Server 2022.3 and later. - updatedAt: [DateTime](https://help.tableau.com/current/api/metadata_api/en-us/reference/datetime.doc.html) - # The lenses derived from this datasource - # - # 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. - lenses( - filter: [Lens_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/lens_filter.doc.html), - orderBy: [LensSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/lenssortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Lens](https://help.tableau.com/current/api/metadata_api/en-us/reference/lens.doc.html)] - # The lenses derived from this datasource - # - # 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. - lensesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Lens_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/lens_filter.doc.html), - orderBy: [LensSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/lenssortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [LensesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensesconnection.doc.html) - # Metric definitions downstream from the data source. - # - # 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/current/api/metadata_api/en-us/reference/metricdefinition_filter.doc.html), - orderBy: [MetricDefinitionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[MetricDefinition](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinition.doc.html)]! - # Metric definitions downstream from the data source. - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [MetricDefinition_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinition_filter.doc.html), - orderBy: [MetricDefinitionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [MetricDefinitionsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsconnection.doc.html) - # The virtual connection upstream to this Datasource - # - # 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. - upstreamVirtualConnections( - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection.doc.html)]! - # The virtual connection upstream to this Datasource - # - # 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. - upstreamVirtualConnectionsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsconnection.doc.html) - # The virtual connection table upstream to this Datasource - # - # 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/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnectionTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable.doc.html)]! - # The virtual connection table upstream to this Datasource - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnectionTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesconnection.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/current/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/current/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/current/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/current/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/current/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/current/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/current/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/current/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/current/api/metadata_api/en-us/reference/database.doc.html "Database - A database containing tables") - [DatabaseServer_A database server connection_](https://help.tableau.com/current/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/current/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/current/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.") - [EmbeddedDatasource_A data source embedded in a workbook_](https://help.tableau.com/current/api/metadata_api/en-us/reference/embeddeddatasource.doc.html "EmbeddedDatasource - A data source embedded in a workbook") - [Field_Base GraphQL type for a field_](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [File_A file connection_](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/flow.doc.html "Flow - Flows are used to prepare data, which can include aggregation, cleaning, preprocessing, etc.") - [FlowColumnInputField_Column input field implementation_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowcolumninputfield.doc.html "FlowColumnInputField - Column input field implementation") - [FlowColumnOutputField_Column output field implementation_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowcolumnoutputfield.doc.html "FlowColumnOutputField - Column output field implementation") - [FlowFieldInputField_Field input field implementation_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfield.doc.html "FlowFieldInputField - Field input field implementation") - [FlowFieldOutputField_Field output field implementation_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfield.doc.html "FlowFieldOutputField - Field output field implementation") - [FlowInputField_A wrapper for an input field contained in a published flow._](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowinputfield.doc.html "FlowInputField - A wrapper for an input field contained in a published flow.") - [FlowOutputField_A wrapper for an output field contained in a published flow._](https://help.tableau.com/current/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/current/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/current/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.*") - [Metric_Metrics are time series data constructed from fields contained in views. \*Retired in Tableau Cloud February 2024 / Server 2024.2.\*_](metric.doc.html "Metric - Metrics are time series data constructed from fields contained in views. *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.*") - [Parameter_Tableau Parameter. For more info see https://onlinehelp.tableau.com/current/pro/desktop/en-us/parameters\_create.html_](https://help.tableau.com/current/api/metadata_api/en-us/reference/parameter.doc.html "Parameter - Tableau Parameter. For more info see https://onlinehelp.tableau.com/current/pro/desktop/en-us/parameters_create.html") - [PublishedDatasource_A Tableau data source that has been published separately to Tableau Server. It can be used by multiple workbooks._](https://help.tableau.com/current/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.") - [PublishedDatasourcesConnection_Connection Type for PublishedDatasource_](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesconnection.doc.html "PublishedDatasourcesConnection - Connection Type for PublishedDatasource") - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/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/current/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/current/api/metadata_api/en-us/reference/table.doc.html "Table - A table containing columns") - [TableauSite_Site on Tableau server_](https://help.tableau.com/current/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/current/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/current/api/metadata_api/en-us/reference/tag.doc.html "Tag - A tag associated with content items") - [VirtualConnection_A virtual connection. \*Available in Tableau Cloud March 2022 / Server 2022.1 and later.\*_](virtualconnection.doc.html "VirtualConnection - A virtual connection. *Available in Tableau Cloud March 2022 / Server 2022.1 and later.*") - [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/current/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/current/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).") _menu_ Types INPUT\_OBJECT # PublishedDatasource\_Filter Filter by GraphQL field and given value ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input PublishedDatasource_Filter { - # True if the datasource contains unsupported custom SQL, in which case lineage - # may be incomplete - containsUnsupportedCustomSql: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) - # True if the datasource contains unsupported custom SQL, in which case lineage - # may be incomplete - containsUnsupportedCustomSqlWithin: [[Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html)] - # True if the data source has an active data quality warning - hasActiveWarning: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) - # True if the data source has an active data quality warning - hasActiveWarningWithin: [[Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html)] - # VizPortal URL ID; used for URL generation - vizportalUrlId: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # VizPortal URL ID; used for URL generation - vizportalUrlIdWithin: [[String](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/string.doc.html) - # Locally unique identifier used for the REST API on the Tableau Server - luidWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)] - # The name of the container in which the published data source is visible and - # usable. Either a personal space or project. - containerName: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # The name of the container in which the published data source is visible and - # usable. Either a personal space or project. - containerNameWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)] - # True if this data source contains an active data quality certification - isCertified: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) - # True if this data source contains an active data quality certification - isCertifiedWithin: [[Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html)] - # Name shown in server and desktop clients - name: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Name shown in server and desktop clients - nameWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.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/current/api/metadata_api/en-us/reference/id.doc.html) - # Unique identifier used by the metadata API. Not the same as the numeric ID used - # on server - idWithin: [[ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html)] - # The name of the project that contains this published data source. - projectName: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # The name of the project that contains this published data source. - projectNameWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.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/current/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/current/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/current/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/current/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/current/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/current/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/current/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/current/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/current/api/metadata_api/en-us/reference/database.doc.html "Database - A database containing tables") - [DatabaseServer_A database server connection_](https://help.tableau.com/current/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/current/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/current/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.") - [EmbeddedDatasource_A data source embedded in a workbook_](https://help.tableau.com/current/api/metadata_api/en-us/reference/embeddeddatasource.doc.html "EmbeddedDatasource - A data source embedded in a workbook") - [Field_Base GraphQL type for a field_](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [File_A file connection_](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/flow.doc.html "Flow - Flows are used to prepare data, which can include aggregation, cleaning, preprocessing, etc.") - [FlowColumnInputField_Column input field implementation_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowcolumninputfield.doc.html "FlowColumnInputField - Column input field implementation") - [FlowColumnOutputField_Column output field implementation_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowcolumnoutputfield.doc.html "FlowColumnOutputField - Column output field implementation") - [FlowFieldInputField_Field input field implementation_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfield.doc.html "FlowFieldInputField - Field input field implementation") - [FlowFieldOutputField_Field output field implementation_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfield.doc.html "FlowFieldOutputField - Field output field implementation") - [FlowInputField_A wrapper for an input field contained in a published flow._](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowinputfield.doc.html "FlowInputField - A wrapper for an input field contained in a published flow.") - [FlowOutputField_A wrapper for an output field contained in a published flow._](https://help.tableau.com/current/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/current/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/current/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.*") - [Metric_Metrics are time series data constructed from fields contained in views. \*Retired in Tableau Cloud February 2024 / Server 2024.2.\*_](metric.doc.html "Metric - Metrics are time series data constructed from fields contained in views. *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/current/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/current/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/current/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/current/api/metadata_api/en-us/reference/table.doc.html "Table - A table containing columns") - [TableauSite_Site on Tableau server_](https://help.tableau.com/current/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/current/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/current/api/metadata_api/en-us/reference/tag.doc.html "Tag - A tag associated with content items") - [VirtualConnection_A virtual connection. \*Available in Tableau Cloud March 2022 / Server 2022.1 and later.\*_](virtualconnection.doc.html "VirtualConnection - A virtual connection. *Available in Tableau Cloud March 2022 / Server 2022.1 and later.*") - [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/current/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/current/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).") _menu_ Types ENUM # PublishedDatasourceOrderField Enum for fields that can be used for sorting ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - enum PublishedDatasourceOrderField { - # Sort by downstreamOwners count - DOWNSTREAM_OWNERS_COUNT - # Sort by downstreamSheets count - DOWNSTREAM_SHEETS_COUNT - # Sort by downstreamWorkbooks count - DOWNSTREAM_WORKBOOKS_COUNT - # Sort by fields count - FIELDS_COUNT - # Sort by owner count - OWNER_COUNT - # Sort by containerName - CONTAINER_NAME - # Sort by containsUnsupportedCustomSql - CONTAINS_UNSUPPORTED_CUSTOM_SQL - # Sort by hasActiveWarning - HAS_ACTIVE_WARNING - # Sort by id - ID - # Sort by isCertified - IS_CERTIFIED - # Sort by luid - LUID - # Sort by name - NAME - # Sort by projectName - PROJECT_NAME - # Sort by vizportalUrlId - VIZPORTAL_URL_ID - } ` ## [_link_](#require-by) Require by - [PublishedDatasourceSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html "PublishedDatasourceSortOrder - 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.") _menu_ Types OBJECT # PublishedDatasourcesConnection Connection Type for PublishedDatasource ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type PublishedDatasourcesConnection { - # List of nodes - nodes: [[PublishedDatasource](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource.doc.html)!]! - # Information for pagination - pageInfo: [PageInfo](https://help.tableau.com/current/api/metadata_api/en-us/reference/pageinfo.doc.html)! - # Total number of objects in connection - totalCount: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.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/current/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/current/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/current/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/current/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/current/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/current/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/current/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/current/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/current/api/metadata_api/en-us/reference/database.doc.html "Database - A database containing tables") - [DatabaseServer_A database server connection_](https://help.tableau.com/current/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/current/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/current/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.") - [EmbeddedDatasource_A data source embedded in a workbook_](https://help.tableau.com/current/api/metadata_api/en-us/reference/embeddeddatasource.doc.html "EmbeddedDatasource - A data source embedded in a workbook") - [Field_Base GraphQL type for a field_](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [File_A file connection_](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/flow.doc.html "Flow - Flows are used to prepare data, which can include aggregation, cleaning, preprocessing, etc.") - [FlowColumnInputField_Column input field implementation_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowcolumninputfield.doc.html "FlowColumnInputField - Column input field implementation") - [FlowColumnOutputField_Column output field implementation_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowcolumnoutputfield.doc.html "FlowColumnOutputField - Column output field implementation") - [FlowFieldInputField_Field input field implementation_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfield.doc.html "FlowFieldInputField - Field input field implementation") - [FlowFieldOutputField_Field output field implementation_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfield.doc.html "FlowFieldOutputField - Field output field implementation") - [FlowInputField_A wrapper for an input field contained in a published flow._](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowinputfield.doc.html "FlowInputField - A wrapper for an input field contained in a published flow.") - [FlowOutputField_A wrapper for an output field contained in a published flow._](https://help.tableau.com/current/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/current/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/current/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.*") - [Metric_Metrics are time series data constructed from fields contained in views. \*Retired in Tableau Cloud February 2024 / Server 2024.2.\*_](metric.doc.html "Metric - Metrics are time series data constructed from fields contained in views. *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/current/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/current/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/current/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/current/api/metadata_api/en-us/reference/table.doc.html "Table - A table containing columns") - [TableauSite_Site on Tableau server_](https://help.tableau.com/current/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/current/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/current/api/metadata_api/en-us/reference/tag.doc.html "Tag - A tag associated with content items") - [VirtualConnection_A virtual connection. \*Available in Tableau Cloud March 2022 / Server 2022.1 and later.\*_](virtualconnection.doc.html "VirtualConnection - A virtual connection. *Available in Tableau Cloud March 2022 / Server 2022.1 and later.*") - [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/current/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/current/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).") _menu_ Types INPUT\_OBJECT # PublishedDatasourceSortOrder 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. ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input PublishedDatasourceSortOrder { - # GraphQL field to sort on - field: [PublishedDatasourceOrderField](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourceorderfield.doc.html)! - # Order direction to sort output - direction: [OrderDirection](https://help.tableau.com/current/api/metadata_api/en-us/reference/orderdirection.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/current/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/current/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/current/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/current/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/current/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/current/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/current/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/current/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/current/api/metadata_api/en-us/reference/database.doc.html "Database - A database containing tables") - [DatabaseServer_A database server connection_](https://help.tableau.com/current/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/current/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/current/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.") - [EmbeddedDatasource_A data source embedded in a workbook_](https://help.tableau.com/current/api/metadata_api/en-us/reference/embeddeddatasource.doc.html "EmbeddedDatasource - A data source embedded in a workbook") - [Field_Base GraphQL type for a field_](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [File_A file connection_](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/flow.doc.html "Flow - Flows are used to prepare data, which can include aggregation, cleaning, preprocessing, etc.") - [FlowColumnInputField_Column input field implementation_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowcolumninputfield.doc.html "FlowColumnInputField - Column input field implementation") - [FlowColumnOutputField_Column output field implementation_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowcolumnoutputfield.doc.html "FlowColumnOutputField - Column output field implementation") - [FlowFieldInputField_Field input field implementation_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfield.doc.html "FlowFieldInputField - Field input field implementation") - [FlowFieldOutputField_Field output field implementation_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfield.doc.html "FlowFieldOutputField - Field output field implementation") - [FlowInputField_A wrapper for an input field contained in a published flow._](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowinputfield.doc.html "FlowInputField - A wrapper for an input field contained in a published flow.") - [FlowOutputField_A wrapper for an output field contained in a published flow._](https://help.tableau.com/current/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/current/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/current/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.*") - [Metric_Metrics are time series data constructed from fields contained in views. \*Retired in Tableau Cloud February 2024 / Server 2024.2.\*_](metric.doc.html "Metric - Metrics are time series data constructed from fields contained in views. *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/current/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/current/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/current/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/current/api/metadata_api/en-us/reference/table.doc.html "Table - A table containing columns") - [TableauSite_Site on Tableau server_](https://help.tableau.com/current/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/current/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/current/api/metadata_api/en-us/reference/tag.doc.html "Tag - A tag associated with content items") - [VirtualConnection_A virtual connection. \*Available in Tableau Cloud March 2022 / Server 2022.1 and later.\*_](virtualconnection.doc.html "VirtualConnection - A virtual connection. *Available in Tableau Cloud March 2022 / Server 2022.1 and later.*") - [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/current/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/current/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).") _menu_ Types OBJECT # Query Query root for Metadata GraphQL interface ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type Query { - # Fetches Fields by filtering on id or name - # - # 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. - fields( - filter: [Field_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/field_filter.doc.html), - orderBy: [FieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Field](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.doc.html)!]! - # Fetches Datasources by filtering on id or name - # - # 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. - datasources( - filter: [Datasource_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasource_filter.doc.html), - orderBy: [DatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Datasource](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasource.doc.html)!]! - # Fetches Tables by filtering on id or name - # - # 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: [Table_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/table_filter.doc.html), - orderBy: [TableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Table](https://help.tableau.com/current/api/metadata_api/en-us/reference/table.doc.html)!]! - # Fetches Views by filtering on id or name - # - # 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. - views( - filter: [View_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/view_filter.doc.html), - orderBy: [ViewSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/viewsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[View](https://help.tableau.com/current/api/metadata_api/en-us/reference/view.doc.html)!]! - # Fetches Databases by filtering on id or name - # - # 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. - databases( - filter: [Database_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Database](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html)!]! - # Fetches MetricDefinitions by filtering on id or name - # - # 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. - metricDefinitions( - filter: [MetricDefinition_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinition_filter.doc.html), - orderBy: [MetricDefinitionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[MetricDefinition](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinition.doc.html)!]! - # Fetches PublishedDatasources by filtering on id or name - # - # 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. - publishedDatasources( - filter: [PublishedDatasource_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[PublishedDatasource](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource.doc.html)!]! - # Fetches CustomSQLTables by filtering on id or name - # - # 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. - customSQLTables( - filter: [CustomSQLTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/customsqltable_filter.doc.html), - orderBy: [CustomSQLTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/customsqltablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[CustomSQLTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/customsqltable.doc.html)!]! - # Fetches DatasourceFilters by filtering on id or name - # - # 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. - datasourceFilters( - filter: [DatasourceFilter_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefilter_filter.doc.html), - orderBy: [DatasourceFilterSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefiltersortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DatasourceFilter](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefilter.doc.html)!]! - # Fetches Parameters by filtering on id or name - # - # 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. - parameters( - filter: [Parameter_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/parameter_filter.doc.html), - orderBy: [ParameterSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/parametersortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Parameter](https://help.tableau.com/current/api/metadata_api/en-us/reference/parameter.doc.html)!]! - # Fetches BinFields by filtering on id or name - # - # 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. - binFields( - filter: [BinField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/binfield_filter.doc.html), - orderBy: [BinFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/binfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[BinField](https://help.tableau.com/current/api/metadata_api/en-us/reference/binfield.doc.html)!]! - # Fetches CalculatedFields by filtering on id or name - # - # 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. - calculatedFields( - filter: [CalculatedField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/calculatedfield_filter.doc.html), - orderBy: [CalculatedFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/calculatedfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[CalculatedField](https://help.tableau.com/current/api/metadata_api/en-us/reference/calculatedfield.doc.html)!]! - # Fetches ColumnFields by filtering on id or name - # - # 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. - columnFields( - filter: [ColumnField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnfield_filter.doc.html), - orderBy: [ColumnFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[ColumnField](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnfield.doc.html)!]! - # Fetches CombinedFields by filtering on id or name - # - # 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. - combinedFields( - filter: [CombinedField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedfield_filter.doc.html), - orderBy: [CombinedFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[CombinedField](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedfield.doc.html)!]! - # Fetches CombinedSetFields by filtering on id or name - # - # 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. - combinedSetFields( - filter: [CombinedSetField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedsetfield_filter.doc.html), - orderBy: [CombinedSetFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedsetfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[CombinedSetField](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedsetfield.doc.html)!]! - # Fetches DatasourceFields by filtering on id or name - # - # 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. - datasourceFields( - filter: [DatasourceField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefield_filter.doc.html), - orderBy: [DatasourceFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DatasourceField](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefield.doc.html)!]! - # Fetches GroupFields by filtering on id or name - # - # 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. - groupFields( - filter: [GroupField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/groupfield_filter.doc.html), - orderBy: [GroupFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/groupfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[GroupField](https://help.tableau.com/current/api/metadata_api/en-us/reference/groupfield.doc.html)!]! - # Fetches SetFields by filtering on id or name - # - # 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. - setFields( - filter: [SetField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/setfield_filter.doc.html), - orderBy: [SetFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/setfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[SetField](https://help.tableau.com/current/api/metadata_api/en-us/reference/setfield.doc.html)!]! - # Fetches HierarchyFields by filtering on id or name - # - # 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. - hierarchyFields( - filter: [HierarchyField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/hierarchyfield_filter.doc.html), - orderBy: [HierarchyFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/hierarchyfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[HierarchyField](https://help.tableau.com/current/api/metadata_api/en-us/reference/hierarchyfield.doc.html)!]! - # Fetches TableauSites by filtering on id or name - # - # 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. - tableauSites( - filter: [TableauSite_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableausite_filter.doc.html), - orderBy: [TableauSiteSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableausitesortorder.doc.html) - ): [[TableauSite](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableausite.doc.html)!]! - # Fetches TableauUsers by filtering on id or name - # - # 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. - tableauUsers( - filter: [TableauUser_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauuser_filter.doc.html), - orderBy: [TableauUserSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauusersortorder.doc.html) - ): [[TableauUser](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauuser.doc.html)!]! - # Fetches Tags by filtering on id or name - # - # 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/current/api/metadata_api/en-us/reference/tag_filter.doc.html), orderBy: [TagSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tagsortorder.doc.html)): [[Tag](https://help.tableau.com/current/api/metadata_api/en-us/reference/tag.doc.html)!]! - # Fetches GenericLabels by filtering on id or name - # - # 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. - genericLabels( - filter: [GenericLabel_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/genericlabel_filter.doc.html), - orderBy: [GenericLabelSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/genericlabelsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[GenericLabel](https://help.tableau.com/current/api/metadata_api/en-us/reference/genericlabel.doc.html)!]! - # Fetches DataQualityWarnings by filtering on id or name - # - # 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/current/api/metadata_api/en-us/reference/dataqualitywarning_filter.doc.html), - orderBy: [DataQualityWarningSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarningsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DataQualityWarning](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarning.doc.html)!]! - # Fetches DataQualityCertifications by filtering on id or name - # - # 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/current/api/metadata_api/en-us/reference/dataqualitycertification_filter.doc.html), - orderBy: [DataQualityCertificationSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitycertificationsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DataQualityCertification](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitycertification.doc.html)!]! - # Fetches Columns by filtering on id or name - # - # 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. - columns( - filter: [Column_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/column_filter.doc.html), - orderBy: [ColumnSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Column](https://help.tableau.com/current/api/metadata_api/en-us/reference/column.doc.html)!]! - # Fetches Workbooks by filtering on id or name - # - # 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. - workbooks( - filter: [Workbook_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbook_filter.doc.html), - orderBy: [WorkbookSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Workbook](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbook.doc.html)!]! - # Fetches Sheets by filtering on id or name - # - # 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. - sheets( - filter: [Sheet_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Sheet](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html)!]! - # Fetches Dashboards by filtering on id or name - # - # 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. - dashboards( - filter: [Dashboard_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard_filter.doc.html), - orderBy: [DashboardSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboardsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Dashboard](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard.doc.html)!]! - # Fetches EmbeddedDatasources by filtering on id or name - # - # 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. - embeddedDatasources( - filter: [EmbeddedDatasource_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/embeddeddatasource_filter.doc.html), - orderBy: [EmbeddedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/embeddeddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[EmbeddedDatasource](https://help.tableau.com/current/api/metadata_api/en-us/reference/embeddeddatasource.doc.html)!]! - # Fetches AskDataExtensions by filtering on id or name - # - # 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. - askDataExtensions( - filter: [AskDataExtension_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/askdataextension_filter.doc.html), - orderBy: [AskDataExtensionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/askdataextensionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[AskDataExtension](https://help.tableau.com/current/api/metadata_api/en-us/reference/askdataextension.doc.html)!]! - # Fetches Lenses by filtering on id or name - # - # 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. - lenses( - filter: [Lens_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/lens_filter.doc.html), - orderBy: [LensSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/lenssortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Lens](https://help.tableau.com/current/api/metadata_api/en-us/reference/lens.doc.html)!]! - # Fetches LensFields by filtering on id or name - # - # 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. - lensFields( - filter: [LensField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensfield_filter.doc.html), - orderBy: [LensFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[LensField](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensfield.doc.html)!]! - # Fetches Flows by filtering on id or name - # - # 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. - flows( - filter: [Flow_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Flow](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow.doc.html)!]! - # Fetches FlowFieldInputFields by filtering on id or name - # - # 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. - flowFieldInputFields( - filter: [FlowFieldInputField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfield_filter.doc.html), - orderBy: [FlowFieldInputFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfieldsortorder.doc.html) - ): [[FlowFieldInputField](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfield.doc.html)!]! - # Fetches FlowColumnInputFields by filtering on id or name - # - # 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. - flowColumnInputFields( - filter: [FlowColumnInputField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowcolumninputfield_filter.doc.html), - orderBy: [FlowColumnInputFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowcolumninputfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[FlowColumnInputField](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowcolumninputfield.doc.html)!]! - # Fetches FlowColumnOutputFields by filtering on id or name - # - # 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. - flowColumnOutputFields( - filter: [FlowColumnOutputField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowcolumnoutputfield_filter.doc.html), - orderBy: [FlowColumnOutputFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowcolumnoutputfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[FlowColumnOutputField](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowcolumnoutputfield.doc.html)!]! - # Fetches FlowFieldOutputFields by filtering on id or name - # - # 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. - flowFieldOutputFields( - filter: [FlowFieldOutputField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfield_filter.doc.html), - orderBy: [FlowFieldOutputFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[FlowFieldOutputField](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfield.doc.html)!]! - # Fetches FlowOutputSteps by filtering on id or name - # - # 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. - flowOutputSteps( - filter: [FlowOutputStep_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowoutputstep_filter.doc.html), - orderBy: [FlowOutputStepSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowoutputstepsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[FlowOutputStep](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowoutputstep.doc.html)!]! - # Fetches DataClouds by filtering on id or name - # - # 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. - dataClouds( - filter: [DataCloud_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/datacloud_filter.doc.html), - orderBy: [DataCloudSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/datacloudsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DataCloud](https://help.tableau.com/current/api/metadata_api/en-us/reference/datacloud.doc.html)!]! - # Fetches DatabaseServers by filtering on id or name - # - # 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. - databaseServers( - filter: [DatabaseServer_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databaseserver_filter.doc.html), - orderBy: [DatabaseServerSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databaseserversortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DatabaseServer](https://help.tableau.com/current/api/metadata_api/en-us/reference/databaseserver.doc.html)!]! - # Fetches CloudFiles by filtering on id or name - # - # 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. - cloudFiles( - filter: [CloudFile_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/cloudfile_filter.doc.html), - orderBy: [CloudFileSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/cloudfilesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[CloudFile](https://help.tableau.com/current/api/metadata_api/en-us/reference/cloudfile.doc.html)!]! - # Fetches Files by filtering on id or name - # - # 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. - files( - filter: [File_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/file_filter.doc.html), - orderBy: [FileSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/filesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[File](https://help.tableau.com/current/api/metadata_api/en-us/reference/file.doc.html)!]! - # Fetches WebDataConnectors by filtering on id or name - # - # 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. - webDataConnectors( - filter: [WebDataConnector_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/webdataconnector_filter.doc.html), - orderBy: [WebDataConnectorSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/webdataconnectorsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[WebDataConnector](https://help.tableau.com/current/api/metadata_api/en-us/reference/webdataconnector.doc.html)!]! - # Fetches DatabaseTables by filtering on id or name - # - # 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. - databaseTables( - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DatabaseTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable.doc.html)!]! - # Fetches TableAdditionalDetailses by filtering on id or name - # - # 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. - tableAdditionalDetailses( - filter: [TableAdditionalDetails_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableadditionaldetails_filter.doc.html), - orderBy: [TableAdditionalDetailsSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableadditionaldetailssortorder.doc.html) - ): [[TableAdditionalDetails](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableadditionaldetails.doc.html)!]! - # Fetches VirtualConnections by filtering on id or name - # - # 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. - virtualConnections( - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection.doc.html)!]! - # Fetches VirtualConnectionTables by filtering on id or name - # - # 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. - virtualConnectionTables( - filter: [VirtualConnectionTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnectionTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable.doc.html)!]! - # Fetches Metrics by filtering on id or name - # - # 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. - metrics( - filter: [Metric_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metric_filter.doc.html), - orderBy: [MetricSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Metric](https://help.tableau.com/current/api/metadata_api/en-us/reference/metric.doc.html)!]! - # Fetch Fields with support for pagination - # - # 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. - # **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. - fieldsConnection( - filter: [Field_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/field_filter.doc.html), - orderBy: [FieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html), - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html) - ): [FieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsconnection.doc.html)! - # Fetch Datasources with support for pagination - # - # 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. - # **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. - datasourcesConnection( - filter: [Datasource_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasource_filter.doc.html), - orderBy: [DatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html), - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html) - ): [DatasourcesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcesconnection.doc.html)! - # Fetch Tables with support for pagination - # - # 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. - # **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. - tablesConnection( - filter: [Table_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/table_filter.doc.html), - orderBy: [TableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html), - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html) - ): [TablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/tablesconnection.doc.html)! - # Fetch Views with support for pagination - # - # 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. - # **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. - viewsConnection( - filter: [View_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/view_filter.doc.html), - orderBy: [ViewSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/viewsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html), - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html) - ): [ViewsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/viewsconnection.doc.html)! - # Fetch Databases with support for pagination - # - # 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. - # **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. - databasesConnection( - filter: [Database_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html), - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html) - ): [DatabasesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesconnection.doc.html)! - # Fetch MetricDefinitions with support for pagination - # - # 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. - # **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. - metricDefinitionsConnection( - filter: [MetricDefinition_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinition_filter.doc.html), - orderBy: [MetricDefinitionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html), - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html) - ): [MetricDefinitionsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsconnection.doc.html)! - # Fetch PublishedDatasources with support for pagination - # - # 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. - # **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. - publishedDatasourcesConnection( - filter: [PublishedDatasource_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html), - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html) - ): [PublishedDatasourcesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesconnection.doc.html)! - # Fetch CustomSQLTables with support for pagination - # - # 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. - # **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. - customSQLTablesConnection( - filter: [CustomSQLTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/customsqltable_filter.doc.html), - orderBy: [CustomSQLTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/customsqltablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html), - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html) - ): [CustomSQLTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/customsqltablesconnection.doc.html)! - # Fetch DatasourceFilters with support for pagination - # - # 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. - # **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. - datasourceFiltersConnection( - filter: [DatasourceFilter_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefilter_filter.doc.html), - orderBy: [DatasourceFilterSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefiltersortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html), - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html) - ): [DatasourceFiltersConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefiltersconnection.doc.html)! - # Fetch Parameters with support for pagination - # - # 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. - # **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. - parametersConnection( - filter: [Parameter_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/parameter_filter.doc.html), - orderBy: [ParameterSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/parametersortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html), - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html) - ): [ParametersConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/parametersconnection.doc.html)! - # Fetch BinFields with support for pagination - # - # 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. - # **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. - binFieldsConnection( - filter: [BinField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/binfield_filter.doc.html), - orderBy: [BinFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/binfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html), - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html) - ): [BinFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/binfieldsconnection.doc.html)! - # Fetch CalculatedFields with support for pagination - # - # 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. - # **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. - calculatedFieldsConnection( - filter: [CalculatedField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/calculatedfield_filter.doc.html), - orderBy: [CalculatedFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/calculatedfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html), - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html) - ): [CalculatedFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/calculatedfieldsconnection.doc.html)! - # Fetch ColumnFields with support for pagination - # - # 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. - # **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. - columnFieldsConnection( - filter: [ColumnField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnfield_filter.doc.html), - orderBy: [ColumnFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html), - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html) - ): [ColumnFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnfieldsconnection.doc.html)! - # Fetch CombinedFields with support for pagination - # - # 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. - # **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. - combinedFieldsConnection( - filter: [CombinedField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedfield_filter.doc.html), - orderBy: [CombinedFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html), - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html) - ): [CombinedFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedfieldsconnection.doc.html)! - # Fetch CombinedSetFields with support for pagination - # - # 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. - # **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. - combinedSetFieldsConnection( - filter: [CombinedSetField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedsetfield_filter.doc.html), - orderBy: [CombinedSetFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedsetfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html), - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html) - ): [CombinedSetFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedsetfieldsconnection.doc.html)! - # Fetch DatasourceFields with support for pagination - # - # 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. - # **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. - datasourceFieldsConnection( - filter: [DatasourceField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefield_filter.doc.html), - orderBy: [DatasourceFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html), - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html) - ): [DatasourceFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefieldsconnection.doc.html)! - # Fetch GroupFields with support for pagination - # - # 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. - # **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. - groupFieldsConnection( - filter: [GroupField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/groupfield_filter.doc.html), - orderBy: [GroupFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/groupfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html), - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html) - ): [GroupFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/groupfieldsconnection.doc.html)! - # Fetch SetFields with support for pagination - # - # 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. - # **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. - setFieldsConnection( - filter: [SetField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/setfield_filter.doc.html), - orderBy: [SetFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/setfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html), - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html) - ): [SetFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/setfieldsconnection.doc.html)! - # Fetch HierarchyFields with support for pagination - # - # 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. - # **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. - hierarchyFieldsConnection( - filter: [HierarchyField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/hierarchyfield_filter.doc.html), - orderBy: [HierarchyFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/hierarchyfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html), - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html) - ): [HierarchyFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/hierarchyfieldsconnection.doc.html)! - # Fetch TableauSites with support for pagination - # - # 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. - # **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. - tableauSitesConnection( - filter: [TableauSite_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableausite_filter.doc.html), - orderBy: [TableauSiteSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableausitesortorder.doc.html), - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html) - ): [TableauSitesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableausitesconnection.doc.html)! - # Fetch TableauUsers with support for pagination - # - # 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. - # **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. - tableauUsersConnection( - filter: [TableauUser_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauuser_filter.doc.html), - orderBy: [TableauUserSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauusersortorder.doc.html), - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html) - ): [TableauUsersConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauusersconnection.doc.html)! - # Fetch Tags with support for pagination - # - # 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. - # **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. - tagsConnection( - filter: [Tag_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/tag_filter.doc.html), - orderBy: [TagSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tagsortorder.doc.html), - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html) - ): [TagsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/tagsconnection.doc.html)! - # Fetch GenericLabels with support for pagination - # - # 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. - # **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. - genericLabelsConnection( - filter: [GenericLabel_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/genericlabel_filter.doc.html), - orderBy: [GenericLabelSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/genericlabelsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html), - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html) - ): [GenericLabelsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/genericlabelsconnection.doc.html)! - # Fetch DataQualityWarnings with support for pagination - # - # 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. - # **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. - dataQualityWarningsConnection( - filter: [DataQualityWarning_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarning_filter.doc.html), - orderBy: [DataQualityWarningSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarningsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html), - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html) - ): [DataQualityWarningsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarningsconnection.doc.html)! - # Fetch DataQualityCertifications with support for pagination - # - # 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. - # **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. - dataQualityCertificationsConnection( - filter: [DataQualityCertification_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitycertification_filter.doc.html), - orderBy: [DataQualityCertificationSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitycertificationsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html), - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html) - ): [DataQualityCertificationsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitycertificationsconnection.doc.html)! - # Fetch Columns with support for pagination - # - # 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. - # **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. - columnsConnection( - filter: [Column_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/column_filter.doc.html), - orderBy: [ColumnSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html), - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html) - ): [ColumnsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnsconnection.doc.html)! - # Fetch Workbooks with support for pagination - # - # 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. - # **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. - workbooksConnection( - filter: [Workbook_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbook_filter.doc.html), - orderBy: [WorkbookSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html), - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html) - ): [WorkbooksConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksconnection.doc.html)! - # Fetch Sheets with support for pagination - # - # 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. - # **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. - sheetsConnection( - filter: [Sheet_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html), - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html) - ): [SheetsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsconnection.doc.html)! - # Fetch Dashboards with support for pagination - # - # 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. - # **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. - dashboardsConnection( - filter: [Dashboard_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard_filter.doc.html), - orderBy: [DashboardSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboardsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html), - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html) - ): [DashboardsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboardsconnection.doc.html)! - # Fetch EmbeddedDatasources with support for pagination - # - # 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. - # **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. - embeddedDatasourcesConnection( - filter: [EmbeddedDatasource_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/embeddeddatasource_filter.doc.html), - orderBy: [EmbeddedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/embeddeddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html), - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html) - ): [EmbeddedDatasourcesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/embeddeddatasourcesconnection.doc.html)! - # Fetch AskDataExtensions with support for pagination - # - # 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. - # **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. - askDataExtensionsConnection( - filter: [AskDataExtension_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/askdataextension_filter.doc.html), - orderBy: [AskDataExtensionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/askdataextensionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html), - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html) - ): [AskDataExtensionsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/askdataextensionsconnection.doc.html)! - # Fetch Lenss with support for pagination - # - # 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. - # **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. - lensesConnection( - filter: [Lens_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/lens_filter.doc.html), - orderBy: [LensSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/lenssortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html), - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html) - ): [LensesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensesconnection.doc.html)! - # Fetch LensFields with support for pagination - # - # 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. - # **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. - lensFieldsConnection( - filter: [LensField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensfield_filter.doc.html), - orderBy: [LensFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html), - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html) - ): [LensFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensfieldsconnection.doc.html)! - # Fetch Flows with support for pagination - # - # 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. - # **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. - flowsConnection( - filter: [Flow_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html), - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html) - ): [FlowsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsconnection.doc.html)! - # Fetch FlowFieldInputFields with support for pagination - # - # 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. - # **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. - flowFieldInputFieldsConnection( - filter: [FlowFieldInputField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfield_filter.doc.html), - orderBy: [FlowFieldInputFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfieldsortorder.doc.html), - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html) - ): [FlowFieldInputFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfieldsconnection.doc.html)! - # Fetch FlowColumnInputFields with support for pagination - # - # 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. - # **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. - flowColumnInputFieldsConnection( - filter: [FlowColumnInputField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowcolumninputfield_filter.doc.html), - orderBy: [FlowColumnInputFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowcolumninputfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html), - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html) - ): [FlowColumnInputFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowcolumninputfieldsconnection.doc.html)! - # Fetch FlowColumnOutputFields with support for pagination - # - # 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. - # **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. - flowColumnOutputFieldsConnection( - filter: [FlowColumnOutputField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowcolumnoutputfield_filter.doc.html), - orderBy: [FlowColumnOutputFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowcolumnoutputfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html), - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html) - ): [FlowColumnOutputFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowcolumnoutputfieldsconnection.doc.html)! - # Fetch FlowFieldOutputFields with support for pagination - # - # 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. - # **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. - flowFieldOutputFieldsConnection( - filter: [FlowFieldOutputField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfield_filter.doc.html), - orderBy: [FlowFieldOutputFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html), - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html) - ): [FlowFieldOutputFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfieldsconnection.doc.html)! - # Fetch FlowOutputSteps with support for pagination - # - # 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. - # **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. - flowOutputStepsConnection( - filter: [FlowOutputStep_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowoutputstep_filter.doc.html), - orderBy: [FlowOutputStepSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowoutputstepsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html), - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html) - ): [FlowOutputStepsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowoutputstepsconnection.doc.html)! - # Fetch DataClouds with support for pagination - # - # 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. - # **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. - dataCloudsConnection( - filter: [DataCloud_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/datacloud_filter.doc.html), - orderBy: [DataCloudSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/datacloudsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html), - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html) - ): [DataCloudsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/datacloudsconnection.doc.html)! - # Fetch DatabaseServers with support for pagination - # - # 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. - # **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. - databaseServersConnection( - filter: [DatabaseServer_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databaseserver_filter.doc.html), - orderBy: [DatabaseServerSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databaseserversortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html), - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html) - ): [DatabaseServersConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databaseserversconnection.doc.html)! - # Fetch CloudFiles with support for pagination - # - # 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. - # **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. - cloudFilesConnection( - filter: [CloudFile_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/cloudfile_filter.doc.html), - orderBy: [CloudFileSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/cloudfilesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html), - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html) - ): [CloudFilesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/cloudfilesconnection.doc.html)! - # Fetch Files with support for pagination - # - # 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. - # **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. - filesConnection( - filter: [File_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/file_filter.doc.html), - orderBy: [FileSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/filesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html), - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html) - ): [FilesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/filesconnection.doc.html)! - # Fetch WebDataConnectors with support for pagination - # - # 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. - # **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. - webDataConnectorsConnection( - filter: [WebDataConnector_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/webdataconnector_filter.doc.html), - orderBy: [WebDataConnectorSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/webdataconnectorsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html), - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html) - ): [WebDataConnectorsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/webdataconnectorsconnection.doc.html)! - # Fetch DatabaseTables with support for pagination - # - # 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. - # **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. - databaseTablesConnection( - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html), - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html) - ): [DatabaseTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesconnection.doc.html)! - # Fetch TableAdditionalDetailss with support for pagination - # - # 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. - # **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. - tableAdditionalDetailsesConnection( - filter: [TableAdditionalDetails_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableadditionaldetails_filter.doc.html), - orderBy: [TableAdditionalDetailsSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableadditionaldetailssortorder.doc.html), - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html) - ): [TableAdditionalDetailsesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableadditionaldetailsesconnection.doc.html)! - # Fetch VirtualConnections with support for pagination - # - # 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. - # **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. - virtualConnectionsConnection( - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html), - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html) - ): [VirtualConnectionsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsconnection.doc.html)! - # Fetch VirtualConnectionTables with support for pagination - # - # 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. - # **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. - virtualConnectionTablesConnection( - filter: [VirtualConnectionTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html), - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html) - ): [VirtualConnectionTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesconnection.doc.html)! - # Fetch Metrics with support for pagination - # - # 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. - # **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. - metricsConnection( - filter: [Metric_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metric_filter.doc.html), - orderBy: [MetricSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html), - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html) - ): [MetricsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricsconnection.doc.html)! - } ` ## [_link_](#require-by) Require by This element is not required by anyone # Release Notes Significant changes to this project are noted in this document. **Jump to version** ### Tableau Cloud June 2024 / Server 2024.2 #### Added - Added Tableau Pulse MetricDefinition objects and supporting shortcuts to the schema. - Tableau Server: Lens objects and supporting shortcuts are retired. No lens or lens properties are returned from queries. (Removed from Tableau Server in this version. Already removed from Tableau Cloud in February 2023.) - Tableau Server: Metrics objects and supporting shortcuts are retired. No metrics or metrics properties are returned from queries. (Removed from Tableau Server in this version. Already removed from Tableau Cloud in February 2023.) ### Tableau Cloud February 2024 #### Retired - Lens objects and supporting shortcuts are retired. No lens or lens properties are returned from queries. - Metrics objects and supporting shortcuts are retired. No metrics or metrics properties are returned from queries. ### Tableau Cloud October 2023 / Server 2023.3 #### Added - Tableau Server: Added Metadata API request throttling. Requests that exceed the rate threshold receive a RATE\_EXCEEDED error. (New for Tableau Server in this version. Already added to Tableau Cloud in June 2023.) - The Metadata API now respects credentials tokens that were obtained via a JSON web token (JWT) and Tableau connected apps. You still use the REST API Sign In method to get a credentials token, but now you can use a JWT in the REST API Sign In request. For information, see [Sign in using a JSON web token (JWT)](https://help.tableau.com/current/api/metadata_api/en-us/docs/meta_api_auth.html#metadata-api-auth-json). ### Tableau Cloud June 2023 #### Added - Added Metadata API request throttling. Requests that exceed the rate threshold receive a RATE\_EXCEEDED error. - Types that implement the Field interface can be filtered by name using a text filter. The filter will return fields where any word in the field name begins with the specified case-insensitive text. Example: query FilteredFields { publishedDatasources { name fields (filter: {text: "age"}) { id name } } } ### Tableau Cloud March 2023 / Server 2023.1 #### Changed - The virtualConnection object’s connectionType attribute now returns ‘null’, and may be removed in a future release. Use ‘connectionType’ of ‘upstreamDatabases’ instead. (New for Tableau Server 2023.1. Changed in Tableau Cloud in December 2022) - The DataQualityWarning.asset and DataQualityCertification.asset edges now point to the CanHaveLabels interface instead of the Warnable and Certifiable interfaces. This change was made to move the schema towards a more general interface that works with all labels. Referencing edge names that exist on the Warnable and Certificable interfaces but do not exist on the CanHaveLabels interface will produce an error. For information on the error and adjusting queries that may be affected, see “Other Errors”, in the [Common Errors](https://help.tableau.com/current/api/metadata_api/en-us/docs/meta_api_errors.html#other-errors) topic. The list of affected edges is: - Warnable.hasActiveWarning - Warnable.dataQualityWarnings - Warnable.dataQualityWarningsConnection - Certifiable.isCertified - Certifiable.dataQualityCertifications - Certifiable.dataQualityCertificationsConnection ### Tableau Cloud December 2022 #### Changed - The virtualConnection object’s connectionType attribute now returns ‘null’, and may be removed in a future release. Use ‘connectionType’ of ‘upstreamDatabases’ instead. ### Tableau Cloud October 2022 / Server 2022.3 #### Added - Modified existing data quality warning shortcuts to support data quality warnings on columns. ### Tableau Cloud June 2022 #### Added - Added lens objects and supporting shortcuts to the schema. - Added new fields to existing objects: | Object | New fields | | --- | --- | | tableauSites | createdAt | | workbooks | projectLuid | | datasources | createdAt, updatedAt | | flows | createdAt, updatedAt | | virtualConnections | createdAt, updatedAt | ### Tableau Cloud March 2022 / Server 2022.1 #### Added - Added the virtualConnection and virtualConnectionTable objects and supporting shortcuts to the schema. ### Tableau Cloud December 2021 / Server 2021.4 #### Changed - Some shortcuts were changed to make the definitions of “upstream” and “downstream” more consistent throughout the schema. - The `Column` type’s `upstreamTables` and `downstreamTables` shortcuts no longer include the table that contains the column. Use `Column.table` to find information about the containing table instead. - The `Table` type’s `upstreamDatabases` shortcut no longer includes the database that contains the table. Use `... on DatabaseTable {database}` instead. - The `Workbook` type’s `downstreamOwners` field no longer includes the owner of the workbook. Use `Workbook.owner` to find information about the workbook owner instead. ### Older versions The Metadata API was officially released in Tableau Server 2019.3 and Tableau Cloud in September of 2019. This document tracks Metadata API changes starting with 2021.4. _menu_ Types ENUM # RemoteType Possible types of remote types Types correspond to OLEDB types here: [https://referencesource.microsoft.com/#system.data/System/Data/OleDb/OLEDB\_Enum.cs,364"](https://referencesource.microsoft.com/#system.data/System/Data/OleDb/OLEDB_Enum.cs,364") Types prefixed with 'WDC' correspond to Tableau's Web Data Connector types: [https://tableau.github.io/webdataconnector/docs/api\_ref.html#webdataconnectorapi.datatypeenum](https://tableau.github.io/webdataconnector/docs/api_ref.html#webdataconnectorapi.datatypeenum) ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - enum RemoteType { - EMPTY - NULL - I2 - I4 - R4 - R8 - CY - DATE - BSTR - IDISPATCH - ERROR - BOOL - VARIANT - IUNKNOWN - DECIMAL - UI1 - ARRAY - BYREF - I1 - UI2 - UI4 - I8 - UI8 - GUID - VECTOR - FILETIME - RESERVED - BYTES - STR - WSTR - NUMERIC - UDT - DBDATE - DBTIME - DBTIMESTAMP - HCHAPTER - PROPVARIANT - VARNUMERIC - WDC_INT - WDC_FLOAT - WDC_STRING - WDC_DATETIME - WDC_BOOL - WDC_DATE - WDC_GEOMETRY - } ` ## [_link_](#require-by) Require by - [Column_GraphQL type for a table column_](https://help.tableau.com/current/api/metadata_api/en-us/reference/column.doc.html "Column - GraphQL type for a table column") _menu_ Types INPUT\_OBJECT # RemoteType\_Filter Filter by GraphQL field and given value ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input RemoteType_Filter { - # Unique Identifier of object to retrieve - id: [ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html) - # Unique Identifier of object to retrieve - idWithin: [[ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html)] - } ` ## [_link_](#require-by) Require by This element is not required by anyone # Sample Scripts To help you use the Tableau Metadata API, Tableau provides sample scripts that you can download and modify for your purposes. The sample scripts can be downloaded from GitHub: [https://github.com/tableau/metadata-api-samples \[↗\]](https://github.com/tableau/metadata-api-samples). You can also download the Metadata API schema files from here: - [schema.json](/current/api/metadata_api/en-us/samples/schema.json) - [schema.graphql](/current/api/metadata_api/en-us/samples/schema.graphql) _menu_ Types OBJECT # SetField GraphQL type for a set field. See [https://onlinehelp.tableau.com/current/pro/desktop/en-us/sortgroup\_sets\_create.html](https://onlinehelp.tableau.com/current/pro/desktop/en-us/sortgroup_sets_create.html) ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type SetField implements [Field](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.doc.html), [FieldReferencingField](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield.doc.html), [Node](https://help.tableau.com/current/api/metadata_api/en-us/reference/node.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/current/api/metadata_api/en-us/reference/id.doc.html)! - # Name shown in server and desktop clients - name: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Name internally used to uniquely identify fields - fullyQualifiedName: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Description of field shown in server and desktop clients - description: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # description that is shown in the Tableau UI - # - # Arguments - # **inheritanceType**: Method for selecting inherited value - # **permissionMode**: Option to select how to apply permissions. By - # default it is OBFUSCATE_RESULTS - descriptionInherited( - inheritanceType: [InheritanceType](https://help.tableau.com/current/api/metadata_api/en-us/reference/inheritancetype.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[InheritedStringResult](https://help.tableau.com/current/api/metadata_api/en-us/reference/inheritedstringresult.doc.html)] - # True if the field is hidden - isHidden: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) - # Name of folder if the field is in a folder. See - # https://onlinehelp.tableau.com/current/pro/desktop/en-us/datafields_dwfeatures.html#Organize - folderName: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # List of fields, if any, that this field references - # - # 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. - fields( - filter: [Field_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/field_filter.doc.html), - orderBy: [FieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Field](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.doc.html)!]! - # List of fields, if any, that this field references - # - # 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. - fieldsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Field_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/field_filter.doc.html), - orderBy: [FieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsconnection.doc.html) - # List of parameters, if any, used in this field - # - # 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. - parameters( - filter: [Parameter_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/parameter_filter.doc.html), - orderBy: [ParameterSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/parametersortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Parameter](https://help.tableau.com/current/api/metadata_api/en-us/reference/parameter.doc.html)!]! - # List of parameters, if any, used in this field - # - # 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. - parametersConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Parameter_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/parameter_filter.doc.html), - orderBy: [ParameterSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/parametersortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [ParametersConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/parametersconnection.doc.html) - # Columns downstream of this field - # - # 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. - downstreamColumns( - filter: [Column_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/column_filter.doc.html), - orderBy: [ColumnSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Column](https://help.tableau.com/current/api/metadata_api/en-us/reference/column.doc.html)!]! - # Columns downstream of this field - # - # 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. - downstreamColumnsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Column_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/column_filter.doc.html), - orderBy: [ColumnSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [ColumnsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnsconnection.doc.html) - # Tables downstream of this field - # - # 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. - downstreamTables( - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DatabaseTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable.doc.html)!]! - # Tables downstream of this field - # - # 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. - downstreamTablesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabaseTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesconnection.doc.html) - # Virtual connection tables downstream of this field - # - # 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/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnectionTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable.doc.html)!]! - # Virtual connection tables downstream of this field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnectionTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesconnection.doc.html) - # Virtual connections downstream of this field - # - # 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. - downstreamVirtualConnections( - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection.doc.html)!]! - # Virtual connections downstream of this field - # - # 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. - downstreamVirtualConnectionsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsconnection.doc.html) - # Databases downstream of this field - # - # 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. - downstreamDatabases( - filter: [Database_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Database](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html)!]! - # Databases downstream of this field - # - # 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. - downstreamDatabasesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Database_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabasesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesconnection.doc.html) - # Flows downstream of this field - # - # 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/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Flow](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow.doc.html)!]! - # Flows downstream of this field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Flow_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FlowsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsconnection.doc.html) - # downstream fields that reference this field - # - # 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. - downstreamFields( - filter: [Field_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/field_filter.doc.html), - orderBy: [FieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Field](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.doc.html)!]! - # downstream fields that reference this field - # - # 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. - downstreamFieldsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Field_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/field_filter.doc.html), - orderBy: [FieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsconnection.doc.html) - # Datasources connected downstream from this field - # - # 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/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[PublishedDatasource](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource.doc.html)!] - # Datasources connected downstream from this field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [PublishedDatasource_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [PublishedDatasourcesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesconnection.doc.html) - # Lenses connected downstream from this field - # - # 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/current/api/metadata_api/en-us/reference/lens_filter.doc.html), - orderBy: [LensSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/lenssortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Lens](https://help.tableau.com/current/api/metadata_api/en-us/reference/lens.doc.html)!] - # Lenses connected downstream from this field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Lens_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/lens_filter.doc.html), - orderBy: [LensSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/lenssortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [LensesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensesconnection.doc.html) - # Sheets connected downstream from the field - # - # 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/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Sheet](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html)!]! - # Sheets connected downstream from the field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Sheet_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [SheetsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsconnection.doc.html) - # Dashboards connected downstream from the field - # - # 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/current/api/metadata_api/en-us/reference/dashboard_filter.doc.html), - orderBy: [DashboardSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboardsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Dashboard](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard.doc.html)!]! - # Dashboards connected downstream from the field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Dashboard_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard_filter.doc.html), - orderBy: [DashboardSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboardsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DashboardsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboardsconnection.doc.html) - # Workbooks connected downstream from the field - # - # 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/current/api/metadata_api/en-us/reference/workbook_filter.doc.html), - orderBy: [WorkbookSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Workbook](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbook.doc.html)!] - # Workbooks connected downstream from the field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Workbook_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbook_filter.doc.html), - orderBy: [WorkbookSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [WorkbooksConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksconnection.doc.html) - # Metrics connected downstream from the field - # - # 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/current/api/metadata_api/en-us/reference/metric_filter.doc.html), - orderBy: [MetricSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Metric](https://help.tableau.com/current/api/metadata_api/en-us/reference/metric.doc.html)!] - # Metrics connected downstream from the field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Metric_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metric_filter.doc.html), - orderBy: [MetricSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [MetricsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricsconnection.doc.html) - # Workbook owners (authors) connected downstream from the field - # - # 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/current/api/metadata_api/en-us/reference/tableauuser_filter.doc.html), - orderBy: [TableauUserSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauusersortorder.doc.html) - ): [[TableauUser](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauuser.doc.html)!] - # Workbook owners (authors) connected downstream from the field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [TableauUser_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauuser_filter.doc.html), - orderBy: [TableauUserSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauusersortorder.doc.html) - ): [TableauUsersConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauusersconnection.doc.html) - # Tables connected upstream from the field - # - # 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/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DatabaseTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable.doc.html)!]! - # Tables connected upstream from the field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabaseTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesconnection.doc.html) - # Virtual connection tables upstream of this field - # - # 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/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnectionTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable.doc.html)!]! - # Virtual connection tables upstream of this field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnectionTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesconnection.doc.html) - # Virtual connections upstream of this field - # - # 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. - upstreamVirtualConnections( - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection.doc.html)!]! - # Virtual connections upstream of this field - # - # 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. - upstreamVirtualConnectionsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsconnection.doc.html) - # Databases connected upstream from the field - # - # 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/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Database](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html)!]! - # Databases connected upstream from the field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Database_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabasesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesconnection.doc.html) - # Flows connected upstream from the field - # - # 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/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Flow](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow.doc.html)!]! - # Flows connected upstream from the field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Flow_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FlowsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsconnection.doc.html) - # Datasources connected upstream from the field - # - # 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/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[PublishedDatasource](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource.doc.html)!]! - # Datasources connected upstream from the field - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [PublishedDatasource_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [PublishedDatasourcesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesconnection.doc.html) - # The field that references this field - # - # 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. - referencedByFields( - filter: [FieldReferencingField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield_filter.doc.html), - orderBy: [FieldReferencingFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[FieldReferencingField](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield.doc.html)] - # The field that references this field - # - # 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. - referencedByFieldsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [FieldReferencingField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield_filter.doc.html), - orderBy: [FieldReferencingFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FieldReferencingFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfieldsconnection.doc.html) - # Data source that contains this field - datasource: [Datasource](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasource.doc.html) - # Metric definitions that reference this data source field. - # - # 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. - metricDefinitions( - filter: [MetricDefinition_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinition_filter.doc.html), - orderBy: [MetricDefinitionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[MetricDefinition](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinition.doc.html)] - # Metric definitions that reference this data source field. - # - # 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. - metricDefinitionsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [MetricDefinition_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinition_filter.doc.html), - orderBy: [MetricDefinitionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [MetricDefinitionsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsconnection.doc.html) - # The data source filters that include this field - # - # 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. - referencedByFilters( - filter: [DatasourceFilter_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefilter_filter.doc.html), - orderBy: [DatasourceFilterSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefiltersortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DatasourceFilter](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefilter.doc.html)] - # The data source filters that include this field - # - # 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. - referencedByFiltersConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DatasourceFilter_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefilter_filter.doc.html), - orderBy: [DatasourceFilterSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefiltersortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatasourceFiltersConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefiltersconnection.doc.html) - # The bin field that references this field - # - # 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. - referencedByBins( - filter: [BinField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/binfield_filter.doc.html), - orderBy: [BinFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/binfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[BinField](https://help.tableau.com/current/api/metadata_api/en-us/reference/binfield.doc.html)] - # The bin field that references this field - # - # 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. - referencedByBinsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [BinField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/binfield_filter.doc.html), - orderBy: [BinFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/binfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [BinFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/binfieldsconnection.doc.html) - # The calculated field that references this field - # - # 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. - referencedByCalculations( - filter: [CalculatedField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/calculatedfield_filter.doc.html), - orderBy: [CalculatedFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/calculatedfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[CalculatedField](https://help.tableau.com/current/api/metadata_api/en-us/reference/calculatedfield.doc.html)] - # The calculated field that references this field - # - # 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. - referencedByCalculationsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [CalculatedField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/calculatedfield_filter.doc.html), - orderBy: [CalculatedFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/calculatedfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [CalculatedFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/calculatedfieldsconnection.doc.html) - # The combined field that references this field - # - # 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. - referencedByCombinedFields( - filter: [CombinedField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedfield_filter.doc.html), - orderBy: [CombinedFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[CombinedField](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedfield.doc.html)] - # The combined field that references this field - # - # 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. - referencedByCombinedFieldsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [CombinedField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedfield_filter.doc.html), - orderBy: [CombinedFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [CombinedFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedfieldsconnection.doc.html) - # Thie combined set field that references this field - # - # 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. - referencedByCombinedSets( - filter: [CombinedSetField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedsetfield_filter.doc.html), - orderBy: [CombinedSetFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedsetfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[CombinedSetField](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedsetfield.doc.html)] - # Thie combined set field that references this field - # - # 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. - referencedByCombinedSetsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [CombinedSetField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedsetfield_filter.doc.html), - orderBy: [CombinedSetFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedsetfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [CombinedSetFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedsetfieldsconnection.doc.html) - # The field that references this remote field - # - # 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. - referencedByRemoteFields( - filter: [DatasourceField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefield_filter.doc.html), - orderBy: [DatasourceFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DatasourceField](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefield.doc.html)] - # The field that references this remote field - # - # 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. - referencedByRemoteFieldsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DatasourceField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefield_filter.doc.html), - orderBy: [DatasourceFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatasourceFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefieldsconnection.doc.html) - # The group field that references this field - # - # 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. - referencedByGroups( - filter: [GroupField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/groupfield_filter.doc.html), - orderBy: [GroupFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/groupfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[GroupField](https://help.tableau.com/current/api/metadata_api/en-us/reference/groupfield.doc.html)] - # The group field that references this field - # - # 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. - referencedByGroupsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [GroupField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/groupfield_filter.doc.html), - orderBy: [GroupFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/groupfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [GroupFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/groupfieldsconnection.doc.html) - # The set field that this field references - # - # 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. - referencedBySets( - filter: [SetField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/setfield_filter.doc.html), - orderBy: [SetFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/setfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[SetField](https://help.tableau.com/current/api/metadata_api/en-us/reference/setfield.doc.html)] - # The set field that this field references - # - # 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. - referencedBySetsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [SetField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/setfield_filter.doc.html), - orderBy: [SetFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/setfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [SetFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/setfieldsconnection.doc.html) - # The hierarchy field that references this field - # - # 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. - referencedByHierarchies( - filter: [HierarchyField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/hierarchyfield_filter.doc.html), - orderBy: [HierarchyFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/hierarchyfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[HierarchyField](https://help.tableau.com/current/api/metadata_api/en-us/reference/hierarchyfield.doc.html)] - # The hierarchy field that references this field - # - # 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. - referencedByHierarchiesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [HierarchyField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/hierarchyfield_filter.doc.html), - orderBy: [HierarchyFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/hierarchyfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [HierarchyFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/hierarchyfieldsconnection.doc.html) - # Sheets that reference this data source field - # - # 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. - sheets( - filter: [Sheet_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Sheet](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html)] - # Sheets that reference this data source field - # - # 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. - sheetsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Sheet_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [SheetsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsconnection.doc.html) - # Sheets that reference this field - # - # 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. - directSheets( - filter: [Sheet_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Sheet](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html)] - # Sheets that reference this field - # - # 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. - directSheetsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Sheet_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [SheetsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsconnection.doc.html) - # List of lens fields which are derived from this field - # - # 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. - derivedLensFields( - filter: [LensField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensfield_filter.doc.html), - orderBy: [LensFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[LensField](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensfield.doc.html)] - # List of lens fields which are derived from this field - # - # 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. - derivedLensFieldsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [LensField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensfield_filter.doc.html), - orderBy: [LensFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [LensFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensfieldsconnection.doc.html) - # A flow input field that wraps this field - # - # 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. - referencedByFlowFieldInputField( - filter: [FlowFieldInputField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfield_filter.doc.html), - orderBy: [FlowFieldInputFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfieldsortorder.doc.html) - ): [[FlowFieldInputField](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfield.doc.html)] - # A flow input field that wraps this field - # - # 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. - referencedByFlowFieldInputFieldConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [FlowFieldInputField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfield_filter.doc.html), - orderBy: [FlowFieldInputFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfieldsortorder.doc.html) - ): [FlowFieldInputFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfieldsconnection.doc.html) - # A flow output field that wraps this field - # - # 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. - referencedByFlowFieldOutputField( - filter: [FlowFieldOutputField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfield_filter.doc.html), - orderBy: [FlowFieldOutputFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[FlowFieldOutputField](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfield.doc.html)] - # A flow output field that wraps this field - # - # 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. - referencedByFlowFieldOutputFieldConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [FlowFieldOutputField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfield_filter.doc.html), - orderBy: [FlowFieldOutputFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FlowFieldOutputFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfieldsconnection.doc.html) - # fields that are upstream of this field - # - # 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. - upstreamFields( - filter: [Field_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/field_filter.doc.html), - orderBy: [FieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Field](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.doc.html)]! - # fields that are upstream of this field - # - # 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. - upstreamFieldsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Field_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/field_filter.doc.html), - orderBy: [FieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsconnection.doc.html) - # Metric definitions downstream from this field. - # - # 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/current/api/metadata_api/en-us/reference/metricdefinition_filter.doc.html), - orderBy: [MetricDefinitionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[MetricDefinition](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinition.doc.html)] - # Metric definitions downstream from this field. - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [MetricDefinition_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinition_filter.doc.html), - orderBy: [MetricDefinitionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [MetricDefinitionsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsconnection.doc.html) - # All upstream columns this field references - # - # 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. - upstreamColumns( - filter: [Column_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/column_filter.doc.html), - orderBy: [ColumnSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Column](https://help.tableau.com/current/api/metadata_api/en-us/reference/column.doc.html)]! - # All upstream columns this field references - # - # 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. - upstreamColumnsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Column_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/column_filter.doc.html), - orderBy: [ColumnSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [ColumnsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnsconnection.doc.html) - } ` ## [_link_](#require-by) Require by - [AnalyticsField_Base GraphQL type for a field containing analytics metadata_](https://help.tableau.com/current/api/metadata_api/en-us/reference/analyticsfield.doc.html "AnalyticsField - Base GraphQL type for a field containing analytics metadata") - [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/current/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/current/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") - [ColumnField_ColumnFields are a type of field which directly connects to a column in some type of table._](https://help.tableau.com/current/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/current/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/current/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") - [DataField_Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField._](https://help.tableau.com/current/api/metadata_api/en-us/reference/datafield.doc.html "DataField - Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField.") - [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/current/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/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [FieldReferencingField_Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula._](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield.doc.html "FieldReferencingField - Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula.") - [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/current/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/current/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") - [Parameter_Tableau Parameter. For more info see https://onlinehelp.tableau.com/current/pro/desktop/en-us/parameters\_create.html_](https://help.tableau.com/current/api/metadata_api/en-us/reference/parameter.doc.html "Parameter - Tableau Parameter. For more info see https://onlinehelp.tableau.com/current/pro/desktop/en-us/parameters_create.html") - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/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/current/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") - [SetFieldsConnection_Connection Type for SetField_](https://help.tableau.com/current/api/metadata_api/en-us/reference/setfieldsconnection.doc.html "SetFieldsConnection - Connection Type for SetField") _menu_ Types INPUT\_OBJECT # SetField\_Filter Filter by GraphQL field and given value ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input SetField_Filter { - # Name shown in server and desktop clients - name: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Name shown in server and desktop clients - nameWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.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/current/api/metadata_api/en-us/reference/id.doc.html) - # Unique identifier used by the metadata API. Not the same as the numeric ID used - # on server - idWithin: [[ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html)] - # True if the field is hidden - isHidden: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) - # True if the field is hidden - isHiddenWithin: [[Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html)] - # Filter the output based on text query. - text: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - } ` ## [_link_](#require-by) Require by - [AnalyticsField_Base GraphQL type for a field containing analytics metadata_](https://help.tableau.com/current/api/metadata_api/en-us/reference/analyticsfield.doc.html "AnalyticsField - Base GraphQL type for a field containing analytics metadata") - [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/current/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/current/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") - [ColumnField_ColumnFields are a type of field which directly connects to a column in some type of table._](https://help.tableau.com/current/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/current/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/current/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") - [DataField_Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField._](https://help.tableau.com/current/api/metadata_api/en-us/reference/datafield.doc.html "DataField - Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField.") - [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/current/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/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [FieldReferencingField_Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula._](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield.doc.html "FieldReferencingField - Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula.") - [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/current/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/current/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") - [Parameter_Tableau Parameter. For more info see https://onlinehelp.tableau.com/current/pro/desktop/en-us/parameters\_create.html_](https://help.tableau.com/current/api/metadata_api/en-us/reference/parameter.doc.html "Parameter - Tableau Parameter. For more info see https://onlinehelp.tableau.com/current/pro/desktop/en-us/parameters_create.html") - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/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/current/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") _menu_ Types INPUT\_OBJECT # SetField\_Required\_Filter Filter by GraphQL field and given value ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input SetField_Required_Filter { - # Name shown in server and desktop clients - name: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Name shown in server and desktop clients - nameWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.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/current/api/metadata_api/en-us/reference/id.doc.html) - # Unique identifier used by the metadata API. Not the same as the numeric ID used - # on server - idWithin: [[ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html)] - } ` ## [_link_](#require-by) Require by This element is not required by anyone _menu_ Types ENUM # SetFieldOrderField Enum for fields that can be used for sorting ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - enum SetFieldOrderField { - # Sort by downstreamSheets count - DOWNSTREAM_SHEETS_COUNT - # Sort by fields count - FIELDS_COUNT - # Sort by id - ID - # Sort by isHidden - IS_HIDDEN - # Sort by name - NAME - } ` ## [_link_](#require-by) Require by - [SetFieldSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/setfieldsortorder.doc.html "SetFieldSortOrder - 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.") _menu_ Types OBJECT # SetFieldsConnection Connection Type for SetField ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type SetFieldsConnection { - # List of nodes - nodes: [[SetField](https://help.tableau.com/current/api/metadata_api/en-us/reference/setfield.doc.html)!]! - # Information for pagination - pageInfo: [PageInfo](https://help.tableau.com/current/api/metadata_api/en-us/reference/pageinfo.doc.html)! - # Total number of objects in connection - totalCount: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html)! - } ` ## [_link_](#require-by) Require by - [AnalyticsField_Base GraphQL type for a field containing analytics metadata_](https://help.tableau.com/current/api/metadata_api/en-us/reference/analyticsfield.doc.html "AnalyticsField - Base GraphQL type for a field containing analytics metadata") - [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/current/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/current/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") - [ColumnField_ColumnFields are a type of field which directly connects to a column in some type of table._](https://help.tableau.com/current/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/current/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/current/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") - [DataField_Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField._](https://help.tableau.com/current/api/metadata_api/en-us/reference/datafield.doc.html "DataField - Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField.") - [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/current/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/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [FieldReferencingField_Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula._](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield.doc.html "FieldReferencingField - Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula.") - [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/current/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/current/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") - [Parameter_Tableau Parameter. For more info see https://onlinehelp.tableau.com/current/pro/desktop/en-us/parameters\_create.html_](https://help.tableau.com/current/api/metadata_api/en-us/reference/parameter.doc.html "Parameter - Tableau Parameter. For more info see https://onlinehelp.tableau.com/current/pro/desktop/en-us/parameters_create.html") - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/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/current/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") _menu_ Types INPUT\_OBJECT # SetFieldSortOrder 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. ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input SetFieldSortOrder { - # GraphQL field to sort on - field: [SetFieldOrderField](https://help.tableau.com/current/api/metadata_api/en-us/reference/setfieldorderfield.doc.html)! - # Order direction to sort output - direction: [OrderDirection](https://help.tableau.com/current/api/metadata_api/en-us/reference/orderdirection.doc.html)! - } ` ## [_link_](#require-by) Require by - [AnalyticsField_Base GraphQL type for a field containing analytics metadata_](https://help.tableau.com/current/api/metadata_api/en-us/reference/analyticsfield.doc.html "AnalyticsField - Base GraphQL type for a field containing analytics metadata") - [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/current/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/current/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") - [ColumnField_ColumnFields are a type of field which directly connects to a column in some type of table._](https://help.tableau.com/current/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/current/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/current/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") - [DataField_Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField._](https://help.tableau.com/current/api/metadata_api/en-us/reference/datafield.doc.html "DataField - Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField.") - [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/current/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/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [FieldReferencingField_Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula._](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield.doc.html "FieldReferencingField - Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula.") - [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/current/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/current/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") - [Parameter_Tableau Parameter. For more info see https://onlinehelp.tableau.com/current/pro/desktop/en-us/parameters\_create.html_](https://help.tableau.com/current/api/metadata_api/en-us/reference/parameter.doc.html "Parameter - Tableau Parameter. For more info see https://onlinehelp.tableau.com/current/pro/desktop/en-us/parameters_create.html") - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/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/current/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") _menu_ Types OBJECT # Sheet A sheet contained in a published workbook. ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type Sheet implements [View](https://help.tableau.com/current/api/metadata_api/en-us/reference/view.doc.html), [Taggable](https://help.tableau.com/current/api/metadata_api/en-us/reference/taggable.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/current/api/metadata_api/en-us/reference/id.doc.html)! - # Name shown in server and desktop clients - name: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Unique ID for the sheet generated for and stored within the workbook, survives - # renames, and is used for internal processes - documentViewId: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Locally unique identifier used for the REST API on the Tableau Server (Blank if - # worksheet is hidden in Workbook) - luid: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)! - # Server path to sheet - path: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Time the sheet was created - createdAt: [DateTime](https://help.tableau.com/current/api/metadata_api/en-us/reference/datetime.doc.html)! - # Time the sheet was updated - updatedAt: [DateTime](https://help.tableau.com/current/api/metadata_api/en-us/reference/datetime.doc.html)! - # Index of view; the order it appears in the workbook - index: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html) - # Tags associated with the view - # - # 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/current/api/metadata_api/en-us/reference/tag_filter.doc.html), orderBy: [TagSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tagsortorder.doc.html)): [[Tag](https://help.tableau.com/current/api/metadata_api/en-us/reference/tag.doc.html)!]! - # Tags associated with the view - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Tag_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/tag_filter.doc.html), - orderBy: [TagSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tagsortorder.doc.html) - ): [TagsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/tagsconnection.doc.html) - # Calculated fields which were created on this sheet, e.g. in the rows or columns - # shelves and which may not be used on other sheets that use this embedded data - # source - # - # 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. - worksheetFields( - filter: [CalculatedField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/calculatedfield_filter.doc.html), - orderBy: [CalculatedFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/calculatedfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[CalculatedField](https://help.tableau.com/current/api/metadata_api/en-us/reference/calculatedfield.doc.html)] - # Calculated fields which were created on this sheet, e.g. in the rows or columns - # shelves and which may not be used on other sheets that use this embedded data - # source - # - # 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. - worksheetFieldsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [CalculatedField_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/calculatedfield_filter.doc.html), - orderBy: [CalculatedFieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/calculatedfieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [CalculatedFieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/calculatedfieldsconnection.doc.html) - # Fields that are contained in an embedded data source and are also referenced by - # the worksheet. If a worksheet uses calculated fields (or any other - # FieldReferencingField), this list will also include all of the referenced - # fields. - # - # 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. - datasourceFields( - filter: [Field_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/field_filter.doc.html), - orderBy: [FieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Field](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.doc.html)] - # Fields that are contained in an embedded data source and are also referenced by - # the worksheet. If a worksheet uses calculated fields (or any other - # FieldReferencingField), this list will also include all of the referenced - # fields. - # - # 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. - datasourceFieldsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Field_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/field_filter.doc.html), - orderBy: [FieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsconnection.doc.html) - # All fields in the collection worksheetFields as well as the fields in - # datasourceFields used directly by this sheet. If the worksheet uses calculated - # fields this list will not include referenced fields that are not directly used - # by the sheet. - # - # 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. - sheetFieldInstances( - filter: [Field_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/field_filter.doc.html), - orderBy: [FieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Field](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.doc.html)] - # All fields in the collection worksheetFields as well as the fields in - # datasourceFields used directly by this sheet. If the worksheet uses calculated - # fields this list will not include referenced fields that are not directly used - # by the sheet. - # - # 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. - sheetFieldInstancesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Field_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/field_filter.doc.html), - orderBy: [FieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsconnection.doc.html) - # Data quality warnings upstream from this sheet - # - # 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/current/api/metadata_api/en-us/reference/dataqualitywarning_filter.doc.html), - orderBy: [DataQualityWarningSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarningsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DataQualityWarning](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarning.doc.html)!]! - # Data quality warnings upstream from this sheet - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DataQualityWarning_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarning_filter.doc.html), - orderBy: [DataQualityWarningSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarningsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DataQualityWarningsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarningsconnection.doc.html) - # Labels upstream from this sheet. 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/current/api/metadata_api/en-us/reference/label_filter.doc.html), - orderBy: [LabelSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/labelsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Label](https://help.tableau.com/current/api/metadata_api/en-us/reference/label.doc.html)!]! - # Labels upstream from this sheet. 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Label_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/label_filter.doc.html), - orderBy: [LabelSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/labelsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [LabelsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/labelsconnection.doc.html) - # Parent embedded data source of this sheet - # - # 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. - parentEmbeddedDatasources( - filter: [EmbeddedDatasource_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/embeddeddatasource_filter.doc.html), - orderBy: [EmbeddedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/embeddeddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[EmbeddedDatasource](https://help.tableau.com/current/api/metadata_api/en-us/reference/embeddeddatasource.doc.html)!]! - # Parent embedded data source of this sheet - # - # 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. - parentEmbeddedDatasourcesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [EmbeddedDatasource_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/embeddeddatasource_filter.doc.html), - orderBy: [EmbeddedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/embeddeddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [EmbeddedDatasourcesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/embeddeddatasourcesconnection.doc.html) - # The workbook that contains this view - workbook: [Workbook](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbook.doc.html) - # Dashboards that contain this sheet - # - # 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. - containedInDashboards( - filter: [Dashboard_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard_filter.doc.html), - orderBy: [DashboardSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboardsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Dashboard](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard.doc.html)] - # Dashboards that contain this sheet - # - # 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. - containedInDashboardsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Dashboard_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard_filter.doc.html), - orderBy: [DashboardSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboardsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DashboardsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboardsconnection.doc.html) - # The Metrics that reference this View - # - # 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. - referencedByMetrics( - filter: [Metric_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metric_filter.doc.html), - orderBy: [MetricSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Metric](https://help.tableau.com/current/api/metadata_api/en-us/reference/metric.doc.html)] - # The Metrics that reference this View - # - # 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. - referencedByMetricsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Metric_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metric_filter.doc.html), - orderBy: [MetricSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [MetricsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricsconnection.doc.html) - # The fields that are upstream of this sheet - # - # 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. - upstreamFields( - filter: [Field_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/field_filter.doc.html), - orderBy: [FieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Field](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.doc.html)]! - # The fields that are upstream of this sheet - # - # 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. - upstreamFieldsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Field_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/field_filter.doc.html), - orderBy: [FieldSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FieldsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldsconnection.doc.html) - # The data sources that are upstream of this sheet - # - # 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: [Datasource_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasource_filter.doc.html), - orderBy: [DatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Datasource](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasource.doc.html)] - # The data sources that are upstream of this sheet - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Datasource_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasource_filter.doc.html), - orderBy: [DatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatasourcesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcesconnection.doc.html) - # The tables that are upstream of this sheet - # - # 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: [Table_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/table_filter.doc.html), - orderBy: [TableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Table](https://help.tableau.com/current/api/metadata_api/en-us/reference/table.doc.html)] - # The tables that are upstream of this sheet - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Table_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/table_filter.doc.html), - orderBy: [TableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [TablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/tablesconnection.doc.html) - # The databases that are upstream of this sheet - # - # 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/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Database](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html)] - # The databases that are upstream of this sheet - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Database_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabasesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesconnection.doc.html) - # The columns that are upstream of this sheet - # - # 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. - upstreamColumns( - filter: [Column_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/column_filter.doc.html), - orderBy: [ColumnSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Column](https://help.tableau.com/current/api/metadata_api/en-us/reference/column.doc.html)]! - # The columns that are upstream of this sheet - # - # 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. - upstreamColumnsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Column_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/column_filter.doc.html), - orderBy: [ColumnSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [ColumnsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnsconnection.doc.html) - # The flows that are upstream of this sheet - # - # 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/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Flow](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow.doc.html)] - # The flows that are upstream of this sheet - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Flow_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FlowsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsconnection.doc.html) - } ` ## [_link_](#require-by) Require by - [AnalyticsField_Base GraphQL type for a field containing analytics metadata_](https://help.tableau.com/current/api/metadata_api/en-us/reference/analyticsfield.doc.html "AnalyticsField - Base GraphQL type for a field containing analytics metadata") - [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/current/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/current/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/current/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/current/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/current/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/current/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/current/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/current/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.") - [Dashboard_A dashboard contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard.doc.html "Dashboard - A dashboard contained in a published workbook.") - [Database_A database containing tables_](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html "Database - A database containing tables") - [DatabaseServer_A database server connection_](https://help.tableau.com/current/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/current/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.*") - [DataField_Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField._](https://help.tableau.com/current/api/metadata_api/en-us/reference/datafield.doc.html "DataField - Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField.") - [Datasource_Root GraphQL type for embedded and published data sources Data sources are a way to represent how Tableau Desktop and Tableau Server model and connect to data. Data sources can be published separately, as a published data source, or may be contained in a workbook as an embedded data source. See https://onlinehelp.tableau.com/current/server/en-us/datasource.htm_](datasource.doc.html "Datasource - Root GraphQL type for embedded and published data sources Data sources are a way to represent how Tableau Desktop and Tableau Server model and connect to data. Data sources can be published separately, as a published data source, or may be contained in a workbook as an embedded data source. See https://onlinehelp.tableau.com/current/server/en-us/datasource.htm") - [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/current/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.") - [EmbeddedDatasource_A data source embedded in a workbook_](https://help.tableau.com/current/api/metadata_api/en-us/reference/embeddeddatasource.doc.html "EmbeddedDatasource - A data source embedded in a workbook") - [Field_Base GraphQL type for a field_](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [FieldReferencingField_Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula._](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield.doc.html "FieldReferencingField - Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula.") - [File_A file connection_](https://help.tableau.com/current/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/current/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/current/api/metadata_api/en-us/reference/flowcolumnoutputfield.doc.html "FlowColumnOutputField - Column output field implementation") - [FlowFieldOutputField_Field output field implementation_](https://help.tableau.com/current/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/current/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/current/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/current/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") - [PublishedDatasource_A Tableau data source that has been published separately to Tableau Server. It can be used by multiple workbooks._](https://help.tableau.com/current/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/current/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/current/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") - [SheetsConnection_Connection Type for Sheet_](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsconnection.doc.html "SheetsConnection - Connection Type for Sheet") - [Table_A table containing columns_](https://help.tableau.com/current/api/metadata_api/en-us/reference/table.doc.html "Table - A table containing columns") - [VirtualConnection_A virtual connection. \*Available in Tableau Cloud March 2022 / Server 2022.1 and later.\*_](virtualconnection.doc.html "VirtualConnection - A virtual connection. *Available in Tableau Cloud March 2022 / Server 2022.1 and later.*") - [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/current/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/current/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).") _menu_ Types INPUT\_OBJECT # Sheet\_Filter Filter by GraphQL field and given value ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input Sheet_Filter { - # Server path to sheet - path: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Server path to sheet - pathWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)] - # Locally unique identifier used for the REST API on the Tableau Server (Blank if - # worksheet is hidden in Workbook) - luid: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Locally unique identifier used for the REST API on the Tableau Server (Blank if - # worksheet is hidden in Workbook) - luidWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)] - # Unique ID for the sheet generated for and stored within the workbook, survives - # renames, and is used for internal processes - documentViewId: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Unique ID for the sheet generated for and stored within the workbook, survives - # renames, and is used for internal processes - documentViewIdWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)] - # Name shown in server and desktop clients - name: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Name shown in server and desktop clients - nameWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.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/current/api/metadata_api/en-us/reference/id.doc.html) - # Unique identifier used by the metadata API. Not the same as the numeric ID used - # on server - idWithin: [[ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html)] - } ` ## [_link_](#require-by) Require by - [AnalyticsField_Base GraphQL type for a field containing analytics metadata_](https://help.tableau.com/current/api/metadata_api/en-us/reference/analyticsfield.doc.html "AnalyticsField - Base GraphQL type for a field containing analytics metadata") - [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/current/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/current/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/current/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/current/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/current/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/current/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/current/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/current/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.") - [Dashboard_A dashboard contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard.doc.html "Dashboard - A dashboard contained in a published workbook.") - [Database_A database containing tables_](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html "Database - A database containing tables") - [DatabaseServer_A database server connection_](https://help.tableau.com/current/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/current/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.*") - [DataField_Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField._](https://help.tableau.com/current/api/metadata_api/en-us/reference/datafield.doc.html "DataField - Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField.") - [Datasource_Root GraphQL type for embedded and published data sources Data sources are a way to represent how Tableau Desktop and Tableau Server model and connect to data. Data sources can be published separately, as a published data source, or may be contained in a workbook as an embedded data source. See https://onlinehelp.tableau.com/current/server/en-us/datasource.htm_](datasource.doc.html "Datasource - Root GraphQL type for embedded and published data sources Data sources are a way to represent how Tableau Desktop and Tableau Server model and connect to data. Data sources can be published separately, as a published data source, or may be contained in a workbook as an embedded data source. See https://onlinehelp.tableau.com/current/server/en-us/datasource.htm") - [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/current/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.") - [EmbeddedDatasource_A data source embedded in a workbook_](https://help.tableau.com/current/api/metadata_api/en-us/reference/embeddeddatasource.doc.html "EmbeddedDatasource - A data source embedded in a workbook") - [Field_Base GraphQL type for a field_](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [FieldReferencingField_Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula._](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield.doc.html "FieldReferencingField - Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula.") - [File_A file connection_](https://help.tableau.com/current/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/current/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/current/api/metadata_api/en-us/reference/flowcolumnoutputfield.doc.html "FlowColumnOutputField - Column output field implementation") - [FlowFieldOutputField_Field output field implementation_](https://help.tableau.com/current/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/current/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/current/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/current/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") - [PublishedDatasource_A Tableau data source that has been published separately to Tableau Server. It can be used by multiple workbooks._](https://help.tableau.com/current/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/current/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/current/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/current/api/metadata_api/en-us/reference/table.doc.html "Table - A table containing columns") - [VirtualConnection_A virtual connection. \*Available in Tableau Cloud March 2022 / Server 2022.1 and later.\*_](virtualconnection.doc.html "VirtualConnection - A virtual connection. *Available in Tableau Cloud March 2022 / Server 2022.1 and later.*") - [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/current/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/current/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).") _menu_ Types ENUM # SheetOrderField Enum for fields that can be used for sorting ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - enum SheetOrderField { - # Sort by datasourceFields count - DATASOURCE_FIELDS_COUNT - # Sort by sheetFieldInstances count - SHEET_FIELD_INSTANCES_COUNT - # Sort by worksheetFields count - WORKSHEET_FIELDS_COUNT - # Sort by documentViewId - DOCUMENT_VIEW_ID - # Sort by id - ID - # Sort by luid - LUID - # Sort by name - NAME - # Sort by path - PATH - } ` ## [_link_](#require-by) Require by - [SheetSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html "SheetSortOrder - 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.") _menu_ Types OBJECT # SheetsConnection Connection Type for Sheet ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type SheetsConnection { - # List of nodes - nodes: [[Sheet](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html)!]! - # Information for pagination - pageInfo: [PageInfo](https://help.tableau.com/current/api/metadata_api/en-us/reference/pageinfo.doc.html)! - # Total number of objects in connection - totalCount: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html)! - } ` ## [_link_](#require-by) Require by - [AnalyticsField_Base GraphQL type for a field containing analytics metadata_](https://help.tableau.com/current/api/metadata_api/en-us/reference/analyticsfield.doc.html "AnalyticsField - Base GraphQL type for a field containing analytics metadata") - [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/current/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/current/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/current/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/current/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/current/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/current/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/current/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/current/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.") - [Dashboard_A dashboard contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard.doc.html "Dashboard - A dashboard contained in a published workbook.") - [Database_A database containing tables_](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html "Database - A database containing tables") - [DatabaseServer_A database server connection_](https://help.tableau.com/current/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/current/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.*") - [DataField_Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField._](https://help.tableau.com/current/api/metadata_api/en-us/reference/datafield.doc.html "DataField - Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField.") - [Datasource_Root GraphQL type for embedded and published data sources Data sources are a way to represent how Tableau Desktop and Tableau Server model and connect to data. Data sources can be published separately, as a published data source, or may be contained in a workbook as an embedded data source. See https://onlinehelp.tableau.com/current/server/en-us/datasource.htm_](datasource.doc.html "Datasource - Root GraphQL type for embedded and published data sources Data sources are a way to represent how Tableau Desktop and Tableau Server model and connect to data. Data sources can be published separately, as a published data source, or may be contained in a workbook as an embedded data source. See https://onlinehelp.tableau.com/current/server/en-us/datasource.htm") - [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/current/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.") - [EmbeddedDatasource_A data source embedded in a workbook_](https://help.tableau.com/current/api/metadata_api/en-us/reference/embeddeddatasource.doc.html "EmbeddedDatasource - A data source embedded in a workbook") - [Field_Base GraphQL type for a field_](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [FieldReferencingField_Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula._](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield.doc.html "FieldReferencingField - Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula.") - [File_A file connection_](https://help.tableau.com/current/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/current/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/current/api/metadata_api/en-us/reference/flowcolumnoutputfield.doc.html "FlowColumnOutputField - Column output field implementation") - [FlowFieldOutputField_Field output field implementation_](https://help.tableau.com/current/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/current/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/current/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/current/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") - [PublishedDatasource_A Tableau data source that has been published separately to Tableau Server. It can be used by multiple workbooks._](https://help.tableau.com/current/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/current/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/current/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/current/api/metadata_api/en-us/reference/table.doc.html "Table - A table containing columns") - [VirtualConnection_A virtual connection. \*Available in Tableau Cloud March 2022 / Server 2022.1 and later.\*_](virtualconnection.doc.html "VirtualConnection - A virtual connection. *Available in Tableau Cloud March 2022 / Server 2022.1 and later.*") - [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/current/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/current/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).") _menu_ Types INPUT\_OBJECT # SheetSortOrder 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. ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input SheetSortOrder { - # GraphQL field to sort on - field: [SheetOrderField](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetorderfield.doc.html)! - # Order direction to sort output - direction: [OrderDirection](https://help.tableau.com/current/api/metadata_api/en-us/reference/orderdirection.doc.html)! - } ` ## [_link_](#require-by) Require by - [AnalyticsField_Base GraphQL type for a field containing analytics metadata_](https://help.tableau.com/current/api/metadata_api/en-us/reference/analyticsfield.doc.html "AnalyticsField - Base GraphQL type for a field containing analytics metadata") - [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/current/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/current/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/current/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/current/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/current/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/current/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/current/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/current/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.") - [Dashboard_A dashboard contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard.doc.html "Dashboard - A dashboard contained in a published workbook.") - [Database_A database containing tables_](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html "Database - A database containing tables") - [DatabaseServer_A database server connection_](https://help.tableau.com/current/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/current/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.*") - [DataField_Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField._](https://help.tableau.com/current/api/metadata_api/en-us/reference/datafield.doc.html "DataField - Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField.") - [Datasource_Root GraphQL type for embedded and published data sources Data sources are a way to represent how Tableau Desktop and Tableau Server model and connect to data. Data sources can be published separately, as a published data source, or may be contained in a workbook as an embedded data source. See https://onlinehelp.tableau.com/current/server/en-us/datasource.htm_](datasource.doc.html "Datasource - Root GraphQL type for embedded and published data sources Data sources are a way to represent how Tableau Desktop and Tableau Server model and connect to data. Data sources can be published separately, as a published data source, or may be contained in a workbook as an embedded data source. See https://onlinehelp.tableau.com/current/server/en-us/datasource.htm") - [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/current/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.") - [EmbeddedDatasource_A data source embedded in a workbook_](https://help.tableau.com/current/api/metadata_api/en-us/reference/embeddeddatasource.doc.html "EmbeddedDatasource - A data source embedded in a workbook") - [Field_Base GraphQL type for a field_](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [FieldReferencingField_Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula._](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield.doc.html "FieldReferencingField - Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula.") - [File_A file connection_](https://help.tableau.com/current/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/current/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/current/api/metadata_api/en-us/reference/flowcolumnoutputfield.doc.html "FlowColumnOutputField - Column output field implementation") - [FlowFieldOutputField_Field output field implementation_](https://help.tableau.com/current/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/current/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/current/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/current/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") - [PublishedDatasource_A Tableau data source that has been published separately to Tableau Server. It can be used by multiple workbooks._](https://help.tableau.com/current/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/current/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/current/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/current/api/metadata_api/en-us/reference/table.doc.html "Table - A table containing columns") - [VirtualConnection_A virtual connection. \*Available in Tableau Cloud March 2022 / Server 2022.1 and later.\*_](virtualconnection.doc.html "VirtualConnection - A virtual connection. *Available in Tableau Cloud March 2022 / Server 2022.1 and later.*") - [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/current/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/current/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).") _menu_ Types # skip Directs the executor to skip this field or fragment when the `if` argument is true. ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - directive @skip(if: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html)!) on FIELD | FRAGMENT_SPREAD | INLINE_FRAGMENT ` ## [_link_](#require-by) Require by This element is not required by anyone _menu_ Types # specifiedBy Exposes a URL that specifies the behaviour of this scalar. ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - directive @specifiedBy(url: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)!) on SCALAR ` ## [_link_](#require-by) Require by This element is not required by anyone _menu_ Types SCALAR # String Built-in String ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - scalar String ` ## [_link_](#require-by) Require by - [AnalyticsField_Base GraphQL type for a field containing analytics metadata_](https://help.tableau.com/current/api/metadata_api/en-us/reference/analyticsfield.doc.html "AnalyticsField - Base GraphQL type for a field containing analytics metadata") - [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/current/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") - [BinField\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/binfield_filter.doc.html "BinField_Filter - Filter by GraphQL field and given value") - [BinField\_Required\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/binfield_required_filter.doc.html "BinField_Required_Filter - Filter by GraphQL field and given value") - [CalculatedField_GraphQL type for a calculated field. See https://onlinehelp.tableau.com/current/pro/desktop/en-us/calculations\_calculatedfields.html_](https://help.tableau.com/current/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") - [CalculatedField\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/calculatedfield_filter.doc.html "CalculatedField_Filter - Filter by GraphQL field and given value") - [CalculatedField\_Required\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/calculatedfield_required_filter.doc.html "CalculatedField_Required_Filter - Filter by GraphQL field and given value") - [CanHaveLabels_A content item that can have labels. \*Available in Tableau Cloud March 2023 / Server 2023.1 and later.\*_](canhavelabels.doc.html "CanHaveLabels - A content item that can have labels. *Available in Tableau Cloud March 2023 / Server 2023.1 and later.*") - [CanHaveLabels\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/canhavelabels_filter.doc.html "CanHaveLabels_Filter - Filter by GraphQL field and given value") - [Certifiable_A content item that can be certified_](https://help.tableau.com/current/api/metadata_api/en-us/reference/certifiable.doc.html "Certifiable - A content item that can be certified") - [Certifiable\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/certifiable_filter.doc.html "Certifiable_Filter - Filter by GraphQL field and given value") - [CloudFile_A cloud file connection_](https://help.tableau.com/current/api/metadata_api/en-us/reference/cloudfile.doc.html "CloudFile - A cloud file connection") - [CloudFile\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/cloudfile_filter.doc.html "CloudFile_Filter - Filter by GraphQL field and given value") - [Column_GraphQL type for a table column_](https://help.tableau.com/current/api/metadata_api/en-us/reference/column.doc.html "Column - GraphQL type for a table column") - [Column\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/column_filter.doc.html "Column_Filter - Filter by GraphQL field and given value") - [Column\_Required\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/column_required_filter.doc.html "Column_Required_Filter - Filter by GraphQL field and given value") - [ColumnField_ColumnFields are a type of field which directly connects to a column in some type of table._](https://help.tableau.com/current/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.") - [ColumnField\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnfield_filter.doc.html "ColumnField_Filter - Filter by GraphQL field and given value") - [ColumnField\_Required\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnfield_required_filter.doc.html "ColumnField_Required_Filter - Filter by GraphQL field and given value") - [CombinedField_GraphQL type for a combined field. Combined fields concatanate fields together into one string._](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedfield.doc.html "CombinedField - GraphQL type for a combined field. Combined fields concatanate fields together into one string.") - [CombinedField\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedfield_filter.doc.html "CombinedField_Filter - Filter by GraphQL field and given value") - [CombinedField\_Required\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedfield_required_filter.doc.html "CombinedField_Required_Filter - Filter by GraphQL field and given value") - [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/current/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") - [CombinedSetField\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedsetfield_filter.doc.html "CombinedSetField_Filter - Filter by GraphQL field and given value") - [CombinedSetField\_Required\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/combinedsetfield_required_filter.doc.html "CombinedSetField_Required_Filter - Filter by GraphQL field and given value") - [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/current/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.") - [CustomSQLTable\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/customsqltable_filter.doc.html "CustomSQLTable_Filter - Filter by GraphQL field and given value") - [Dashboard_A dashboard contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard.doc.html "Dashboard - A dashboard contained in a published workbook.") - [Dashboard\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard_filter.doc.html "Dashboard_Filter - Filter by GraphQL field and given value") - [Database_A database containing tables_](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html "Database - A database containing tables") - [Database\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/database_filter.doc.html "Database_Filter - Filter by GraphQL field and given value") - [DatabaseServer_A database server connection_](https://help.tableau.com/current/api/metadata_api/en-us/reference/databaseserver.doc.html "DatabaseServer - A database server connection") - [DatabaseServer\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/databaseserver_filter.doc.html "DatabaseServer_Filter - Filter by GraphQL field and given value") - [DatabaseTable_A table that is contained in a database_](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable.doc.html "DatabaseTable - A table that is contained in a database") - [DatabaseTable\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html "DatabaseTable_Filter - Filter by GraphQL field and given value") - [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.*") - [DataCloud\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/datacloud_filter.doc.html "DataCloud_Filter - Filter by GraphQL field and given value") - [DataField_Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField._](https://help.tableau.com/current/api/metadata_api/en-us/reference/datafield.doc.html "DataField - Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField.") - [DataQualityCertification_A data quality certification associated with a content item_](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitycertification.doc.html "DataQualityCertification - A data quality certification associated with a content item") - [DataQualityCertification\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitycertification_filter.doc.html "DataQualityCertification_Filter - Filter by GraphQL field and given value") - [DataQualityWarning_A data quality warning associated with a content item_](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarning.doc.html "DataQualityWarning - A data quality warning associated with a content item") - [DataQualityWarning\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarning_filter.doc.html "DataQualityWarning_Filter - Filter by GraphQL field and given value") - [Datasource_Root GraphQL type for embedded and published data sources Data sources are a way to represent how Tableau Desktop and Tableau Server model and connect to data. Data sources can be published separately, as a published data source, or may be contained in a workbook as an embedded data source. See https://onlinehelp.tableau.com/current/server/en-us/datasource.htm_](datasource.doc.html "Datasource - Root GraphQL type for embedded and published data sources Data sources are a way to represent how Tableau Desktop and Tableau Server model and connect to data. Data sources can be published separately, as a published data source, or may be contained in a workbook as an embedded data source. See https://onlinehelp.tableau.com/current/server/en-us/datasource.htm") - [Datasource\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasource_filter.doc.html "Datasource_Filter - Filter by GraphQL field and given value") - [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/current/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.") - [DatasourceField\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefield_filter.doc.html "DatasourceField_Filter - Filter by GraphQL field and given value") - [DatasourceField\_Required\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/datasourcefield_required_filter.doc.html "DatasourceField_Required_Filter - Filter by GraphQL field and given value") - [EmbeddedDatasource_A data source embedded in a workbook_](https://help.tableau.com/current/api/metadata_api/en-us/reference/embeddeddatasource.doc.html "EmbeddedDatasource - A data source embedded in a workbook") - [EmbeddedDatasource\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/embeddeddatasource_filter.doc.html "EmbeddedDatasource_Filter - Filter by GraphQL field and given value") - [Field_Base GraphQL type for a field_](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [Field\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/field_filter.doc.html "Field_Filter - Filter by GraphQL field and given value") - [Field\_Required\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/field_required_filter.doc.html "Field_Required_Filter - Filter by GraphQL field and given value") - [FieldReferencingField_Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula._](https://help.tableau.com/current/api/metadata_api/en-us/reference/fieldreferencingfield.doc.html "FieldReferencingField - Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula.") - [File_A file connection_](https://help.tableau.com/current/api/metadata_api/en-us/reference/file.doc.html "File - A file connection") - [File\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/file_filter.doc.html "File_Filter - Filter by GraphQL field and given value") - [Flow_Flows are used to prepare data, which can include aggregation, cleaning, preprocessing, etc._](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow.doc.html "Flow - Flows are used to prepare data, which can include aggregation, cleaning, preprocessing, etc.") - [Flow\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow_filter.doc.html "Flow_Filter - Filter by GraphQL field and given value") - [FlowColumnInputField_Column input field implementation_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowcolumninputfield.doc.html "FlowColumnInputField - Column input field implementation") - [FlowColumnInputField\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowcolumninputfield_filter.doc.html "FlowColumnInputField_Filter - Filter by GraphQL field and given value") - [FlowColumnOutputField_Column output field implementation_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowcolumnoutputfield.doc.html "FlowColumnOutputField - Column output field implementation") - [FlowColumnOutputField\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowcolumnoutputfield_filter.doc.html "FlowColumnOutputField_Filter - Filter by GraphQL field and given value") - [FlowFieldInputField_Field input field implementation_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfield.doc.html "FlowFieldInputField - Field input field implementation") - [FlowFieldInputField\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldinputfield_filter.doc.html "FlowFieldInputField_Filter - Filter by GraphQL field and given value") - [FlowFieldOutputField_Field output field implementation_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfield.doc.html "FlowFieldOutputField - Field output field implementation") - [FlowFieldOutputField\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowfieldoutputfield_filter.doc.html "FlowFieldOutputField_Filter - Filter by GraphQL field and given value") - [FlowInputField_A wrapper for an input field contained in a published flow._](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowinputfield.doc.html "FlowInputField - A wrapper for an input field contained in a published flow.") - [FlowInputField\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowinputfield_filter.doc.html "FlowInputField_Filter - Filter by GraphQL field and given value") - [FlowOutputField_A wrapper for an output field contained in a published flow._](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowoutputfield.doc.html "FlowOutputField - A wrapper for an output field contained in a published flow.") - [FlowOutputField\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowoutputfield_filter.doc.html "FlowOutputField_Filter - Filter by GraphQL field and given value") - [FlowOutputStep_A flow output step_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowoutputstep.doc.html "FlowOutputStep - A flow output step") - [FlowOutputStep\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowoutputstep_filter.doc.html "FlowOutputStep_Filter - Filter by GraphQL field and given value") - [GenericLabel_A label that can be attached to assets. \*Available in Tableau Cloud March 2023 / Server 2023.1 and later.\*_](genericlabel.doc.html "GenericLabel - A label that can be attached to assets. *Available in Tableau Cloud March 2023 / Server 2023.1 and later.*") - [GenericLabel\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/genericlabel_filter.doc.html "GenericLabel_Filter - Filter by GraphQL field and given value") - [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/current/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") - [GroupField\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/groupfield_filter.doc.html "GroupField_Filter - Filter by GraphQL field and given value") - [GroupField\_Required\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/groupfield_required_filter.doc.html "GroupField_Required_Filter - Filter by GraphQL field and given value") - [HierarchyField_GraphQL type for a hierarchy. See https://onlinehelp.tableau.com/current/pro/desktop/en-us/qs\_hierarchies.html_](https://help.tableau.com/current/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") - [HierarchyField\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/hierarchyfield_filter.doc.html "HierarchyField_Filter - Filter by GraphQL field and given value") - [HierarchyField\_Required\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/hierarchyfield_required_filter.doc.html "HierarchyField_Required_Filter - Filter by GraphQL field and given value") - [InheritedStringResult_Wrapper type containing the inherited result_](https://help.tableau.com/current/api/metadata_api/en-us/reference/inheritedstringresult.doc.html "InheritedStringResult - Wrapper type containing the inherited result") - [Label_A label that can be attached to assets. \*Available in Tableau Cloud March 2023 / Server 2023.1 and later.\*_](label.doc.html "Label - A label that can be attached to assets. *Available in Tableau Cloud March 2023 / Server 2023.1 and later.*") - [Label\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/label_filter.doc.html "Label_Filter - Filter by GraphQL field and given value") - [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.*") - [Lens\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/lens_filter.doc.html "Lens_Filter - Filter by GraphQL field and given value") - [LensField_Lens Fields contain extra information based on an underlying datasource field_](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensfield.doc.html "LensField - Lens Fields contain extra information based on an underlying datasource field") - [LensField\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensfield_filter.doc.html "LensField_Filter - Filter by GraphQL field and given value") - [LinkedFlow_Wrapper type including edge information_](https://help.tableau.com/current/api/metadata_api/en-us/reference/linkedflow.doc.html "LinkedFlow - Wrapper type including edge information") - [Metric_Metrics are time series data constructed from fields contained in views. \*Retired in Tableau Cloud February 2024 / Server 2024.2.\*_](metric.doc.html "Metric - Metrics are time series data constructed from fields contained in views. *Retired in Tableau Cloud February 2024 / Server 2024.2.*") - [Metric\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/metric_filter.doc.html "Metric_Filter - Filter by GraphQL field and given value") - [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.*") - [MetricDefinition\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinition_filter.doc.html "MetricDefinition_Filter - Filter by GraphQL field and given value") - [PageInfo_Information about pagination in a connection_](https://help.tableau.com/current/api/metadata_api/en-us/reference/pageinfo.doc.html "PageInfo - Information about pagination in a connection") - [Parameter_Tableau Parameter. For more info see https://onlinehelp.tableau.com/current/pro/desktop/en-us/parameters\_create.html_](https://help.tableau.com/current/api/metadata_api/en-us/reference/parameter.doc.html "Parameter - Tableau Parameter. For more info see https://onlinehelp.tableau.com/current/pro/desktop/en-us/parameters_create.html") - [Parameter\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/parameter_filter.doc.html "Parameter_Filter - Filter by GraphQL field and given value") - [PublishedDatasource_A Tableau data source that has been published separately to Tableau Server. It can be used by multiple workbooks._](https://help.tableau.com/current/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.") - [PublishedDatasource\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html "PublishedDatasource_Filter - Filter by GraphQL field and given value") - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/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/current/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") - [SetField\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/setfield_filter.doc.html "SetField_Filter - Filter by GraphQL field and given value") - [SetField\_Required\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/setfield_required_filter.doc.html "SetField_Required_Filter - Filter by GraphQL field and given value") - [Sheet_A sheet contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html "Sheet - A sheet contained in a published workbook.") - [Sheet\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet_filter.doc.html "Sheet_Filter - Filter by GraphQL field and given value") - [Table_A table containing columns_](https://help.tableau.com/current/api/metadata_api/en-us/reference/table.doc.html "Table - A table containing columns") - [Table\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/table_filter.doc.html "Table_Filter - Filter by GraphQL field and given value") - [TableAdditionalDetails_Additional details for the DatabaseTable type \*Available in Tableau Cloud February 2024 / Server 2024.2 and later.\*_](tableadditionaldetails.doc.html "TableAdditionalDetails - Additional details for the DatabaseTable type *Available in Tableau Cloud February 2024 / Server 2024.2 and later.*") - [TableauSite_Site on Tableau server_](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableausite.doc.html "TableauSite - Site on Tableau server") - [TableauSite\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableausite_filter.doc.html "TableauSite_Filter - Filter by GraphQL field and given value") - [TableauUser_User on a site on Tableau server_](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauuser.doc.html "TableauUser - User on a site on Tableau server") - [TableauUser\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauuser_filter.doc.html "TableauUser_Filter - Filter by GraphQL field and given value") - [Tag_A tag associated with content items_](https://help.tableau.com/current/api/metadata_api/en-us/reference/tag.doc.html "Tag - A tag associated with content items") - [Tag\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/tag_filter.doc.html "Tag_Filter - Filter by GraphQL field and given value") - [Taggable_A content item that has a list of tags_](https://help.tableau.com/current/api/metadata_api/en-us/reference/taggable.doc.html "Taggable - A content item that has a list of tags") - [Taggable\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/taggable_filter.doc.html "Taggable_Filter - Filter by GraphQL field and given value") - [View_A view contained in a published workbook. Views can be sheets or dashboards._](https://help.tableau.com/current/api/metadata_api/en-us/reference/view.doc.html "View - A view contained in a published workbook. Views can be sheets or dashboards.") - [View\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/view_filter.doc.html "View_Filter - Filter by GraphQL field and given value") - [VirtualConnection_A virtual connection. \*Available in Tableau Cloud March 2022 / Server 2022.1 and later.\*_](virtualconnection.doc.html "VirtualConnection - A virtual connection. *Available in Tableau Cloud March 2022 / Server 2022.1 and later.*") - [VirtualConnection\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html "VirtualConnection_Filter - Filter by GraphQL field and given value") - [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.*") - [VirtualConnectionTable\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html "VirtualConnectionTable_Filter - Filter by GraphQL field and given value") - [Warnable_A content item that can have data quality warnings_](https://help.tableau.com/current/api/metadata_api/en-us/reference/warnable.doc.html "Warnable - A content item that can have data quality warnings") - [Warnable\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/warnable_filter.doc.html "Warnable_Filter - Filter by GraphQL field and given value") - [WebDataConnector_A web data connector_](https://help.tableau.com/current/api/metadata_api/en-us/reference/webdataconnector.doc.html "WebDataConnector - A web data connector") - [WebDataConnector\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/webdataconnector_filter.doc.html "WebDataConnector_Filter - Filter by GraphQL field and given value") - [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/current/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).") - [Workbook\_Filter_Filter by GraphQL field and given value_](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbook_filter.doc.html "Workbook_Filter - Filter by GraphQL field and given value") - [\_\_Directive_null_](https://help.tableau.com/current/api/metadata_api/en-us/reference/directive.spec.html "__Directive - ") - [\_\_EnumValue_null_](https://help.tableau.com/current/api/metadata_api/en-us/reference/enumvalue.spec.html "__EnumValue - ") - [\_\_Field_null_](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.spec.html "__Field - ") - [\_\_InputValue_null_](https://help.tableau.com/current/api/metadata_api/en-us/reference/inputvalue.spec.html "__InputValue - ") - [\_\_Schema_A GraphQL Introspection defines the capabilities of a GraphQL server. It exposes all available types and directives on the server, the entry points for query, mutation, and subscription operations._](https://help.tableau.com/current/api/metadata_api/en-us/reference/schema.spec.html "__Schema - A GraphQL Introspection defines the capabilities of a GraphQL server. It exposes all available types and directives on the server, the entry points for query, mutation, and subscription operations.") - [\_\_Type_null_](https://help.tableau.com/current/api/metadata_api/en-us/reference/type.spec.html "__Type - ") _menu_ Types INTERFACE # Table A table containing columns ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - interface Table { - # Unique identifier used by the metadata API. Not the same as the numeric ID used - # on server - id: [ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html)! - # Name shown in server and desktop clients - name: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # True if this table is embedded in Tableau content, e.g., a packaged workbook - isEmbedded: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) - # User modifiable description of this table - description: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Columns contained in this table - # - # 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. - columns( - filter: [Column_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/column_filter.doc.html), - orderBy: [ColumnSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Column](https://help.tableau.com/current/api/metadata_api/en-us/reference/column.doc.html)!]! - # Columns contained in this table - # - # 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. - columnsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Column_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/column_filter.doc.html), - orderBy: [ColumnSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [ColumnsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnsconnection.doc.html) - # Databases upstream of this table - # - # 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/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Database](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html)!]! - # Databases upstream of this table - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Database_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabasesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesconnection.doc.html) - # Tables upstream of this table - # - # 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/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DatabaseTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable.doc.html)!]! - # Tables upstream of this table - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabaseTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesconnection.doc.html) - # Virtual connections upstream of this table - # - # 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. - upstreamVirtualConnections( - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection.doc.html)!]! - # Virtual connections upstream of this table - # - # 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. - upstreamVirtualConnectionsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsconnection.doc.html) - # Virtual connection tables upstream of this table - # - # 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/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnectionTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable.doc.html)!]! - # Virtual connection tables upstream of this table - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnectionTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesconnection.doc.html) - # Flows upstream of this table - # - # 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/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Flow](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow.doc.html)!]! - # Flows upstream of this table - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Flow_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FlowsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsconnection.doc.html) - # Datasources upstream of this table - # - # 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/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[PublishedDatasource](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource.doc.html)!]! - # Datasources upstream of this table - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [PublishedDatasource_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [PublishedDatasourcesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesconnection.doc.html) - # Databases downstream of this table - # - # 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. - downstreamDatabases( - filter: [Database_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Database](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html)!]! - # Databases downstream of this table - # - # 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. - downstreamDatabasesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Database_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabasesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesconnection.doc.html) - # Tables downstream of this table - # - # 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. - downstreamTables( - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DatabaseTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable.doc.html)!]! - # Tables downstream of this table - # - # 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. - downstreamTablesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabaseTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesconnection.doc.html) - # Virtual connection tables downstream of this table - # - # 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/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnectionTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable.doc.html)!]! - # Virtual connection tables downstream of this table - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnectionTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesconnection.doc.html) - # Virtual connection downstream of this table - # - # 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. - downstreamVirtualConnections( - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection.doc.html)!]! - # Virtual connection downstream of this table - # - # 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. - downstreamVirtualConnectionsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsconnection.doc.html) - # Flows downstream of this table - # - # 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/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Flow](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow.doc.html)!]! - # Flows downstream of this table - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Flow_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FlowsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsconnection.doc.html) - # Published datasources connected to the table - # - # 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/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[PublishedDatasource](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource.doc.html)!]! - # Published datasources connected to the table - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [PublishedDatasource_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [PublishedDatasourcesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesconnection.doc.html) - # Lenses connected downstream from the table - # - # 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/current/api/metadata_api/en-us/reference/lens_filter.doc.html), - orderBy: [LensSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/lenssortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Lens](https://help.tableau.com/current/api/metadata_api/en-us/reference/lens.doc.html)!]! - # Lenses connected downstream from the table - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Lens_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/lens_filter.doc.html), - orderBy: [LensSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/lenssortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [LensesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensesconnection.doc.html) - # Dashboards connected to the table - # - # 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/current/api/metadata_api/en-us/reference/dashboard_filter.doc.html), - orderBy: [DashboardSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboardsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Dashboard](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard.doc.html)!]! - # Dashboards connected to the table - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Dashboard_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard_filter.doc.html), - orderBy: [DashboardSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboardsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DashboardsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboardsconnection.doc.html) - # Workbooks connected to the table - # - # 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/current/api/metadata_api/en-us/reference/workbook_filter.doc.html), - orderBy: [WorkbookSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Workbook](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbook.doc.html)!]! - # Workbooks connected to the table - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Workbook_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbook_filter.doc.html), - orderBy: [WorkbookSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [WorkbooksConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksconnection.doc.html) - # Sheets connected to the table - # - # 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/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Sheet](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html)!]! - # Sheets connected to the table - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Sheet_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [SheetsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsconnection.doc.html) - # Owners of workbooks and published datasources connected to the table - # - # 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/current/api/metadata_api/en-us/reference/tableauuser_filter.doc.html), - orderBy: [TableauUserSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauusersortorder.doc.html) - ): [[TableauUser](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauuser.doc.html)!]! - # Owners of workbooks and published datasources connected to the table - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [TableauUser_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauuser_filter.doc.html), - orderBy: [TableauUserSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauusersortorder.doc.html) - ): [TableauUsersConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauusersconnection.doc.html) - # Metrics connected to the table - # - # 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/current/api/metadata_api/en-us/reference/metric_filter.doc.html), - orderBy: [MetricSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Metric](https://help.tableau.com/current/api/metadata_api/en-us/reference/metric.doc.html)!]! - # Metrics connected to the table - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Metric_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metric_filter.doc.html), - orderBy: [MetricSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [MetricsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricsconnection.doc.html) - } ` ## [_link_](#require-by) Require by - [Column_GraphQL type for a table column_](https://help.tableau.com/current/api/metadata_api/en-us/reference/column.doc.html "Column - GraphQL type for a table column") - [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/current/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.") - [Dashboard_A dashboard contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard.doc.html "Dashboard - A dashboard contained in a published workbook.") - [DatabaseTable_A table that is contained in a database_](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable.doc.html "DatabaseTable - A table that is contained in a database") - [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.*") - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/api/metadata_api/en-us/reference/query.doc.html "Query - Query root for Metadata GraphQL interface") - [Sheet_A sheet contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html "Sheet - A sheet contained in a published workbook.") - [TablesConnection_Connection Type for Table_](https://help.tableau.com/current/api/metadata_api/en-us/reference/tablesconnection.doc.html "TablesConnection - Connection Type for Table") - [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.*") _menu_ Types INPUT\_OBJECT # Table\_Filter Filter by GraphQL field and given value ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input Table_Filter { - # Name shown in server and desktop clients - name: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Name shown in server and desktop clients - nameWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.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/current/api/metadata_api/en-us/reference/id.doc.html) - # Unique identifier used by the metadata API. Not the same as the numeric ID used - # on server - idWithin: [[ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html)] - # Filter the output based on text query. - text: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - } ` ## [_link_](#require-by) Require by - [Dashboard_A dashboard contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard.doc.html "Dashboard - A dashboard contained in a published workbook.") - [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.*") - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/api/metadata_api/en-us/reference/query.doc.html "Query - Query root for Metadata GraphQL interface") - [Sheet_A sheet contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html "Sheet - A sheet contained in a published workbook.") _menu_ Types OBJECT # TableAdditionalDetails Additional details for the DatabaseTable type _Available in Tableau Cloud February 2024 / Server 2024.2 and later._ ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type TableAdditionalDetails { - # Unique identifier used with the Metadata API. Not the same as the locally - # unique identifier used with the REST API. - id: [ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html)! - # API name of the Data Cloud object - dataCloudApiName: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Internal ID of the Data Cloud object - cdpInternalId: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Category of the Data Cloud object - category: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # The Data Cloud user who created this object - createdBy: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # The tables that this additional detail is for - # - # 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. - table( - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DatabaseTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable.doc.html)] - # The tables that this additional detail is for - # - # 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. - tableConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabaseTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesconnection.doc.html) - } ` ## [_link_](#require-by) Require by - [DatabaseTable_A table that is contained in a database_](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable.doc.html "DatabaseTable - A table that is contained in a database") - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/api/metadata_api/en-us/reference/query.doc.html "Query - Query root for Metadata GraphQL interface") - [TableAdditionalDetailsesConnection_Connection Type for TableAdditionalDetails_](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableadditionaldetailsesconnection.doc.html "TableAdditionalDetailsesConnection - Connection Type for TableAdditionalDetails") _menu_ Types INPUT\_OBJECT # TableAdditionalDetails\_Filter Filter by GraphQL field and given value ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input TableAdditionalDetails_Filter { - # Unique identifier used with the Metadata API. Not the same as the locally - # unique identifier used with the REST API. - id: [ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html) - # Unique identifier used with the Metadata API. Not the same as the locally - # unique identifier used with the REST API. - idWithin: [[ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html)] - } ` ## [_link_](#require-by) Require by - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/api/metadata_api/en-us/reference/query.doc.html "Query - Query root for Metadata GraphQL interface") _menu_ Types OBJECT # TableAdditionalDetailsesConnection Connection Type for TableAdditionalDetails ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type TableAdditionalDetailsesConnection { - # List of nodes - nodes: [[TableAdditionalDetails](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableadditionaldetails.doc.html)!]! - # Information for pagination - pageInfo: [PageInfo](https://help.tableau.com/current/api/metadata_api/en-us/reference/pageinfo.doc.html)! - # Total number of objects in connection - totalCount: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html)! - } ` ## [_link_](#require-by) Require by - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/api/metadata_api/en-us/reference/query.doc.html "Query - Query root for Metadata GraphQL interface") _menu_ Types ENUM # TableAdditionalDetailsOrderField Enum for fields that can be used for sorting ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - enum TableAdditionalDetailsOrderField { - # Sort by id - ID - } ` ## [_link_](#require-by) Require by - [TableAdditionalDetailsSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableadditionaldetailssortorder.doc.html "TableAdditionalDetailsSortOrder - 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.") _menu_ Types INPUT\_OBJECT # TableAdditionalDetailsSortOrder 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. ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input TableAdditionalDetailsSortOrder { - # GraphQL field to sort on - field: [TableAdditionalDetailsOrderField](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableadditionaldetailsorderfield.doc.html)! - # Order direction to sort output - direction: [OrderDirection](https://help.tableau.com/current/api/metadata_api/en-us/reference/orderdirection.doc.html)! - } ` ## [_link_](#require-by) Require by - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/api/metadata_api/en-us/reference/query.doc.html "Query - Query root for Metadata GraphQL interface") _menu_ Types OBJECT # TableauSite Site on Tableau server ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type TableauSite { - # Unique identifier used by the metadata API. Not the same as the numeric ID used - # on server - id: [ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html)! - # URI of this site, e.g., 'sites/4' - uri: [String](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/string.doc.html)! - # Name shown in server - name: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)! - # Time the site was created. Available in Tableau Cloud June 2022 / Server 2022.3 - # and later. - createdAt: [DateTime](https://help.tableau.com/current/api/metadata_api/en-us/reference/datetime.doc.html) - # Metric definitions that are part of this site. - # - # 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. - metricDefinitions( - filter: [MetricDefinition_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinition_filter.doc.html), - orderBy: [MetricDefinitionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[MetricDefinition](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinition.doc.html)] - # Metric definitions that are part of this site. - # - # 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. - metricDefinitionsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [MetricDefinition_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinition_filter.doc.html), - orderBy: [MetricDefinitionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [MetricDefinitionsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsconnection.doc.html) - # The published data sources that are part of this site - # - # 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. - publishedDatasources( - filter: [PublishedDatasource_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[PublishedDatasource](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource.doc.html)] - # The published data sources that are part of this site - # - # 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. - publishedDatasourcesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [PublishedDatasource_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [PublishedDatasourcesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesconnection.doc.html) - # The workbooks that are part of this site - # - # 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. - workbooks( - filter: [Workbook_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbook_filter.doc.html), - orderBy: [WorkbookSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Workbook](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbook.doc.html)] - # The workbooks that are part of this site - # - # 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. - workbooksConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Workbook_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbook_filter.doc.html), - orderBy: [WorkbookSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [WorkbooksConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksconnection.doc.html) - # The Lenses that are part of this site - # - # 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. - lenses( - filter: [Lens_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/lens_filter.doc.html), - orderBy: [LensSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/lenssortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Lens](https://help.tableau.com/current/api/metadata_api/en-us/reference/lens.doc.html)] - # The Lenses that are part of this site - # - # 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. - lensesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Lens_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/lens_filter.doc.html), - orderBy: [LensSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/lenssortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [LensesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensesconnection.doc.html) - # The flows that are part of this site - # - # 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. - flows( - filter: [Flow_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Flow](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow.doc.html)] - # The flows that are part of this site - # - # 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. - flowsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Flow_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FlowsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsconnection.doc.html) - # The virtual connections that are part of this site - # - # 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. - virtualConnections( - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection.doc.html)] - # The virtual connections that are part of this site - # - # 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. - virtualConnectionsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsconnection.doc.html) - # The Metrics that are part of this site - # - # 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. - metrics( - filter: [Metric_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metric_filter.doc.html), - orderBy: [MetricSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Metric](https://help.tableau.com/current/api/metadata_api/en-us/reference/metric.doc.html)] - # The Metrics that are part of this site - # - # 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. - metricsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Metric_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metric_filter.doc.html), - orderBy: [MetricSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [MetricsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricsconnection.doc.html) - } ` ## [_link_](#require-by) Require by - [Flow_Flows are used to prepare data, which can include aggregation, cleaning, preprocessing, etc._](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow.doc.html "Flow - Flows are used to prepare data, which can include aggregation, cleaning, preprocessing, etc.") - [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.*") - [Metric_Metrics are time series data constructed from fields contained in views. \*Retired in Tableau Cloud February 2024 / Server 2024.2.\*_](metric.doc.html "Metric - Metrics are time series data constructed from fields contained in views. *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/current/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/current/api/metadata_api/en-us/reference/query.doc.html "Query - Query root for Metadata GraphQL interface") - [TableauSitesConnection_Connection Type for TableauSite_](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableausitesconnection.doc.html "TableauSitesConnection - Connection Type for TableauSite") - [VirtualConnection_A virtual connection. \*Available in Tableau Cloud March 2022 / Server 2022.1 and later.\*_](virtualconnection.doc.html "VirtualConnection - A virtual connection. *Available in Tableau Cloud March 2022 / Server 2022.1 and later.*") - [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/current/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).") _menu_ Types INPUT\_OBJECT # TableauSite\_Filter Filter by GraphQL field and given value ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input TableauSite_Filter { - # Locally unique identifier used for the REST API on the Tableau Server - luid: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Locally unique identifier used for the REST API on the Tableau Server - luidWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)] - # Name shown in server - name: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Name shown in server - nameWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.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/current/api/metadata_api/en-us/reference/id.doc.html) - # Unique identifier used by the metadata API. Not the same as the numeric ID used - # on server - idWithin: [[ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html)] - } ` ## [_link_](#require-by) Require by - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/api/metadata_api/en-us/reference/query.doc.html "Query - Query root for Metadata GraphQL interface") _menu_ Types ENUM # TableauSiteOrderField Enum for fields that can be used for sorting ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - enum TableauSiteOrderField { - # Sort by id - ID - # Sort by luid - LUID - # Sort by name - NAME - } ` ## [_link_](#require-by) Require by - [TableauSiteSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableausitesortorder.doc.html "TableauSiteSortOrder - 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.") _menu_ Types OBJECT # TableauSitesConnection Connection Type for TableauSite ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type TableauSitesConnection { - # List of nodes - nodes: [[TableauSite](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableausite.doc.html)!]! - # Information for pagination - pageInfo: [PageInfo](https://help.tableau.com/current/api/metadata_api/en-us/reference/pageinfo.doc.html)! - # Total number of objects in connection - totalCount: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html)! - } ` ## [_link_](#require-by) Require by - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/api/metadata_api/en-us/reference/query.doc.html "Query - Query root for Metadata GraphQL interface") _menu_ Types INPUT\_OBJECT # TableauSiteSortOrder 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. ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input TableauSiteSortOrder { - # GraphQL field to sort on - field: [TableauSiteOrderField](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableausiteorderfield.doc.html)! - # Order direction to sort output - direction: [OrderDirection](https://help.tableau.com/current/api/metadata_api/en-us/reference/orderdirection.doc.html)! - } ` ## [_link_](#require-by) Require by - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/api/metadata_api/en-us/reference/query.doc.html "Query - Query root for Metadata GraphQL interface") _menu_ Types OBJECT # TableauUser User on a site on Tableau server ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type TableauUser { - # Unique identifier used by the metadata API. Not the same as the numeric ID used - # on server - id: [ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html)! - # URI of this user, e.g., 'sites/1/users/1396' - uri: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)! - # Vizportal ID of this user, for use in client-to-server communications - vizportalId: [String](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/string.doc.html)! - # Username of this user - username: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Display name of this user - name: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Domain this user belongs to - domain: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Email address of this user - email: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # The labels this user has authored - # - # 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. - authoredLabels( - filter: [Label_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/label_filter.doc.html), - orderBy: [LabelSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/labelsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Label](https://help.tableau.com/current/api/metadata_api/en-us/reference/label.doc.html)] - # The labels this user has authored - # - # 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. - authoredLabelsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Label_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/label_filter.doc.html), - orderBy: [LabelSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/labelsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [LabelsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/labelsconnection.doc.html) - # The databases that this user is the contact for - # - # 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. - contactForDatabases( - filter: [Database_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Database](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html)] - # The databases that this user is the contact for - # - # 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. - contactForDatabasesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Database_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabasesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesconnection.doc.html) - # The databases that this user has certified - # - # 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. - certifiedDatabases( - filter: [Database_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Database](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html)] - # The databases that this user has certified - # - # 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. - certifiedDatabasesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Database_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabasesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesconnection.doc.html) - # The published data sources that belong to this user - # - # 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. - ownedDatasources( - filter: [PublishedDatasource_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[PublishedDatasource](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource.doc.html)] - # The published data sources that belong to this user - # - # 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. - ownedDatasourcesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [PublishedDatasource_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [PublishedDatasourcesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesconnection.doc.html) - # The published data sources that this user has certified - # - # 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. - certifiedDatasources( - filter: [PublishedDatasource_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[PublishedDatasource](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource.doc.html)] - # The published data sources that this user has certified - # - # 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. - certifiedDatasourcesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [PublishedDatasource_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [PublishedDatasourcesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesconnection.doc.html) - # The data quality warnings this user has authored - # - # 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. - authoredDataQualityWarnings( - filter: [DataQualityWarning_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarning_filter.doc.html), - orderBy: [DataQualityWarningSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarningsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DataQualityWarning](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarning.doc.html)] - # The data quality warnings this user has authored - # - # 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. - authoredDataQualityWarningsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DataQualityWarning_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarning_filter.doc.html), - orderBy: [DataQualityWarningSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarningsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DataQualityWarningsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarningsconnection.doc.html) - # The data quality certifications this user has authored - # - # 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. - authoredDataQualityCertifications( - filter: [DataQualityCertification_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitycertification_filter.doc.html), - orderBy: [DataQualityCertificationSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitycertificationsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DataQualityCertification](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitycertification.doc.html)] - # The data quality certifications this user has authored - # - # 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. - authoredDataQualityCertificationsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DataQualityCertification_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitycertification_filter.doc.html), - orderBy: [DataQualityCertificationSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitycertificationsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DataQualityCertificationsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitycertificationsconnection.doc.html) - # The workbooks that belong to this user - # - # 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. - ownedWorkbooks( - filter: [Workbook_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbook_filter.doc.html), - orderBy: [WorkbookSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Workbook](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbook.doc.html)] - # The workbooks that belong to this user - # - # 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. - ownedWorkbooksConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Workbook_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbook_filter.doc.html), - orderBy: [WorkbookSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [WorkbooksConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksconnection.doc.html) - # The Lenses that belong to this user - # - # 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. - ownedLenses( - filter: [Lens_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/lens_filter.doc.html), - orderBy: [LensSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/lenssortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Lens](https://help.tableau.com/current/api/metadata_api/en-us/reference/lens.doc.html)] - # The Lenses that belong to this user - # - # 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. - ownedLensesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Lens_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/lens_filter.doc.html), - orderBy: [LensSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/lenssortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [LensesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensesconnection.doc.html) - # The flows that belong to this user - # - # 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. - ownedFlows( - filter: [Flow_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Flow](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow.doc.html)] - # The flows that belong to this user - # - # 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. - ownedFlowsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Flow_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FlowsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsconnection.doc.html) - # The tables that this user has certified - # - # 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. - certifiedTables( - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DatabaseTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable.doc.html)] - # The tables that this user has certified - # - # 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. - certifiedTablesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabaseTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesconnection.doc.html) - # The tables that this user is the contact for - # - # 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. - contactForTables( - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DatabaseTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable.doc.html)] - # The tables that this user is the contact for - # - # 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. - contactForTablesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabaseTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesconnection.doc.html) - # The virtual connections that belong to this user - # - # 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. - ownedVirtualConnections( - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection.doc.html)] - # The virtual connections that belong to this user - # - # 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. - ownedVirtualConnectionsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsconnection.doc.html) - # The virtual connection tables that belong to this user - # - # 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. - ownedVirtualConnectionTables( - filter: [VirtualConnectionTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnectionTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable.doc.html)] - # The virtual connection tables that belong to this user - # - # 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. - ownedVirtualConnectionTablesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnectionTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesconnection.doc.html) - # The Metrics that belong to this user - # - # 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. - ownedMetrics( - filter: [Metric_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metric_filter.doc.html), - orderBy: [MetricSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Metric](https://help.tableau.com/current/api/metadata_api/en-us/reference/metric.doc.html)] - # The Metrics that belong to this user - # - # 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. - ownedMetricsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Metric_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metric_filter.doc.html), - orderBy: [MetricSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [MetricsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricsconnection.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/current/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/current/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/current/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/current/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/current/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/current/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/current/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/current/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/current/api/metadata_api/en-us/reference/database.doc.html "Database - A database containing tables") - [DatabaseServer_A database server connection_](https://help.tableau.com/current/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/current/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.*") - [DataQualityCertification_A data quality certification associated with a content item_](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitycertification.doc.html "DataQualityCertification - A data quality certification associated with a content item") - [DataQualityWarning_A data quality warning associated with a content item_](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarning.doc.html "DataQualityWarning - A data quality warning associated with a content item") - [Datasource_Root GraphQL type for embedded and published data sources Data sources are a way to represent how Tableau Desktop and Tableau Server model and connect to data. Data sources can be published separately, as a published data source, or may be contained in a workbook as an embedded data source. See https://onlinehelp.tableau.com/current/server/en-us/datasource.htm_](datasource.doc.html "Datasource - Root GraphQL type for embedded and published data sources Data sources are a way to represent how Tableau Desktop and Tableau Server model and connect to data. Data sources can be published separately, as a published data source, or may be contained in a workbook as an embedded data source. See https://onlinehelp.tableau.com/current/server/en-us/datasource.htm") - [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/current/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.") - [EmbeddedDatasource_A data source embedded in a workbook_](https://help.tableau.com/current/api/metadata_api/en-us/reference/embeddeddatasource.doc.html "EmbeddedDatasource - A data source embedded in a workbook") - [Field_Base GraphQL type for a field_](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [File_A file connection_](https://help.tableau.com/current/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/current/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/current/api/metadata_api/en-us/reference/flowcolumnoutputfield.doc.html "FlowColumnOutputField - Column output field implementation") - [FlowFieldOutputField_Field output field implementation_](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/flowoutputfield.doc.html "FlowOutputField - A wrapper for an output field contained in a published flow.") - [GenericLabel_A label that can be attached to assets. \*Available in Tableau Cloud March 2023 / Server 2023.1 and later.\*_](genericlabel.doc.html "GenericLabel - A label that can be attached to assets. *Available in Tableau Cloud March 2023 / Server 2023.1 and later.*") - [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/current/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/current/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") - [Label_A label that can be attached to assets. \*Available in Tableau Cloud March 2023 / Server 2023.1 and later.\*_](label.doc.html "Label - A label that can be attached to assets. *Available in Tableau Cloud March 2023 / Server 2023.1 and later.*") - [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.*") - [Metric_Metrics are time series data constructed from fields contained in views. \*Retired in Tableau Cloud February 2024 / Server 2024.2.\*_](metric.doc.html "Metric - Metrics are time series data constructed from fields contained in views. *Retired in Tableau Cloud February 2024 / Server 2024.2.*") - [PublishedDatasource_A Tableau data source that has been published separately to Tableau Server. It can be used by multiple workbooks._](https://help.tableau.com/current/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/current/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/current/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/current/api/metadata_api/en-us/reference/table.doc.html "Table - A table containing columns") - [TableauUsersConnection_Connection Type for TableauUser_](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauusersconnection.doc.html "TableauUsersConnection - Connection Type for TableauUser") - [VirtualConnection_A virtual connection. \*Available in Tableau Cloud March 2022 / Server 2022.1 and later.\*_](virtualconnection.doc.html "VirtualConnection - A virtual connection. *Available in Tableau Cloud March 2022 / Server 2022.1 and later.*") - [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/current/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/current/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).") _menu_ Types INPUT\_OBJECT # TableauUser\_Filter Filter by GraphQL field and given value ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input TableauUser_Filter { - # Locally unique identifier used for the REST API on the Tableau Server - luid: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Locally unique identifier used for the REST API on the Tableau Server - luidWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)] - # Domain this user belongs to - domain: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Domain this user belongs to - domainWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)] - # Display name of this user - name: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Display name of this user - nameWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.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/current/api/metadata_api/en-us/reference/id.doc.html) - # Unique identifier used by the metadata API. Not the same as the numeric ID used - # on server - idWithin: [[ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html)] - # Email address of this user - email: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Email address of this user - emailWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)] - # Username of this user - username: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Username of this user - usernameWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.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/current/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/current/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/current/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/current/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/current/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/current/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/current/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/current/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/current/api/metadata_api/en-us/reference/database.doc.html "Database - A database containing tables") - [DatabaseServer_A database server connection_](https://help.tableau.com/current/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/current/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.*") - [Datasource_Root GraphQL type for embedded and published data sources Data sources are a way to represent how Tableau Desktop and Tableau Server model and connect to data. Data sources can be published separately, as a published data source, or may be contained in a workbook as an embedded data source. See https://onlinehelp.tableau.com/current/server/en-us/datasource.htm_](datasource.doc.html "Datasource - Root GraphQL type for embedded and published data sources Data sources are a way to represent how Tableau Desktop and Tableau Server model and connect to data. Data sources can be published separately, as a published data source, or may be contained in a workbook as an embedded data source. See https://onlinehelp.tableau.com/current/server/en-us/datasource.htm") - [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/current/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.") - [EmbeddedDatasource_A data source embedded in a workbook_](https://help.tableau.com/current/api/metadata_api/en-us/reference/embeddeddatasource.doc.html "EmbeddedDatasource - A data source embedded in a workbook") - [Field_Base GraphQL type for a field_](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [File_A file connection_](https://help.tableau.com/current/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/current/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/current/api/metadata_api/en-us/reference/flowcolumnoutputfield.doc.html "FlowColumnOutputField - Column output field implementation") - [FlowFieldOutputField_Field output field implementation_](https://help.tableau.com/current/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/current/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/current/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/current/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.*") - [PublishedDatasource_A Tableau data source that has been published separately to Tableau Server. It can be used by multiple workbooks._](https://help.tableau.com/current/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/current/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/current/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/current/api/metadata_api/en-us/reference/table.doc.html "Table - A table containing columns") - [VirtualConnection_A virtual connection. \*Available in Tableau Cloud March 2022 / Server 2022.1 and later.\*_](virtualconnection.doc.html "VirtualConnection - A virtual connection. *Available in Tableau Cloud March 2022 / Server 2022.1 and later.*") - [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/current/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/current/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).") _menu_ Types ENUM # TableauUserOrderField Enum for fields that can be used for sorting ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - enum TableauUserOrderField { - # Sort by domain - DOMAIN - # Sort by email - EMAIL - # Sort by id - ID - # Sort by luid - LUID - # Sort by name - NAME - # Sort by username - USERNAME - } ` ## [_link_](#require-by) Require by - [TableauUserSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauusersortorder.doc.html "TableauUserSortOrder - 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.") _menu_ Types OBJECT # TableauUsersConnection Connection Type for TableauUser ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type TableauUsersConnection { - # List of nodes - nodes: [[TableauUser](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauuser.doc.html)!]! - # Information for pagination - pageInfo: [PageInfo](https://help.tableau.com/current/api/metadata_api/en-us/reference/pageinfo.doc.html)! - # Total number of objects in connection - totalCount: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.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/current/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/current/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/current/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/current/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/current/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/current/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/current/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/current/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/current/api/metadata_api/en-us/reference/database.doc.html "Database - A database containing tables") - [DatabaseServer_A database server connection_](https://help.tableau.com/current/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/current/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.*") - [Datasource_Root GraphQL type for embedded and published data sources Data sources are a way to represent how Tableau Desktop and Tableau Server model and connect to data. Data sources can be published separately, as a published data source, or may be contained in a workbook as an embedded data source. See https://onlinehelp.tableau.com/current/server/en-us/datasource.htm_](datasource.doc.html "Datasource - Root GraphQL type for embedded and published data sources Data sources are a way to represent how Tableau Desktop and Tableau Server model and connect to data. Data sources can be published separately, as a published data source, or may be contained in a workbook as an embedded data source. See https://onlinehelp.tableau.com/current/server/en-us/datasource.htm") - [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/current/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.") - [EmbeddedDatasource_A data source embedded in a workbook_](https://help.tableau.com/current/api/metadata_api/en-us/reference/embeddeddatasource.doc.html "EmbeddedDatasource - A data source embedded in a workbook") - [Field_Base GraphQL type for a field_](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [File_A file connection_](https://help.tableau.com/current/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/current/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/current/api/metadata_api/en-us/reference/flowcolumnoutputfield.doc.html "FlowColumnOutputField - Column output field implementation") - [FlowFieldOutputField_Field output field implementation_](https://help.tableau.com/current/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/current/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/current/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/current/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.*") - [PublishedDatasource_A Tableau data source that has been published separately to Tableau Server. It can be used by multiple workbooks._](https://help.tableau.com/current/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/current/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/current/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/current/api/metadata_api/en-us/reference/table.doc.html "Table - A table containing columns") - [VirtualConnection_A virtual connection. \*Available in Tableau Cloud March 2022 / Server 2022.1 and later.\*_](virtualconnection.doc.html "VirtualConnection - A virtual connection. *Available in Tableau Cloud March 2022 / Server 2022.1 and later.*") - [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/current/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/current/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).") _menu_ Types INPUT\_OBJECT # TableauUserSortOrder 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. ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input TableauUserSortOrder { - # GraphQL field to sort on - field: [TableauUserOrderField](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauuserorderfield.doc.html)! - # Order direction to sort output - direction: [OrderDirection](https://help.tableau.com/current/api/metadata_api/en-us/reference/orderdirection.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/current/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/current/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/current/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/current/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/current/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/current/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/current/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/current/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/current/api/metadata_api/en-us/reference/database.doc.html "Database - A database containing tables") - [DatabaseServer_A database server connection_](https://help.tableau.com/current/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/current/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.*") - [Datasource_Root GraphQL type for embedded and published data sources Data sources are a way to represent how Tableau Desktop and Tableau Server model and connect to data. Data sources can be published separately, as a published data source, or may be contained in a workbook as an embedded data source. See https://onlinehelp.tableau.com/current/server/en-us/datasource.htm_](datasource.doc.html "Datasource - Root GraphQL type for embedded and published data sources Data sources are a way to represent how Tableau Desktop and Tableau Server model and connect to data. Data sources can be published separately, as a published data source, or may be contained in a workbook as an embedded data source. See https://onlinehelp.tableau.com/current/server/en-us/datasource.htm") - [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/current/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.") - [EmbeddedDatasource_A data source embedded in a workbook_](https://help.tableau.com/current/api/metadata_api/en-us/reference/embeddeddatasource.doc.html "EmbeddedDatasource - A data source embedded in a workbook") - [Field_Base GraphQL type for a field_](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [File_A file connection_](https://help.tableau.com/current/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/current/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/current/api/metadata_api/en-us/reference/flowcolumnoutputfield.doc.html "FlowColumnOutputField - Column output field implementation") - [FlowFieldOutputField_Field output field implementation_](https://help.tableau.com/current/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/current/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/current/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/current/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.*") - [PublishedDatasource_A Tableau data source that has been published separately to Tableau Server. It can be used by multiple workbooks._](https://help.tableau.com/current/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/current/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/current/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/current/api/metadata_api/en-us/reference/table.doc.html "Table - A table containing columns") - [VirtualConnection_A virtual connection. \*Available in Tableau Cloud March 2022 / Server 2022.1 and later.\*_](virtualconnection.doc.html "VirtualConnection - A virtual connection. *Available in Tableau Cloud March 2022 / Server 2022.1 and later.*") - [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/current/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/current/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).") _menu_ Types ENUM # TableOrderField Enum for fields that can be used for sorting ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - enum TableOrderField { - # Sort by columns count - COLUMNS_COUNT - # Sort by downstreamDashboards count - DOWNSTREAM_DASHBOARDS_COUNT - # Sort by downstreamDatasources count - DOWNSTREAM_DATASOURCES_COUNT - # Sort by downstreamWorkbooks count - DOWNSTREAM_WORKBOOKS_COUNT - # Sort by id - ID - # Sort by name - NAME - } ` ## [_link_](#require-by) Require by - [TableSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/tablesortorder.doc.html "TableSortOrder - 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.") _menu_ Types OBJECT # TablesConnection Connection Type for Table ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type TablesConnection { - # List of nodes - nodes: [[Table](https://help.tableau.com/current/api/metadata_api/en-us/reference/table.doc.html)!]! - # Information for pagination - pageInfo: [PageInfo](https://help.tableau.com/current/api/metadata_api/en-us/reference/pageinfo.doc.html)! - # Total number of objects in connection - totalCount: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html)! - } ` ## [_link_](#require-by) Require by - [Dashboard_A dashboard contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard.doc.html "Dashboard - A dashboard contained in a published workbook.") - [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.*") - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/api/metadata_api/en-us/reference/query.doc.html "Query - Query root for Metadata GraphQL interface") - [Sheet_A sheet contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html "Sheet - A sheet contained in a published workbook.") _menu_ Types INPUT\_OBJECT # TableSortOrder 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. ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input TableSortOrder { - # GraphQL field to sort on - field: [TableOrderField](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableorderfield.doc.html)! - # Order direction to sort output - direction: [OrderDirection](https://help.tableau.com/current/api/metadata_api/en-us/reference/orderdirection.doc.html)! - } ` ## [_link_](#require-by) Require by - [Dashboard_A dashboard contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard.doc.html "Dashboard - A dashboard contained in a published workbook.") - [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.*") - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/api/metadata_api/en-us/reference/query.doc.html "Query - Query root for Metadata GraphQL interface") - [Sheet_A sheet contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html "Sheet - A sheet contained in a published workbook.") _menu_ Types ENUM # TableType Possible types of table. TableType is DATABASETABLE unless the object is a Salesforce Data Cloud object. A Salesforce Data Cloud object's TableType is DATAMODEL, DATALAKE, or CALCULATED INSIGHT. _Available in Tableau Cloud February 2024 / Server 2024.2 and later._ ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - enum TableType { - DATABASETABLE - DATAMODEL - DATALAKE - CALCULATEDINSIGHT - } ` ## [_link_](#require-by) Require by - [DatabaseTable_A table that is contained in a database_](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable.doc.html "DatabaseTable - A table that is contained in a database") _menu_ Types INPUT\_OBJECT # TableType\_Filter Filter by GraphQL field and given value ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input TableType_Filter { - # Unique Identifier of object to retrieve - id: [ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html) - # Unique Identifier of object to retrieve - idWithin: [[ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html)] - } ` ## [_link_](#require-by) Require by This element is not required by anyone _menu_ Types OBJECT # Tag A tag associated with content items ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type Tag { - # Unique identifier used by the metadata API. - id: [ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html)! - # The name of the tag - name: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # The assets that are associated with this tag - # - # 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. - assets( - filter: [Taggable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/taggable_filter.doc.html), - orderBy: [TaggableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/taggablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Taggable](https://help.tableau.com/current/api/metadata_api/en-us/reference/taggable.doc.html)] - # The assets that are associated with this tag - # - # 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. - assetsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Taggable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/taggable_filter.doc.html), - orderBy: [TaggableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/taggablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [TaggablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/taggablesconnection.doc.html) - # The views that are associated with this tag - # - # 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. - views( - filter: [View_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/view_filter.doc.html), - orderBy: [ViewSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/viewsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[View](https://help.tableau.com/current/api/metadata_api/en-us/reference/view.doc.html)] - # The views that are associated with this tag - # - # 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. - viewsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [View_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/view_filter.doc.html), - orderBy: [ViewSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/viewsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [ViewsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/viewsconnection.doc.html) - # The databases that are associated with this tag - # - # 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. - databases( - filter: [Database_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Database](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html)] - # The databases that are associated with this tag - # - # 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. - databasesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Database_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabasesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesconnection.doc.html) - # The published datasources that are associated with this tag - # - # 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. - publishedDatasources( - filter: [PublishedDatasource_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[PublishedDatasource](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource.doc.html)] - # The published datasources that are associated with this tag - # - # 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. - publishedDatasourcesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [PublishedDatasource_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [PublishedDatasourcesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesconnection.doc.html) - # The columns that are associated with this tag - # - # 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. - columns( - filter: [Column_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/column_filter.doc.html), - orderBy: [ColumnSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Column](https://help.tableau.com/current/api/metadata_api/en-us/reference/column.doc.html)] - # The columns that are associated with this tag - # - # 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. - columnsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Column_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/column_filter.doc.html), - orderBy: [ColumnSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [ColumnsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnsconnection.doc.html) - # The workbooks that are associated with this tag - # - # 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. - workbooks( - filter: [Workbook_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbook_filter.doc.html), - orderBy: [WorkbookSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Workbook](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbook.doc.html)] - # The workbooks that are associated with this tag - # - # 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. - workbooksConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Workbook_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbook_filter.doc.html), - orderBy: [WorkbookSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [WorkbooksConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksconnection.doc.html) - # The flows that are associated with this tag - # - # 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. - flows( - filter: [Flow_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Flow](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow.doc.html)] - # The flows that are associated with this tag - # - # 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. - flowsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Flow_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FlowsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsconnection.doc.html) - # The tables that are associated with this tag - # - # 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. - databaseTables( - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DatabaseTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable.doc.html)] - # The tables that are associated with this tag - # - # 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. - databaseTablesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabaseTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesconnection.doc.html) - # The virtual connections that are associated with this tag - # - # 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. - virtualConnections( - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection.doc.html)] - # The virtual connections that are associated with this tag - # - # 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. - virtualConnectionsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsconnection.doc.html) - # The virtual connection tables that are associated with this tag - # - # 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. - virtualConnectionTables( - filter: [VirtualConnectionTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnectionTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable.doc.html)] - # The virtual connection tables that are associated with this tag - # - # 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. - virtualConnectionTablesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnectionTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesconnection.doc.html) - # The Metrics that are associated with this tag - # - # 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. - metrics( - filter: [Metric_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metric_filter.doc.html), - orderBy: [MetricSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Metric](https://help.tableau.com/current/api/metadata_api/en-us/reference/metric.doc.html)] - # The Metrics that are associated with this tag - # - # 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. - metricsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Metric_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metric_filter.doc.html), - orderBy: [MetricSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [MetricsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricsconnection.doc.html) - } ` ## [_link_](#require-by) Require by - [CloudFile_A cloud file connection_](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/column.doc.html "Column - GraphQL type for a table column") - [Dashboard_A dashboard contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard.doc.html "Dashboard - A dashboard contained in a published workbook.") - [Database_A database containing tables_](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html "Database - A database containing tables") - [DatabaseServer_A database server connection_](https://help.tableau.com/current/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/current/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.*") - [File_A file connection_](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/flow.doc.html "Flow - Flows are used to prepare data, which can include aggregation, cleaning, preprocessing, etc.") - [Metric_Metrics are time series data constructed from fields contained in views. \*Retired in Tableau Cloud February 2024 / Server 2024.2.\*_](metric.doc.html "Metric - Metrics are time series data constructed from fields contained in views. *Retired in Tableau Cloud February 2024 / Server 2024.2.*") - [PublishedDatasource_A Tableau data source that has been published separately to Tableau Server. It can be used by multiple workbooks._](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/query.doc.html "Query - Query root for Metadata GraphQL interface") - [Sheet_A sheet contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html "Sheet - A sheet contained in a published workbook.") - [Taggable_A content item that has a list of tags_](https://help.tableau.com/current/api/metadata_api/en-us/reference/taggable.doc.html "Taggable - A content item that has a list of tags") - [TagsConnection_Connection Type for Tag_](https://help.tableau.com/current/api/metadata_api/en-us/reference/tagsconnection.doc.html "TagsConnection - Connection Type for Tag") - [View_A view contained in a published workbook. Views can be sheets or dashboards._](https://help.tableau.com/current/api/metadata_api/en-us/reference/view.doc.html "View - A view contained in a published workbook. Views can be sheets or dashboards.") - [VirtualConnection_A virtual connection. \*Available in Tableau Cloud March 2022 / Server 2022.1 and later.\*_](virtualconnection.doc.html "VirtualConnection - A virtual connection. *Available in Tableau Cloud March 2022 / Server 2022.1 and later.*") - [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/current/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/current/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).") _menu_ Types INPUT\_OBJECT # Tag\_Filter Filter by GraphQL field and given value ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input Tag_Filter { - # The name of the tag - name: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # The name of the tag - nameWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)] - # Unique identifier used by the metadata API. - id: [ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html) - # Unique identifier used by the metadata API. - idWithin: [[ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html)] - # Filter the output based on text query. - text: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - } ` ## [_link_](#require-by) Require by - [CloudFile_A cloud file connection_](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/column.doc.html "Column - GraphQL type for a table column") - [Dashboard_A dashboard contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard.doc.html "Dashboard - A dashboard contained in a published workbook.") - [Database_A database containing tables_](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html "Database - A database containing tables") - [DatabaseServer_A database server connection_](https://help.tableau.com/current/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/current/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.*") - [File_A file connection_](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/flow.doc.html "Flow - Flows are used to prepare data, which can include aggregation, cleaning, preprocessing, etc.") - [Metric_Metrics are time series data constructed from fields contained in views. \*Retired in Tableau Cloud February 2024 / Server 2024.2.\*_](metric.doc.html "Metric - Metrics are time series data constructed from fields contained in views. *Retired in Tableau Cloud February 2024 / Server 2024.2.*") - [PublishedDatasource_A Tableau data source that has been published separately to Tableau Server. It can be used by multiple workbooks._](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/query.doc.html "Query - Query root for Metadata GraphQL interface") - [Sheet_A sheet contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html "Sheet - A sheet contained in a published workbook.") - [Taggable_A content item that has a list of tags_](https://help.tableau.com/current/api/metadata_api/en-us/reference/taggable.doc.html "Taggable - A content item that has a list of tags") - [View_A view contained in a published workbook. Views can be sheets or dashboards._](https://help.tableau.com/current/api/metadata_api/en-us/reference/view.doc.html "View - A view contained in a published workbook. Views can be sheets or dashboards.") - [VirtualConnection_A virtual connection. \*Available in Tableau Cloud March 2022 / Server 2022.1 and later.\*_](virtualconnection.doc.html "VirtualConnection - A virtual connection. *Available in Tableau Cloud March 2022 / Server 2022.1 and later.*") - [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/current/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/current/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).") _menu_ Types INTERFACE # Taggable A content item that has a list of tags ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - interface Taggable { - # Unique identifier used by the metadata API. Not the same as the numeric ID used - # on server - id: [ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html)! - # The name of the asset - name: [String](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/string.doc.html)! - # Tags associated with the content item - # - # 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/current/api/metadata_api/en-us/reference/tag_filter.doc.html), orderBy: [TagSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tagsortorder.doc.html)): [[Tag](https://help.tableau.com/current/api/metadata_api/en-us/reference/tag.doc.html)!]! - # Tags associated with the content item - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Tag_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/tag_filter.doc.html), - orderBy: [TagSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tagsortorder.doc.html) - ): [TagsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/tagsconnection.doc.html) - } ` ## [_link_](#require-by) Require by - [CloudFile_A cloud file connection_](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/column.doc.html "Column - GraphQL type for a table column") - [Dashboard_A dashboard contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard.doc.html "Dashboard - A dashboard contained in a published workbook.") - [DatabaseServer_A database server connection_](https://help.tableau.com/current/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/current/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.*") - [File_A file connection_](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/flow.doc.html "Flow - Flows are used to prepare data, which can include aggregation, cleaning, preprocessing, etc.") - [Metric_Metrics are time series data constructed from fields contained in views. \*Retired in Tableau Cloud February 2024 / Server 2024.2.\*_](metric.doc.html "Metric - Metrics are time series data constructed from fields contained in views. *Retired in Tableau Cloud February 2024 / Server 2024.2.*") - [PublishedDatasource_A Tableau data source that has been published separately to Tableau Server. It can be used by multiple workbooks._](https://help.tableau.com/current/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.") - [Sheet_A sheet contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html "Sheet - A sheet contained in a published workbook.") - [Tag_A tag associated with content items_](https://help.tableau.com/current/api/metadata_api/en-us/reference/tag.doc.html "Tag - A tag associated with content items") - [TaggablesConnection_Connection Type for Taggable_](https://help.tableau.com/current/api/metadata_api/en-us/reference/taggablesconnection.doc.html "TaggablesConnection - Connection Type for Taggable") - [VirtualConnection_A virtual connection. \*Available in Tableau Cloud March 2022 / Server 2022.1 and later.\*_](virtualconnection.doc.html "VirtualConnection - A virtual connection. *Available in Tableau Cloud March 2022 / Server 2022.1 and later.*") - [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/current/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/current/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).") _menu_ Types INPUT\_OBJECT # Taggable\_Filter Filter by GraphQL field and given value ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input Taggable_Filter { - # Locally unique identifier used for the REST API on the Tableau Server - luid: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Locally unique identifier used for the REST API on the Tableau Server - luidWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.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/current/api/metadata_api/en-us/reference/id.doc.html) - # Unique identifier used by the metadata API. Not the same as the numeric ID used - # on server - idWithin: [[ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html)] - } ` ## [_link_](#require-by) Require by - [Tag_A tag associated with content items_](https://help.tableau.com/current/api/metadata_api/en-us/reference/tag.doc.html "Tag - A tag associated with content items") _menu_ Types ENUM # TaggableOrderField Enum for fields that can be used for sorting ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - enum TaggableOrderField { - # Sort by id - ID - # Sort by luid - LUID - } ` ## [_link_](#require-by) Require by - [TaggableSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/taggablesortorder.doc.html "TaggableSortOrder - 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.") _menu_ Types OBJECT # TaggablesConnection Connection Type for Taggable ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type TaggablesConnection { - # List of nodes - nodes: [[Taggable](https://help.tableau.com/current/api/metadata_api/en-us/reference/taggable.doc.html)!]! - # Information for pagination - pageInfo: [PageInfo](https://help.tableau.com/current/api/metadata_api/en-us/reference/pageinfo.doc.html)! - # Total number of objects in connection - totalCount: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html)! - } ` ## [_link_](#require-by) Require by - [Tag_A tag associated with content items_](https://help.tableau.com/current/api/metadata_api/en-us/reference/tag.doc.html "Tag - A tag associated with content items") _menu_ Types INPUT\_OBJECT # TaggableSortOrder 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. ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input TaggableSortOrder { - # GraphQL field to sort on - field: [TaggableOrderField](https://help.tableau.com/current/api/metadata_api/en-us/reference/taggableorderfield.doc.html)! - # Order direction to sort output - direction: [OrderDirection](https://help.tableau.com/current/api/metadata_api/en-us/reference/orderdirection.doc.html)! - } ` ## [_link_](#require-by) Require by - [Tag_A tag associated with content items_](https://help.tableau.com/current/api/metadata_api/en-us/reference/tag.doc.html "Tag - A tag associated with content items") _menu_ Types ENUM # TagOrderField Enum for fields that can be used for sorting ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - enum TagOrderField { - # Sort by id - ID - # Sort by name - NAME - } ` ## [_link_](#require-by) Require by - [TagSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/tagsortorder.doc.html "TagSortOrder - 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.") _menu_ Types OBJECT # TagsConnection Connection Type for Tag ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type TagsConnection { - # List of nodes - nodes: [[Tag](https://help.tableau.com/current/api/metadata_api/en-us/reference/tag.doc.html)!]! - # Information for pagination - pageInfo: [PageInfo](https://help.tableau.com/current/api/metadata_api/en-us/reference/pageinfo.doc.html)! - # Total number of objects in connection - totalCount: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html)! - } ` ## [_link_](#require-by) Require by - [CloudFile_A cloud file connection_](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/column.doc.html "Column - GraphQL type for a table column") - [Dashboard_A dashboard contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard.doc.html "Dashboard - A dashboard contained in a published workbook.") - [Database_A database containing tables_](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html "Database - A database containing tables") - [DatabaseServer_A database server connection_](https://help.tableau.com/current/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/current/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.*") - [File_A file connection_](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/flow.doc.html "Flow - Flows are used to prepare data, which can include aggregation, cleaning, preprocessing, etc.") - [Metric_Metrics are time series data constructed from fields contained in views. \*Retired in Tableau Cloud February 2024 / Server 2024.2.\*_](metric.doc.html "Metric - Metrics are time series data constructed from fields contained in views. *Retired in Tableau Cloud February 2024 / Server 2024.2.*") - [PublishedDatasource_A Tableau data source that has been published separately to Tableau Server. It can be used by multiple workbooks._](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/query.doc.html "Query - Query root for Metadata GraphQL interface") - [Sheet_A sheet contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html "Sheet - A sheet contained in a published workbook.") - [Taggable_A content item that has a list of tags_](https://help.tableau.com/current/api/metadata_api/en-us/reference/taggable.doc.html "Taggable - A content item that has a list of tags") - [View_A view contained in a published workbook. Views can be sheets or dashboards._](https://help.tableau.com/current/api/metadata_api/en-us/reference/view.doc.html "View - A view contained in a published workbook. Views can be sheets or dashboards.") - [VirtualConnection_A virtual connection. \*Available in Tableau Cloud March 2022 / Server 2022.1 and later.\*_](virtualconnection.doc.html "VirtualConnection - A virtual connection. *Available in Tableau Cloud March 2022 / Server 2022.1 and later.*") - [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/current/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/current/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).") _menu_ Types INPUT\_OBJECT # TagSortOrder 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. ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input TagSortOrder { - # GraphQL field to sort on - field: [TagOrderField](https://help.tableau.com/current/api/metadata_api/en-us/reference/tagorderfield.doc.html)! - # Order direction to sort output - direction: [OrderDirection](https://help.tableau.com/current/api/metadata_api/en-us/reference/orderdirection.doc.html)! - } ` ## [_link_](#require-by) Require by - [CloudFile_A cloud file connection_](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/column.doc.html "Column - GraphQL type for a table column") - [Dashboard_A dashboard contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard.doc.html "Dashboard - A dashboard contained in a published workbook.") - [Database_A database containing tables_](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html "Database - A database containing tables") - [DatabaseServer_A database server connection_](https://help.tableau.com/current/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/current/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.*") - [File_A file connection_](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/flow.doc.html "Flow - Flows are used to prepare data, which can include aggregation, cleaning, preprocessing, etc.") - [Metric_Metrics are time series data constructed from fields contained in views. \*Retired in Tableau Cloud February 2024 / Server 2024.2.\*_](metric.doc.html "Metric - Metrics are time series data constructed from fields contained in views. *Retired in Tableau Cloud February 2024 / Server 2024.2.*") - [PublishedDatasource_A Tableau data source that has been published separately to Tableau Server. It can be used by multiple workbooks._](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/query.doc.html "Query - Query root for Metadata GraphQL interface") - [Sheet_A sheet contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html "Sheet - A sheet contained in a published workbook.") - [Taggable_A content item that has a list of tags_](https://help.tableau.com/current/api/metadata_api/en-us/reference/taggable.doc.html "Taggable - A content item that has a list of tags") - [View_A view contained in a published workbook. Views can be sheets or dashboards._](https://help.tableau.com/current/api/metadata_api/en-us/reference/view.doc.html "View - A view contained in a published workbook. Views can be sheets or dashboards.") - [VirtualConnection_A virtual connection. \*Available in Tableau Cloud March 2022 / Server 2022.1 and later.\*_](virtualconnection.doc.html "VirtualConnection - A virtual connection. *Available in Tableau Cloud March 2022 / Server 2022.1 and later.*") - [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/current/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/current/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).") # Understand the Metadata Model At the core of Tableau is data - your data. Your data can come in different formats and structures, categorized at varying levels of detail, and can have relationships with other data. This is the kind of metadata that you can expect to surface from the Metadata API using GraphQL. To successfully create effective GraphQL queries, you need to understand how Tableau interprets and interacts with content and assets. Understanding this can inform the most efficient way for you to access metadata at the level of detail that you need. Because the Metadata API uses GraphQL, this section describes the fundamental objects that are available to you to use in a GraphQL query. **In this section** ## Tableau content and assets The Metadata API surfaces the content and assets that comprise your Tableau Cloud site or Tableau Server, the content and asset roles, and how the content and assets relate to each other. **General Tableau content** Tableau content is unique to the Tableau platform. Content includes the following: - Data sources - both published and embedded - Workbooks - Sheets - Dashboards - including stories - Fields: calculated, column - as they relate to the data source, group, bin, set, hierarchy, combined, and combined set - Filters: data source - Parameters - Flows - Virtual connections - Virtual connection tables **Tableau Cloud and Tableau Server specific content** Tableau content that can only be managed through Tableau Cloud or Tableau Server includes the following: - Sites - Projects - Users - Certifications and certifiers - Data quality warnings and messages Note: Some content listed above can be managed through the [Tableau REST API \[↗\]](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_metadata.htm) as well. **External assets associated with Tableau content** The Metadata API treats information about any data that comes from outside of the Tableau environment as external assets. External assets include the following: - Databases - includes local files, remote connections to servers, and web data connectors (WDC) - Tables - includes queries (custom SQL) **Note:** Cubes are not supported. ### Objects and their roles The GraphQL schema used by the Metadata API organizes content and assets on Tableau Cloud and Tableau Server by grouping them by object and role. These objects and their roles are the foundation to your GraphQL queries. #### Parent object and role Parent objects, a mix of both content and assets, can be managed independently of other objects and play the role of a container. Parent objects can refer to other parent objects, can refer to child objects, and can also own child objects. **Example parent objects** - Databases - Tables - Published data sources - Virtual connections - Virtual connection tables - Workbooks - Flows - Sites - Projects - Users #### Child object and role Child objects, also a mix of both content and assets, cannot be managed independently of their parent object. Therefore, child objects play a dependent role on their parent object. Some child objects can own other child objects, can refer to other child objects, and in some cases, refer to certain parent objects. **Example child objects** - Columns - Fields - Embedded data sources - Sheets - Parameters - Data source filters #### Parent/child object relationship The GraphQL schema defines the parent/child object relationship by what the objects can contain. In other words, an object is a parent object when it functions as a container for other (child) objects. Some examples of such relationships are below. **Example parent/child relationships** - Database - DatabaseTable - Column - PublishedDatasource - Field - DataSourceFilter - Parameter - DataQualityWarning - DataQualityCertification - Workbook - View - EmbeddedDatasource - Field - Parameters ### Object types and attributes The GraphQL schema organizes objects into interfaces and types. - An **interface** defines a list of attributes (known as “fields” in GraphQL) that are required for that interface. - A **type** implements an interface, and may define additional attributes. In other words, an **interface** serves as template (of sorts) for a **type**, in that it defines a list of attributes that will be common to all types that are based on it. Any **type** that uses the **interface** as a template (we say that “the **type** implements the **interface**”) will contain all the common attributes of the **interface**, plus any other attributes added by the **type**. For more information on GraphQL interfaces, objects, and fields, see [Schemas and Types \[↗\]](https://graphql.org/learn/schema/) in the [GraphQL documentation \[↗\]](http://www.graphql.org). **Examples of interfaces, types, and attributes** The table below captures some example interfaces, some example attributes (fields) they must contain, some types that implement that interface, and some attributes that the type adds.
Interface Interface attributes Type that implements the interface Fields added to those required by interface
Database CertificationNote
certifier
connectionType
contact
dataQualityCertifications
dataQualityWarning
dataQualityWarnings
description
downstreamDashboards
downstreamDatabases
downstreamDatasources
downstreamFlows
downstreamLenses
downstreamMetrics
downstreamOwners
downstreamSheets
downstreamTables
downstreamVirtualConnections
downstreamVirtualConnectionTables
downstreamWorkbooks
hasActiveWarning
id
isCertified
isControlledPermissionsEnabled
isEmbedded
isGrouped
luid
name
tags
upstreamDatabases
upstreamDataQualityWarnings
upstreamDatasources
upstreamFlows
upstreamTables
upstreamVirtualConnections
upstreamVirtualConnectionTables
vizportalId
 CloudFile fileExtension
fileId
mimeType
provider
requestUrl
DatabaseServer extendedConnectionType
hostName
port
service
File filePath
WebDataConnector connectorUrl
Table columns
description
downstreamDashboards
downstreamDatabases
downstreamDatasources
downstreamFlows
downstreamLenses
downstreamMetrics
downstreamOwners
downstreamSheets
downstreamTables
downstreamVirtualConnections
downstreamVirtualConnectionTables
downstreamWorkbooks
id
isEmbedded
name
upstreamDatabases
upstreamDatasources
upstreamFlows
upstreamTables
upstreamVirtualConnections
upstreamVirtualConnectionTables		 VirtualConnectionTable containsUnsupportedCustomSql
dataQualityCertifications
dataQualityWarnings
extractLastRefreshedAt
extractLastRefreshType
hasActiveWarning
isCertified
isExtracted
luid
owner
tags
upstreamDataQualityWarnings
uri
vizportalId
vizportalUrlId
DatabaseTable certificationNote
certifier
connectionType
contact
database
dataQualityCertifications
dataQualityWarning
dataQualityWarnings
fullName
hasActiveWarning
isCertified
luid
schema
tags
upstreamDataQualityWarnings
vizportalId
CustomSQLTable connectionType
database
isUnsupportedCustomSql
query
tables
### Other objects related to Tableau content and assets **Lineage shortcut objects** The Metadata API enables you to see relationships between the content and asset that you’re evaluating with other items on your Tableau Cloud site or Tableau Server. These items include the following: - Upstream and downstream content - including data sources, workbooks, sheets, virtual connections, virtual connection tables, fields, flows, and owners - Upstream and downstream assets - including databases, tables, and columns You can quickly access this type of information by using _shortcut_ objects defined in the GraphQL schema. These lineage or relationship objects use the _upstream_ or _downstream_ prefix. For example, you can use `upstreamTablesConnection` to query the tables used by a data source, use `downstreamSheetsConnection` to query sheets used by a workbook, or `upstreamLinkedFlows` and `downstreamLinkedFlows` to query flows that are directly upstream or downstream of one another. For an example query that uses lineage shortcut, see [Filtering](/current/api/metadata_api/en-us/docs/meta_api_examples.html#filtering) section in the Example Queries topic. For more information about linked flows, see [Working with linked flow objects](#linkedtasks_flows) below. **Pagination objects** The Metadata API enables you to traverse through relationships within the data that you’re querying using pagination. The GraphQL schema defines pagination objects as those objects that use the **Connection** suffix. For example, you can use the `databasesConnection` to get a list of paginated results of database assets on your Tableau Cloud site or Tableau Server. For an example query that uses pagination, see [Pagination](/current/api/metadata_api/en-us/docs/meta_api_examples.html#pagination) section in the Example Queries topic. **Inherited objects** You can query description attributes of fields using the Metadata API. These description attributes can be inherited from other upstream objects. For example, a field attribute can be inherited from an upstream column in a table or from an upstream data source authored in Tableau Desktop. Beginning in version 2021.2, you can include a description inheritance object, `descriptionInherited`, in your query to return supplemental description information inherited from the closest upstream object. For an example query that uses the description inheritance object, see [Inheritance](/current/api/metadata_api/en-us/docs/meta_api_examples.html#inheritance) section in the Examples Queries topic. ## Tableau metadata model Together, all objects, the roles they play, the relationships they have with each other and their attributes and properties define the metadata model for a particular set of objects. The metadata model is a snapshot (or in GraphQL terms, a graph) of how Tableau interprets and relates a set of objects on your Tableau Cloud site or Tableau Server. From the metadata model, you can understand the dependencies and relationships in your data. To see how the metadata model used by the Metadata API works, review the following example scenarios. ### Example metadata model Suppose you have three workbooks (parent objects) and two data sources (parent objects) published to Tableau Cloud or Tableau Server. ![Example scenario on Tableau Cloud or Tableau Server](/current/api/metadata_api/en-us/docs/assets/ex_assets_server.png) For this scenario, the two published data source objects refer to the three workbook objects. The workbook objects own four sheet objects. These sheet objects in turn refer to two field objects that are owned by the published data source objects. Here’s what the metadata model for this scenario might look like. ![Example of metadata model for this scenario](/current/api/metadata_api/en-us/docs/assets/ex_assets_all.png) **Notes:** - A sold line with an arrow indicates a ownership relationship. - A dotted line indicates a reference relationship. ### Example scenario 1: Impact analysis In an impact analysis scenario, the metadata model can help you answer how data might be affected if a part of the metadata model changes. In this scenario, you might want to know what could happen if the published data source, _John County - 1_, is deleted. As you know now from the metadata model, sheet objects are owned by workbook objects, and sheet objects can refer to the field objects. In this scenario, the field objects are owned by the published data source objects. Published data source objects own field objects. Therefore, if _John County - 1_ is deleted, the child objects, F1, Hills Library, and Garden Library, are directly affected and their existence compromised because of their dependency on that data source object. The other child objects, F2, Garden Senior Center, and Cliff Senior Center, though they might be affected by the data source object being deleted, their existence is not compromised. ![Example of metadata model when published data source, John County - 1, is deleted](/current/api/metadata_api/en-us/docs/assets/ex_assets_impact.png) During this analysis, you can see that because _John County - 1_ doesn’t own the workbook objects that connect to it, the workbook objects themselves, both _Sakura District_ and _Maple District_ can continue to exist in the absence of the published data source object. ### Example scenario 2: Lineage analysis In a lineage flow analysis scenario, you can look at particular part of the metadata model and identify where the data is coming from and how the data reacts or is affected by different parts of the metadata model. In this scenario, you might want to know where a data point from a sheet object, _Garden Senior Center_, in a workbook object, _Maple District_, is coming from. Based on what you know from the metadata model, attributes are inherited from the parent object . Therefore, if you start from _Garden Senior Center_ sheet object, you can move to the referring field object, F2, to see that it’s owned by a published data source object. In this case, _John County - 2_ is the source for the data point. ![Example of metadata model with a focus on a sheet, Garden Senior Center](/current/api/metadata_api/en-us/docs/assets/ex_assets_lineage.png) During this analysis, you are able to freely include or exclude parts of the metadata model in order to understand the lineage flow for _Garden Senior Center_. For example, you can choose to exclude _Garden Library_ sheet object even though it’s also owned by the same workbook object, _Maple District_. ### Additional notes about the metadata model **Using custom SQL** The metadata model interprets customSQL queries as tables. When custom SQL queries are defined in your data source or flow, the queries have to fit a set of criteria to be recognized and interpreted by the Metadata API. For more information, see [Tableau Catalog support for custom SQL \[↗\]](https://help.tableau.com/current/pro/desktop/en-us/customsql.htm#tableau-catalog-support-for-custom-sql) in the Tableau Help. For programmatic methods to determine if the custom SQL used in a data source or flow is unsupported, see the isUnsupportedCustomSql and containsUnsupportedCustomSql booleans in the API reference. **Using the databaseTable object in a query** When you run a query using the [databaseTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable.doc.html) object, for some databases, the schema attribute might not return the correct schema name for the table. This issue can occur when the selected schema, while creating or editing a data source, workbook, or flow, is changed after adding the table. When the selected schema changes after adding the table, the schema attribute your query returns is the name of the last selected schema instead of the actual schema that the table is using. Databases that might return the incorrect schema in the scenario described above include Amazon Athena and Exasol. **When workbook lineage query results are missing upstream databases** When you run a lineage query to determine upstream databases (D1 and D2) from a workbook (WB), only the databases (D1) whose fields (F1) are used in a workbook’s sheet (S) are returned. Databases (D2) that might be referenced by the workbook, but whose fields aren’t used by a sheet directly, won’t show as upstream. ![Example of a workbook with a focus on its upstream database](/current/api/metadata_api/en-us/docs/assets/shortcuts_ex_wb_to_db.png) **Running a tags query** Unless you’re a Tableau Cloud site or Tableau Server admin, by default, results from a tags query that uses the asset attribute are obfuscated to block all sensitive data. Results are always obfuscated, whether you have the appropriate permissions to see the associated object’s metadata or not. To see the associated object’s metadata that you have the appropriate permissions to see, you can replace the asset attribute with a type-specific attribute instead. For example, suppose you have permissions to see WorkbookA. You run the following tags query, which uses the asset attribute to return all objects that use tags. ``` { tags { assets { id name } } } ``` In this example, the query returns two workbooks with its results obfuscated. ``` { tags { assets { { id: "A", name: null } { id: "B", name: null } } } } ``` Because results are always obfuscated when you use the asset attribute in a tags query, you can modify the query to be type specific to return the results you expect. In this example, you can run a query using the workbook type instead. ``` { tags { workbooks { id name } } ``` When you modify the tags query to be type specific, the query returns the tags metadata for WorkbookA. ``` { tags { workbooks { { id: "A", name: "WorkbookA" } { id: "B", name: null } } } ``` **Working with linked flow objects** Unlike `upstreamFlows` and `downstreamFlows` objects, which return all upstream and downstream flows, queries that include `upstreamLinkedFlows` and `downstreamLinkedFlows` objects return additional structural metadata about upstream and downstream flows. The `upstreamLinkedFlows` and `downstreamLinkedFlows` objects can provide information about order, distance, and relationship between flows that are directly upstream and downstream of one another. For example, suppose you have a flow called Superstore. You can run the following query to compare the information returned for the flows upstream of the Superstore flow. ``` query upstreamflows_vs_upstreamlinkedflows { flows(filter: {name:"Superstore_AllUp"}) { name id upstreamFlows{ name id } upstreamLinkedFlows{ asset{ name id } toEdges fromEdges } } } ``` The above query returns the following information. ``` { "data": { "flows": [ { "name": "Superstore_Customers", "id": "089839c4-7edd-b887-3178-fcc2367e938b", "upstreamFlows": [ { "name": "Superstore_Pods", "id": "66e8f90d-f02d-eea1-850e-2014b4b09b96" }, { "name": "Superstore_Marketing", "id": "7efe5f86-511b-760b-18d4-1a6a28c220b5" }, { "name": "Superstore_Operations", "id": "cd79250f-bc27-1d9d-7b22-aca1534863e1" }, { "name": "Superstore_Sales", "id": "e78d4c54-df3a-12a9-ef1a-9849c2625b35" } ], "upstreamLinkedFlows": [ { "asset": { "name": "Superstore_Customers", "id": "089839c4-7edd-b887-3178-fcc2367e938b" }, "toEdges": [ "e78d4c54-df3a-12a9-ef1a-9849c2625b35", "7efe5f86-511b-760b-18d4-1a6a28c220b5", "cd79250f-bc27-1d9d-7b22-aca1534863e1" ], "fromEdges": [] }, { "asset": { "name": "Superstore_Sales", "id": "e78d4c54-df3a-12a9-ef1a-9849c2625b35" }, "toEdges": [ "cd79250f-bc27-1d9d-7b22-aca1534863e1" ], "fromEdges": [ "089839c4-7edd-b887-3178-fcc2367e938b" ] }, { "asset": { "name": "Superstore_Marketing", "id": "7efe5f86-511b-760b-18d4-1a6a28c220b5" }, "toEdges": [], "fromEdges": [ "089839c4-7edd-b887-3178-fcc2367e938b" ] }, { "asset": { "name": "Superstore_Operations", "id": "cd79250f-bc27-1d9d-7b22-aca1534863e1" }, "toEdges": [ "66e8f90d-f02d-eea1-850e-2014b4b09b96" ], "fromEdges": [ "089839c4-7edd-b887-3178-fcc2367e938b", "e78d4c54-df3a-12a9-ef1a-9849c2625b35" ] }, { "asset": { "name": "Superstore_Pods", "id": "66e8f90d-f02d-eea1-850e-2014b4b09b96" }, "toEdges": [], "fromEdges": [ "cd79250f-bc27-1d9d-7b22-aca1534863e1" ] } ] } ] }, } ``` - From the upstreamFlows object, the following upstream flows are returned: Superstore\_Pods, Superstore\_Marketing, Superstore\_Operations, and Superstore\_Sales. - Whereas, from the upstreamLinkedFlows object, the following information is returned: - From the `asset` parameter, you see Superstore\_Customers is returned. This is the source flow or the flow from which you want to understand its relationship to other flows. - From the `fromEdges` parameter, you see three direct flows that Superstore\_Customer links from: Superstore\_Marketing, Superstore\_Operations, and Superstore\_Sales. In addition, you see additional flow relationships information about those three direct flows. - Superstore\_Marketing, `fromEdges` parameter shows Superstore\_Customers as its direct upstream flow and the `toEdges` parameter shows no direct downstream flows. - Superstore\_Operations, `toEdges` shows both Superstore\_Customers and Superstore\_Sales as its direct upstream flows and `toEdges` shows Superstore\_Pods directly downstream of it. - From the `toEdges` parameter, you see that Superstore\_Customers has no direct flows it links to. In other words, Superstore\_Customers is at the bottom of its relationship chain. ![Example of structual metadata returned from linked flows object](/current/api/metadata_api/en-us/docs/assets/shortcuts_linked_flows.png) _menu_ Types INTERFACE # View A view contained in a published workbook. Views can be sheets or dashboards. ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - interface View { - # Unique identifier used by the metadata API. Not the same as the numeric ID used - # on server - id: [ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html)! - # Name shown in server and desktop clients - name: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Unique ID for the view generated for and stored within the workbook, survives - # renames, and is used for internal processes - documentViewId: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Locally unique identifier used for the REST API on the Tableau Server (Blank if - # sheet is hidden in Workbook) - luid: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)! - # Server path to view - path: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Time the view was created - createdAt: [DateTime](https://help.tableau.com/current/api/metadata_api/en-us/reference/datetime.doc.html)! - # Time the view was updated - updatedAt: [DateTime](https://help.tableau.com/current/api/metadata_api/en-us/reference/datetime.doc.html)! - # Index of view; the order it appears in the workbook - index: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html) - # Tags associated with the view - # - # 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/current/api/metadata_api/en-us/reference/tag_filter.doc.html), orderBy: [TagSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tagsortorder.doc.html)): [[Tag](https://help.tableau.com/current/api/metadata_api/en-us/reference/tag.doc.html)!]! - # Tags associated with the view - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Tag_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/tag_filter.doc.html), - orderBy: [TagSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tagsortorder.doc.html) - ): [TagsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/tagsconnection.doc.html) - # Data quality warnings upstream from this view - # - # 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/current/api/metadata_api/en-us/reference/dataqualitywarning_filter.doc.html), - orderBy: [DataQualityWarningSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarningsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DataQualityWarning](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarning.doc.html)!]! - # Data quality warnings upstream from this view - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DataQualityWarning_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarning_filter.doc.html), - orderBy: [DataQualityWarningSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarningsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DataQualityWarningsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarningsconnection.doc.html) - # Labels upstream from this view. 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/current/api/metadata_api/en-us/reference/label_filter.doc.html), - orderBy: [LabelSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/labelsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Label](https://help.tableau.com/current/api/metadata_api/en-us/reference/label.doc.html)!]! - # Labels upstream from this view. 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Label_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/label_filter.doc.html), - orderBy: [LabelSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/labelsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [LabelsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/labelsconnection.doc.html) - # The workbook that contains this view - workbook: [Workbook](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbook.doc.html) - # The Metrics that reference this View - # - # 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. - referencedByMetrics( - filter: [Metric_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metric_filter.doc.html), - orderBy: [MetricSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Metric](https://help.tableau.com/current/api/metadata_api/en-us/reference/metric.doc.html)] - # The Metrics that reference this View - # - # 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. - referencedByMetricsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Metric_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metric_filter.doc.html), - orderBy: [MetricSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [MetricsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricsconnection.doc.html) - } ` ## [_link_](#require-by) Require by - [Dashboard_A dashboard contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard.doc.html "Dashboard - A dashboard contained in a published workbook.") - [Metric_Metrics are time series data constructed from fields contained in views. \*Retired in Tableau Cloud February 2024 / Server 2024.2.\*_](metric.doc.html "Metric - Metrics are time series data constructed from fields contained in views. *Retired in Tableau Cloud February 2024 / Server 2024.2.*") - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/api/metadata_api/en-us/reference/query.doc.html "Query - Query root for Metadata GraphQL interface") - [Sheet_A sheet contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html "Sheet - A sheet contained in a published workbook.") - [Tag_A tag associated with content items_](https://help.tableau.com/current/api/metadata_api/en-us/reference/tag.doc.html "Tag - A tag associated with content items") - [ViewsConnection_Connection Type for View_](https://help.tableau.com/current/api/metadata_api/en-us/reference/viewsconnection.doc.html "ViewsConnection - Connection Type for View") - [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/current/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).") _menu_ Types INPUT\_OBJECT # View\_Filter Filter by GraphQL field and given value ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input View_Filter { - # Server path to view - path: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Server path to view - pathWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)] - # Locally unique identifier used for the REST API on the Tableau Server (Blank if - # sheet is hidden in Workbook) - luid: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Locally unique identifier used for the REST API on the Tableau Server (Blank if - # sheet is hidden in Workbook) - luidWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)] - # Unique ID for the view generated for and stored within the workbook, survives - # renames, and is used for internal processes - documentViewId: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Unique ID for the view generated for and stored within the workbook, survives - # renames, and is used for internal processes - documentViewIdWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)] - # Name shown in server and desktop clients - name: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Name shown in server and desktop clients - nameWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.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/current/api/metadata_api/en-us/reference/id.doc.html) - # Unique identifier used by the metadata API. Not the same as the numeric ID used - # on server - idWithin: [[ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html)] - } ` ## [_link_](#require-by) Require by - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/api/metadata_api/en-us/reference/query.doc.html "Query - Query root for Metadata GraphQL interface") - [Tag_A tag associated with content items_](https://help.tableau.com/current/api/metadata_api/en-us/reference/tag.doc.html "Tag - A tag associated with content items") - [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/current/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).") _menu_ Types ENUM # ViewOrderField Enum for fields that can be used for sorting ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - enum ViewOrderField { - # Sort by documentViewId - DOCUMENT_VIEW_ID - # Sort by id - ID - # Sort by luid - LUID - # Sort by name - NAME - # Sort by path - PATH - } ` ## [_link_](#require-by) Require by - [ViewSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/viewsortorder.doc.html "ViewSortOrder - 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.") _menu_ Types OBJECT # ViewsConnection Connection Type for View ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type ViewsConnection { - # List of nodes - nodes: [[View](https://help.tableau.com/current/api/metadata_api/en-us/reference/view.doc.html)!]! - # Information for pagination - pageInfo: [PageInfo](https://help.tableau.com/current/api/metadata_api/en-us/reference/pageinfo.doc.html)! - # Total number of objects in connection - totalCount: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html)! - } ` ## [_link_](#require-by) Require by - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/api/metadata_api/en-us/reference/query.doc.html "Query - Query root for Metadata GraphQL interface") - [Tag_A tag associated with content items_](https://help.tableau.com/current/api/metadata_api/en-us/reference/tag.doc.html "Tag - A tag associated with content items") - [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/current/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).") _menu_ Types INPUT\_OBJECT # ViewSortOrder 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. ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input ViewSortOrder { - # GraphQL field to sort on - field: [ViewOrderField](https://help.tableau.com/current/api/metadata_api/en-us/reference/vieworderfield.doc.html)! - # Order direction to sort output - direction: [OrderDirection](https://help.tableau.com/current/api/metadata_api/en-us/reference/orderdirection.doc.html)! - } ` ## [_link_](#require-by) Require by - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/api/metadata_api/en-us/reference/query.doc.html "Query - Query root for Metadata GraphQL interface") - [Tag_A tag associated with content items_](https://help.tableau.com/current/api/metadata_api/en-us/reference/tag.doc.html "Tag - A tag associated with content items") - [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/current/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).") _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/current/api/metadata_api/en-us/reference/certifiable.doc.html), [Warnable](https://help.tableau.com/current/api/metadata_api/en-us/reference/warnable.doc.html), [CanHaveLabels](https://help.tableau.com/current/api/metadata_api/en-us/reference/canhavelabels.doc.html), [Taggable](https://help.tableau.com/current/api/metadata_api/en-us/reference/taggable.doc.html) { - # Connection type of this virtual connection - connectionType: [String](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnectionTable](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnectionTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionTablesConnection](https://help.tableau.com/current/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/current/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/current/api/metadata_api/en-us/reference/string.doc.html)! - # Vizportal URL ID; used for URL generation - vizportalUrlId: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)! - # Uri of the virtual connection - uri: [String](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/string.doc.html)! - # Name shown in server and desktop clients - name: [String](https://help.tableau.com/current/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/current/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/current/api/metadata_api/en-us/reference/datetime.doc.html) - # The site which contains this virtual connection - site: [TableauSite](https://help.tableau.com/current/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/current/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/current/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/current/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/current/api/metadata_api/en-us/reference/string.doc.html) - # User modifiable description of this virtual connection - description: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # User who owns this virtual connection - owner: [TableauUser](https://help.tableau.com/current/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/current/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/current/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/current/api/metadata_api/en-us/reference/dataqualitywarning_filter.doc.html), - orderBy: [DataQualityWarningSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarningsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DataQualityWarning](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DataQualityWarning_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarning_filter.doc.html), - orderBy: [DataQualityWarningSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarningsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DataQualityWarningsConnection](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/dataqualitycertification_filter.doc.html), - orderBy: [DataQualityCertificationSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitycertificationsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DataQualityCertification](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DataQualityCertification_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitycertification_filter.doc.html), - orderBy: [DataQualityCertificationSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitycertificationsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DataQualityCertificationsConnection](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/label_filter.doc.html), - orderBy: [LabelSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/labelsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Label](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Label_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/label_filter.doc.html), - orderBy: [LabelSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/labelsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [LabelsConnection](https://help.tableau.com/current/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/current/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/current/api/metadata_api/en-us/reference/tag_filter.doc.html), orderBy: [TagSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tagsortorder.doc.html)): [[Tag](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Tag_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/tag_filter.doc.html), - orderBy: [TagSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tagsortorder.doc.html) - ): [TagsConnection](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Database](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Database_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabasesConnection](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DatabaseTable](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabaseTablesConnection](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnectionTable](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnectionTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionTablesConnection](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Flow](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Flow_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FlowsConnection](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[PublishedDatasource](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [PublishedDatasource_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [PublishedDatasourcesConnection](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/dataqualitywarning_filter.doc.html), - orderBy: [DataQualityWarningSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarningsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DataQualityWarning](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DataQualityWarning_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarning_filter.doc.html), - orderBy: [DataQualityWarningSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarningsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DataQualityWarningsConnection](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/label_filter.doc.html), - orderBy: [LabelSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/labelsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Label](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Label_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/label_filter.doc.html), - orderBy: [LabelSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/labelsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [LabelsConnection](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Flow](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Flow_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FlowsConnection](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/workbook_filter.doc.html), - orderBy: [WorkbookSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Workbook](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Workbook_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbook_filter.doc.html), - orderBy: [WorkbookSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [WorkbooksConnection](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[PublishedDatasource](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [PublishedDatasource_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [PublishedDatasourcesConnection](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/lens_filter.doc.html), - orderBy: [LensSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/lenssortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Lens](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Lens_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/lens_filter.doc.html), - orderBy: [LensSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/lenssortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [LensesConnection](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Sheet](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Sheet_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [SheetsConnection](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/dashboard_filter.doc.html), - orderBy: [DashboardSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboardsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Dashboard](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Dashboard_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard_filter.doc.html), - orderBy: [DashboardSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboardsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DashboardsConnection](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnectionTable](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnectionTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionTablesConnection](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/metric_filter.doc.html), - orderBy: [MetricSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Metric](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Metric_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metric_filter.doc.html), - orderBy: [MetricSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [MetricsConnection](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/tableauuser_filter.doc.html), - orderBy: [TableauUserSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauusersortorder.doc.html) - ): [[TableauUser](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [TableauUser_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauuser_filter.doc.html), - orderBy: [TableauUserSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauusersortorder.doc.html) - ): [TableauUsersConnection](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/metricdefinition_filter.doc.html), - orderBy: [MetricDefinitionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[MetricDefinition](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [MetricDefinition_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinition_filter.doc.html), - orderBy: [MetricDefinitionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [MetricDefinitionsConnection](https://help.tableau.com/current/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/current/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/current/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/current/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/current/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/current/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/current/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/current/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/current/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/current/api/metadata_api/en-us/reference/database.doc.html "Database - A database containing tables") - [DatabaseServer_A database server connection_](https://help.tableau.com/current/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/current/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/current/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/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [File_A file connection_](https://help.tableau.com/current/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/current/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/current/api/metadata_api/en-us/reference/flowcolumnoutputfield.doc.html "FlowColumnOutputField - Column output field implementation") - [FlowFieldOutputField_Field output field implementation_](https://help.tableau.com/current/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/current/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/current/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/current/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/current/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/current/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/current/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/current/api/metadata_api/en-us/reference/table.doc.html "Table - A table containing columns") - [TableauSite_Site on Tableau server_](https://help.tableau.com/current/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/current/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/current/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/current/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/current/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/current/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).") _menu_ Types INPUT\_OBJECT # VirtualConnection\_Filter Filter by GraphQL field and given value ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input VirtualConnection_Filter { - # Vizportal URL ID; used for URL generation - vizportalUrlId: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Vizportal URL ID; used for URL generation - vizportalUrlIdWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)] - # True if the virtual connection has an active data quality warning - hasActiveWarning: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) - # True if the virtual connection has an active data quality warning - hasActiveWarningWithin: [[Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html)] - # Locally unique identifier used for the REST API on the Tableau Server - luid: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Locally unique identifier used for the REST API on the Tableau Server - luidWithin: [[String](https://help.tableau.com/current/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/current/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. - containerNameWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)] - # True if this virtual connection contains an active data quality certification - isCertified: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) - # True if this virtual connection contains an active data quality certification - isCertifiedWithin: [[Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html)] - # Name shown in server and desktop clients - name: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Name shown in server and desktop clients - nameWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.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/current/api/metadata_api/en-us/reference/id.doc.html) - # Unique identifier used by the metadata API. Not the same as the numeric ID used - # on server - idWithin: [[ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html)] - # The name of the project that contains this virtual connection. - projectName: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # The name of the project that contains this virtual connection. - projectNameWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)] - # Connection type of this virtual connection - connectionType: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Connection type of this virtual connection - connectionTypeWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.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/current/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/current/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/current/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/current/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/current/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/current/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/current/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/current/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/current/api/metadata_api/en-us/reference/database.doc.html "Database - A database containing tables") - [DatabaseServer_A database server connection_](https://help.tableau.com/current/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/current/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/current/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/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [File_A file connection_](https://help.tableau.com/current/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/current/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/current/api/metadata_api/en-us/reference/flowcolumnoutputfield.doc.html "FlowColumnOutputField - Column output field implementation") - [FlowFieldOutputField_Field output field implementation_](https://help.tableau.com/current/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/current/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/current/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/current/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/current/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/current/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/current/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/current/api/metadata_api/en-us/reference/table.doc.html "Table - A table containing columns") - [TableauSite_Site on Tableau server_](https://help.tableau.com/current/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/current/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/current/api/metadata_api/en-us/reference/tag.doc.html "Tag - A tag associated with content items") - [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/current/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/current/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).") _menu_ Types ENUM # VirtualConnectionOrderField Enum for fields that can be used for sorting ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - enum VirtualConnectionOrderField { - # Sort by downstreamDatasources count - DOWNSTREAM_DATASOURCES_COUNT - # Sort by downstreamWorkbooks count - DOWNSTREAM_WORKBOOKS_COUNT - # Sort by owner count - OWNER_COUNT - # Sort by connectionType - CONNECTION_TYPE - # Sort by containerName - CONTAINER_NAME - # Sort by hasActiveWarning - HAS_ACTIVE_WARNING - # Sort by id - ID - # Sort by isCertified - IS_CERTIFIED - # Sort by luid - LUID - # Sort by name - NAME - # Sort by projectName - PROJECT_NAME - # Sort by vizportalUrlId - VIZPORTAL_URL_ID - } ` ## [_link_](#require-by) Require by - [VirtualConnectionSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html "VirtualConnectionSortOrder - 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.") _menu_ Types OBJECT # VirtualConnectionsConnection Connection Type for VirtualConnection ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type VirtualConnectionsConnection { - # List of nodes - nodes: [[VirtualConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection.doc.html)!]! - # Information for pagination - pageInfo: [PageInfo](https://help.tableau.com/current/api/metadata_api/en-us/reference/pageinfo.doc.html)! - # Total number of objects in connection - totalCount: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.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/current/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/current/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/current/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/current/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/current/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/current/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/current/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/current/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/current/api/metadata_api/en-us/reference/database.doc.html "Database - A database containing tables") - [DatabaseServer_A database server connection_](https://help.tableau.com/current/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/current/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/current/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/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [File_A file connection_](https://help.tableau.com/current/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/current/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/current/api/metadata_api/en-us/reference/flowcolumnoutputfield.doc.html "FlowColumnOutputField - Column output field implementation") - [FlowFieldOutputField_Field output field implementation_](https://help.tableau.com/current/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/current/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/current/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/current/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/current/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/current/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/current/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/current/api/metadata_api/en-us/reference/table.doc.html "Table - A table containing columns") - [TableauSite_Site on Tableau server_](https://help.tableau.com/current/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/current/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/current/api/metadata_api/en-us/reference/tag.doc.html "Tag - A tag associated with content items") - [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/current/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/current/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).") _menu_ Types INPUT\_OBJECT # VirtualConnectionSortOrder 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. ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input VirtualConnectionSortOrder { - # GraphQL field to sort on - field: [VirtualConnectionOrderField](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionorderfield.doc.html)! - # Order direction to sort output - direction: [OrderDirection](https://help.tableau.com/current/api/metadata_api/en-us/reference/orderdirection.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/current/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/current/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/current/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/current/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/current/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/current/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/current/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/current/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/current/api/metadata_api/en-us/reference/database.doc.html "Database - A database containing tables") - [DatabaseServer_A database server connection_](https://help.tableau.com/current/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/current/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/current/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/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [File_A file connection_](https://help.tableau.com/current/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/current/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/current/api/metadata_api/en-us/reference/flowcolumnoutputfield.doc.html "FlowColumnOutputField - Column output field implementation") - [FlowFieldOutputField_Field output field implementation_](https://help.tableau.com/current/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/current/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/current/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/current/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/current/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/current/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/current/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/current/api/metadata_api/en-us/reference/table.doc.html "Table - A table containing columns") - [TableauSite_Site on Tableau server_](https://help.tableau.com/current/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/current/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/current/api/metadata_api/en-us/reference/tag.doc.html "Tag - A tag associated with content items") - [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/current/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/current/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).") _menu_ Types OBJECT # VirtualConnectionTable A table in a virtual connection. _Available in Tableau Cloud March 2022 / Server 2022.1 and later._ ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type VirtualConnectionTable implements [Table](https://help.tableau.com/current/api/metadata_api/en-us/reference/table.doc.html), [Certifiable](https://help.tableau.com/current/api/metadata_api/en-us/reference/certifiable.doc.html), [Warnable](https://help.tableau.com/current/api/metadata_api/en-us/reference/warnable.doc.html), [CanHaveLabels](https://help.tableau.com/current/api/metadata_api/en-us/reference/canhavelabels.doc.html), [Taggable](https://help.tableau.com/current/api/metadata_api/en-us/reference/taggable.doc.html) { - # Vizportal ID of this column, for use in client-to-server communications - vizportalId: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Uri of the virtual connection table - uri: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # VizPortal URL ID; used for URL generation - vizportalUrlId: [String](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/string.doc.html)! - # Whether or not queries to this table are using an extract. - isExtracted: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) - # True if the datasource contains unsupported custom SQL, in which case lineage - # may be incomplete - containsUnsupportedCustomSql: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) - # The time the data for this table's extract was refreshed. - extractLastRefreshedAt: [DateTime](https://help.tableau.com/current/api/metadata_api/en-us/reference/datetime.doc.html) - # The type of this table's last extract refresh (incremental or full). - extractLastRefreshType: [ExtractType](https://help.tableau.com/current/api/metadata_api/en-us/reference/extracttype.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/current/api/metadata_api/en-us/reference/id.doc.html)! - # Name shown in server and desktop clients - name: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # True if this table is embedded in Tableau content, e.g., a packaged workbook - isEmbedded: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) - # User modifiable description of this table - description: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # User who owns this virtual connection table - owner: [TableauUser](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauuser.doc.html)! - # True if the table has an active data quality warning - hasActiveWarning: [Boolean](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/dataqualitywarning.doc.html) @deprecated( reason: "Use 'dataQualityWarnings'" ) - # The data quality warnings on a virtual connection table - # - # 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/current/api/metadata_api/en-us/reference/dataqualitywarning_filter.doc.html), - orderBy: [DataQualityWarningSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarningsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DataQualityWarning](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarning.doc.html)!]! - # The data quality warnings on a virtual connection table - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DataQualityWarning_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarning_filter.doc.html), - orderBy: [DataQualityWarningSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarningsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DataQualityWarningsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarningsconnection.doc.html) - # The data quality certifications on a virtual connection table - # - # 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/current/api/metadata_api/en-us/reference/dataqualitycertification_filter.doc.html), - orderBy: [DataQualityCertificationSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitycertificationsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DataQualityCertification](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitycertification.doc.html)!]! - # The data quality certifications on a virtual connection table - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DataQualityCertification_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitycertification_filter.doc.html), - orderBy: [DataQualityCertificationSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitycertificationsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DataQualityCertificationsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitycertificationsconnection.doc.html) - # True if this virtual connection table contains an active data quality - # certification - isCertified: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html)! - # The labels on a virtual connection table. 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/current/api/metadata_api/en-us/reference/label_filter.doc.html), - orderBy: [LabelSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/labelsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Label](https://help.tableau.com/current/api/metadata_api/en-us/reference/label.doc.html)!]! - # The labels on a virtual connection table. 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Label_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/label_filter.doc.html), - orderBy: [LabelSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/labelsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [LabelsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/labelsconnection.doc.html) - # Tags associated with this table - # - # 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/current/api/metadata_api/en-us/reference/tag_filter.doc.html), orderBy: [TagSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tagsortorder.doc.html)): [[Tag](https://help.tableau.com/current/api/metadata_api/en-us/reference/tag.doc.html)!]! - # Tags associated with this table - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Tag_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/tag_filter.doc.html), - orderBy: [TagSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tagsortorder.doc.html) - ): [TagsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/tagsconnection.doc.html) - # Columns contained by this table - # - # 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. - columns( - filter: [Column_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/column_filter.doc.html), - orderBy: [ColumnSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Column](https://help.tableau.com/current/api/metadata_api/en-us/reference/column.doc.html)!]! - # Columns contained by this table - # - # 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. - columnsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Column_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/column_filter.doc.html), - orderBy: [ColumnSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [ColumnsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/columnsconnection.doc.html) - # Databases upstream of this table - # - # 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/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Database](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html)!]! - # Databases upstream of this table - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Database_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabasesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesconnection.doc.html) - # Tables upstream of this table - # - # 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/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DatabaseTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable.doc.html)!]! - # Tables upstream of this table - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabaseTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesconnection.doc.html) - # Flows upstream of this table - # - # 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/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Flow](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow.doc.html)!]! - # Flows upstream of this table - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Flow_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FlowsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsconnection.doc.html) - # Datasources upstream of this table - # - # 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/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[PublishedDatasource](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource.doc.html)!]! - # Datasources upstream of this table - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [PublishedDatasource_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [PublishedDatasourcesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesconnection.doc.html) - # Virtual connection tables upstream of this table - # - # 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/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnectionTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable.doc.html)!]! - # Virtual connection tables upstream of this table - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnectionTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesconnection.doc.html) - # Virtual connections upstream of this table - # - # 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. - upstreamVirtualConnections( - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection.doc.html)!]! - # Virtual connections upstream of this table - # - # 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. - upstreamVirtualConnectionsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsconnection.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/current/api/metadata_api/en-us/reference/dataqualitywarning_filter.doc.html), - orderBy: [DataQualityWarningSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarningsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DataQualityWarning](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DataQualityWarning_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarning_filter.doc.html), - orderBy: [DataQualityWarningSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarningsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DataQualityWarningsConnection](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/label_filter.doc.html), - orderBy: [LabelSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/labelsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Label](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Label_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/label_filter.doc.html), - orderBy: [LabelSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/labelsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [LabelsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/labelsconnection.doc.html) - # Databases downstream of this table - # - # 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. - downstreamDatabases( - filter: [Database_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Database](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html)!]! - # Databases downstream of this table - # - # 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. - downstreamDatabasesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Database_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabasesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesconnection.doc.html) - # Tables downstream of this table - # - # 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. - downstreamTables( - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DatabaseTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable.doc.html)!]! - # Tables downstream of this table - # - # 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. - downstreamTablesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabaseTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesconnection.doc.html) - # Virtual connection tables downstream of this table - # - # 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/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnectionTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable.doc.html)!]! - # Virtual connection tables downstream of this table - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnectionTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesconnection.doc.html) - # Virtual connections downstream of this table - # - # 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. - downstreamVirtualConnections( - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection.doc.html)!]! - # Virtual connections downstream of this table - # - # 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. - downstreamVirtualConnectionsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsconnection.doc.html) - # Flows downstream of this table - # - # 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/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Flow](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow.doc.html)!]! - # Flows downstream of this table - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Flow_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FlowsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsconnection.doc.html) - # Published datasources connected to the table - # - # 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/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[PublishedDatasource](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource.doc.html)!]! - # Published datasources connected to the table - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [PublishedDatasource_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [PublishedDatasourcesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesconnection.doc.html) - # Lenses connected to the table - # - # 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/current/api/metadata_api/en-us/reference/lens_filter.doc.html), - orderBy: [LensSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/lenssortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Lens](https://help.tableau.com/current/api/metadata_api/en-us/reference/lens.doc.html)!]! - # Lenses connected to the table - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Lens_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/lens_filter.doc.html), - orderBy: [LensSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/lenssortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [LensesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensesconnection.doc.html) - # Sheets connected to the table - # - # 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/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Sheet](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html)!]! - # Sheets connected to the table - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Sheet_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [SheetsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsconnection.doc.html) - # Workbooks connected to the table - # - # 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/current/api/metadata_api/en-us/reference/workbook_filter.doc.html), - orderBy: [WorkbookSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Workbook](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbook.doc.html)!]! - # Workbooks connected to the table - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Workbook_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbook_filter.doc.html), - orderBy: [WorkbookSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [WorkbooksConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksconnection.doc.html) - # Dashboards connected to the table - # - # 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/current/api/metadata_api/en-us/reference/dashboard_filter.doc.html), - orderBy: [DashboardSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboardsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Dashboard](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard.doc.html)!]! - # Dashboards connected to the table - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Dashboard_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard_filter.doc.html), - orderBy: [DashboardSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboardsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DashboardsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboardsconnection.doc.html) - # Metrics downstream of this table - # - # 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/current/api/metadata_api/en-us/reference/metric_filter.doc.html), - orderBy: [MetricSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Metric](https://help.tableau.com/current/api/metadata_api/en-us/reference/metric.doc.html)!]! - # Metrics downstream of this table - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Metric_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metric_filter.doc.html), - orderBy: [MetricSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [MetricsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricsconnection.doc.html) - # Owners of workbooks and published datasources connected to the table - # - # 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/current/api/metadata_api/en-us/reference/tableauuser_filter.doc.html), - orderBy: [TableauUserSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauusersortorder.doc.html) - ): [[TableauUser](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauuser.doc.html)!]! - # Owners of workbooks and published datasources connected to the table - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [TableauUser_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauuser_filter.doc.html), - orderBy: [TableauUserSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauusersortorder.doc.html) - ): [TableauUsersConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauusersconnection.doc.html) - # The parent virtual connection for this table - virtualConnection: [VirtualConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection.doc.html) - # Metric definitions downstream from this virtualConnectionTable. - # - # 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/current/api/metadata_api/en-us/reference/metricdefinition_filter.doc.html), - orderBy: [MetricDefinitionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[MetricDefinition](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinition.doc.html)]! - # Metric definitions downstream from this virtualConnectionTable. - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [MetricDefinition_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinition_filter.doc.html), - orderBy: [MetricDefinitionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [MetricDefinitionsConnection](https://help.tableau.com/current/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/current/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/current/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/current/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/current/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/current/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/current/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/current/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/current/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/current/api/metadata_api/en-us/reference/database.doc.html "Database - A database containing tables") - [DatabaseServer_A database server connection_](https://help.tableau.com/current/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/current/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/current/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/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [File_A file connection_](https://help.tableau.com/current/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/current/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/current/api/metadata_api/en-us/reference/flowcolumnoutputfield.doc.html "FlowColumnOutputField - Column output field implementation") - [FlowFieldOutputField_Field output field implementation_](https://help.tableau.com/current/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/current/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/current/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/current/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/current/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/current/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/current/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/current/api/metadata_api/en-us/reference/table.doc.html "Table - A table containing columns") - [TableauUser_User on a site on Tableau server_](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/tag.doc.html "Tag - A tag associated with content items") - [VirtualConnection_A virtual connection. \*Available in Tableau Cloud March 2022 / Server 2022.1 and later.\*_](virtualconnection.doc.html "VirtualConnection - A virtual connection. *Available in Tableau Cloud March 2022 / Server 2022.1 and later.*") - [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.*") - [VirtualConnectionTablesConnection_Connection Type for VirtualConnectionTable_](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesconnection.doc.html "VirtualConnectionTablesConnection - Connection Type for VirtualConnectionTable") - [WebDataConnector_A web data connector_](https://help.tableau.com/current/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/current/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).") _menu_ Types INPUT\_OBJECT # VirtualConnectionTable\_Filter Filter by GraphQL field and given value ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input VirtualConnectionTable_Filter { - # True if the datasource contains unsupported custom SQL, in which case lineage - # may be incomplete - containsUnsupportedCustomSql: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) - # True if the datasource contains unsupported custom SQL, in which case lineage - # may be incomplete - containsUnsupportedCustomSqlWithin: [[Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html)] - # VizPortal URL ID; used for URL generation - vizportalUrlId: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # VizPortal URL ID; used for URL generation - vizportalUrlIdWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)] - # True if the table has an active data quality warning - hasActiveWarning: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) - # True if the table has an active data quality warning - hasActiveWarningWithin: [[Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html)] - # The time the data for this table's extract was refreshed. - extractLastRefreshedAt: [DateTime](https://help.tableau.com/current/api/metadata_api/en-us/reference/datetime.doc.html) - # The time the data for this table's extract was refreshed. - extractLastRefreshedAtWithin: [[DateTime](https://help.tableau.com/current/api/metadata_api/en-us/reference/datetime.doc.html)] - # Locally unique identifier used for the REST API on the Tableau Server - luid: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Locally unique identifier used for the REST API on the Tableau Server - luidWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)] - # True if this virtual connection table contains an active data quality - # certification - isCertified: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) - # True if this virtual connection table contains an active data quality - # certification - isCertifiedWithin: [[Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html)] - # Name shown in server and desktop clients - name: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Name shown in server and desktop clients - nameWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.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/current/api/metadata_api/en-us/reference/id.doc.html) - # Unique identifier used by the metadata API. Not the same as the numeric ID used - # on server - idWithin: [[ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html)] - # Whether or not queries to this table are using an extract. - isExtracted: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) - # Whether or not queries to this table are using an extract. - isExtractedWithin: [[Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.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/current/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/current/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/current/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/current/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/current/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/current/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/current/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/current/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/current/api/metadata_api/en-us/reference/database.doc.html "Database - A database containing tables") - [DatabaseServer_A database server connection_](https://help.tableau.com/current/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/current/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/current/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/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [File_A file connection_](https://help.tableau.com/current/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/current/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/current/api/metadata_api/en-us/reference/flowcolumnoutputfield.doc.html "FlowColumnOutputField - Column output field implementation") - [FlowFieldOutputField_Field output field implementation_](https://help.tableau.com/current/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/current/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/current/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/current/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/current/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/current/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/current/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/current/api/metadata_api/en-us/reference/table.doc.html "Table - A table containing columns") - [TableauUser_User on a site on Tableau server_](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/tag.doc.html "Tag - A tag associated with content items") - [VirtualConnection_A virtual connection. \*Available in Tableau Cloud March 2022 / Server 2022.1 and later.\*_](virtualconnection.doc.html "VirtualConnection - A virtual connection. *Available in Tableau Cloud March 2022 / Server 2022.1 and later.*") - [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/current/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/current/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).") _menu_ Types ENUM # VirtualConnectionTableOrderField Enum for fields that can be used for sorting ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - enum VirtualConnectionTableOrderField { - # Sort by columns count - COLUMNS_COUNT - # Sort by downstreamDashboards count - DOWNSTREAM_DASHBOARDS_COUNT - # Sort by downstreamDatasources count - DOWNSTREAM_DATASOURCES_COUNT - # Sort by downstreamWorkbooks count - DOWNSTREAM_WORKBOOKS_COUNT - # Sort by owner count - OWNER_COUNT - # Sort by containsUnsupportedCustomSql - CONTAINS_UNSUPPORTED_CUSTOM_SQL - # Sort by extractLastRefreshType - EXTRACT_LAST_REFRESH_TYPE - # Sort by extractLastRefreshedAt - EXTRACT_LAST_REFRESHED_AT - # Sort by hasActiveWarning - HAS_ACTIVE_WARNING - # Sort by id - ID - # Sort by isCertified - IS_CERTIFIED - # Sort by isExtracted - IS_EXTRACTED - # Sort by luid - LUID - # Sort by name - NAME - # Sort by vizportalUrlId - VIZPORTAL_URL_ID - } ` ## [_link_](#require-by) Require by - [VirtualConnectionTableSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html "VirtualConnectionTableSortOrder - 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.") _menu_ Types OBJECT # VirtualConnectionTablesConnection Connection Type for VirtualConnectionTable ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type VirtualConnectionTablesConnection { - # List of nodes - nodes: [[VirtualConnectionTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable.doc.html)!]! - # Information for pagination - pageInfo: [PageInfo](https://help.tableau.com/current/api/metadata_api/en-us/reference/pageinfo.doc.html)! - # Total number of objects in connection - totalCount: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.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/current/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/current/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/current/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/current/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/current/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/current/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/current/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/current/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/current/api/metadata_api/en-us/reference/database.doc.html "Database - A database containing tables") - [DatabaseServer_A database server connection_](https://help.tableau.com/current/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/current/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/current/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/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [File_A file connection_](https://help.tableau.com/current/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/current/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/current/api/metadata_api/en-us/reference/flowcolumnoutputfield.doc.html "FlowColumnOutputField - Column output field implementation") - [FlowFieldOutputField_Field output field implementation_](https://help.tableau.com/current/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/current/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/current/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/current/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/current/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/current/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/current/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/current/api/metadata_api/en-us/reference/table.doc.html "Table - A table containing columns") - [TableauUser_User on a site on Tableau server_](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/tag.doc.html "Tag - A tag associated with content items") - [VirtualConnection_A virtual connection. \*Available in Tableau Cloud March 2022 / Server 2022.1 and later.\*_](virtualconnection.doc.html "VirtualConnection - A virtual connection. *Available in Tableau Cloud March 2022 / Server 2022.1 and later.*") - [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/current/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/current/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).") _menu_ Types INPUT\_OBJECT # VirtualConnectionTableSortOrder 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. ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input VirtualConnectionTableSortOrder { - # GraphQL field to sort on - field: [VirtualConnectionTableOrderField](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontableorderfield.doc.html)! - # Order direction to sort output - direction: [OrderDirection](https://help.tableau.com/current/api/metadata_api/en-us/reference/orderdirection.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/current/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/current/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/current/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/current/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/current/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/current/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/current/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/current/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/current/api/metadata_api/en-us/reference/database.doc.html "Database - A database containing tables") - [DatabaseServer_A database server connection_](https://help.tableau.com/current/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/current/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/current/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/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [File_A file connection_](https://help.tableau.com/current/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/current/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/current/api/metadata_api/en-us/reference/flowcolumnoutputfield.doc.html "FlowColumnOutputField - Column output field implementation") - [FlowFieldOutputField_Field output field implementation_](https://help.tableau.com/current/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/current/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/current/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/current/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/current/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/current/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/current/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/current/api/metadata_api/en-us/reference/table.doc.html "Table - A table containing columns") - [TableauUser_User on a site on Tableau server_](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/tag.doc.html "Tag - A tag associated with content items") - [VirtualConnection_A virtual connection. \*Available in Tableau Cloud March 2022 / Server 2022.1 and later.\*_](virtualconnection.doc.html "VirtualConnection - A virtual connection. *Available in Tableau Cloud March 2022 / Server 2022.1 and later.*") - [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/current/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/current/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).") _menu_ Types INTERFACE # Warnable A content item that can have data quality warnings ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - interface Warnable { - # Unique identifier used by the metadata API. Not the same as the numeric ID used - # on server - id: [ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html)! - # The name of the asset - name: [String](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/string.doc.html)! - # True if the content has an active data quality warning - hasActiveWarning: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html)! - # The optional data quality warning on a content item - dataQualityWarning: [DataQualityWarning](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarning.doc.html) @deprecated( reason: "Use 'dataQualityWarnings'" ) - # The data quality warnings on a content item - # - # 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/current/api/metadata_api/en-us/reference/dataqualitywarning_filter.doc.html), - orderBy: [DataQualityWarningSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarningsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DataQualityWarning](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarning.doc.html)!]! - # The data quality warnings on a content item - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DataQualityWarning_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarning_filter.doc.html), - orderBy: [DataQualityWarningSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarningsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DataQualityWarningsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarningsconnection.doc.html) - } ` ## [_link_](#require-by) Require by - [CloudFile_A cloud file connection_](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/column.doc.html "Column - GraphQL type for a table column") - [DatabaseServer_A database server connection_](https://help.tableau.com/current/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/current/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.*") - [File_A file connection_](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/flow.doc.html "Flow - Flows are used to prepare data, which can include aggregation, cleaning, preprocessing, etc.") - [PublishedDatasource_A Tableau data source that has been published separately to Tableau Server. It can be used by multiple workbooks._](https://help.tableau.com/current/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.") - [VirtualConnection_A virtual connection. \*Available in Tableau Cloud March 2022 / Server 2022.1 and later.\*_](virtualconnection.doc.html "VirtualConnection - A virtual connection. *Available in Tableau Cloud March 2022 / Server 2022.1 and later.*") - [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.*") - [WarnablesConnection_Connection Type for Warnable_](https://help.tableau.com/current/api/metadata_api/en-us/reference/warnablesconnection.doc.html "WarnablesConnection - Connection Type for Warnable") - [WebDataConnector_A web data connector_](https://help.tableau.com/current/api/metadata_api/en-us/reference/webdataconnector.doc.html "WebDataConnector - A web data connector") _menu_ Types INPUT\_OBJECT # Warnable\_Filter Filter by GraphQL field and given value ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input Warnable_Filter { - # True if the content has an active data quality warning - hasActiveWarning: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) - # True if the content has an active data quality warning - hasActiveWarningWithin: [[Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html)] - # Locally unique identifier used for the REST API on the Tableau Server - luid: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Locally unique identifier used for the REST API on the Tableau Server - luidWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.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/current/api/metadata_api/en-us/reference/id.doc.html) - # Unique identifier used by the metadata API. Not the same as the numeric ID used - # on server - idWithin: [[ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html)] - } ` ## [_link_](#require-by) Require by This element is not required by anyone _menu_ Types ENUM # WarnableOrderField Enum for fields that can be used for sorting ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - enum WarnableOrderField { - # Sort by hasActiveWarning - HAS_ACTIVE_WARNING - # Sort by id - ID - # Sort by luid - LUID - } ` ## [_link_](#require-by) Require by - [WarnableSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/warnablesortorder.doc.html "WarnableSortOrder - 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.") _menu_ Types OBJECT # WarnablesConnection Connection Type for Warnable ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type WarnablesConnection { - # List of nodes - nodes: [[Warnable](https://help.tableau.com/current/api/metadata_api/en-us/reference/warnable.doc.html)!]! - # Information for pagination - pageInfo: [PageInfo](https://help.tableau.com/current/api/metadata_api/en-us/reference/pageinfo.doc.html)! - # Total number of objects in connection - totalCount: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html)! - } ` ## [_link_](#require-by) Require by This element is not required by anyone _menu_ Types INPUT\_OBJECT # WarnableSortOrder 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. ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input WarnableSortOrder { - # GraphQL field to sort on - field: [WarnableOrderField](https://help.tableau.com/current/api/metadata_api/en-us/reference/warnableorderfield.doc.html)! - # Order direction to sort output - direction: [OrderDirection](https://help.tableau.com/current/api/metadata_api/en-us/reference/orderdirection.doc.html)! - } ` ## [_link_](#require-by) Require by This element is not required by anyone _menu_ Types OBJECT # WebDataConnector A web data connector ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type WebDataConnector implements [Database](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html), [Warnable](https://help.tableau.com/current/api/metadata_api/en-us/reference/warnable.doc.html), [Certifiable](https://help.tableau.com/current/api/metadata_api/en-us/reference/certifiable.doc.html), [CanHaveLabels](https://help.tableau.com/current/api/metadata_api/en-us/reference/canhavelabels.doc.html), [Taggable](https://help.tableau.com/current/api/metadata_api/en-us/reference/taggable.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/current/api/metadata_api/en-us/reference/id.doc.html)! - # Vizportal ID of this database, for use in client-to-server communications - vizportalId: [String](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/string.doc.html)! - # Name shown in server and desktop clients - name: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # The type of web data connector - connectionType: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # A web data connector is always embedded in Tableau content - isEmbedded: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) - # The url for the sign-in page of the web data connector - connectorUrl: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # User modifiable description of this database - description: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # The ID of the project in which the database is visible. Will be empty if the - # database is not in a project. - projectVizportalUrlId: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # The name of the project in which the database is visible. Will be empty if the - # database is not in a project. - projectName: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Contact for this database - contact: [TableauUser](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauuser.doc.html) - # True if this database contains an active data quality certification - isCertified: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html)! - # True if this database has its permission locked - isControlledPermissionsEnabled: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) - # True if this database has been grouped with other databases - isGrouped: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) - # Notes related to the web data connector table being marked as certified - certificationNote: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) @deprecated( reason: "No longer supported. Use 'dataQualityCertifications'" ) - # User who marked this database as certified - certifier: [TableauUser](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauuser.doc.html) @deprecated( reason: "No longer supported. Use 'dataQualityCertifications'" ) - # True if the database has an active data quality warning - hasActiveWarning: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html)! - # The optional data quality warning on a database - dataQualityWarning: [DataQualityWarning](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarning.doc.html) @deprecated( reason: "Use 'dataQualityWarnings'" ) - # The data quality warnings on a 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. - # **permissionMode**: Results filtering mode. - dataQualityWarnings( - filter: [DataQualityWarning_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarning_filter.doc.html), - orderBy: [DataQualityWarningSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarningsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DataQualityWarning](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarning.doc.html)!]! - # The data quality warnings on a 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. - # **permissionMode**: Results filtering mode. - dataQualityWarningsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DataQualityWarning_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarning_filter.doc.html), - orderBy: [DataQualityWarningSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarningsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DataQualityWarningsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarningsconnection.doc.html) - # The data quality certifications on a 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. - # **permissionMode**: Results filtering mode. - dataQualityCertifications( - filter: [DataQualityCertification_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitycertification_filter.doc.html), - orderBy: [DataQualityCertificationSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitycertificationsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DataQualityCertification](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitycertification.doc.html)!]! - # The data quality certifications on a 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. - # **permissionMode**: Results filtering mode. - dataQualityCertificationsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DataQualityCertification_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitycertification_filter.doc.html), - orderBy: [DataQualityCertificationSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitycertificationsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DataQualityCertificationsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitycertificationsconnection.doc.html) - # The labels on a database. 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/current/api/metadata_api/en-us/reference/label_filter.doc.html), - orderBy: [LabelSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/labelsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Label](https://help.tableau.com/current/api/metadata_api/en-us/reference/label.doc.html)!]! - # The labels on a database. 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Label_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/label_filter.doc.html), - orderBy: [LabelSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/labelsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [LabelsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/labelsconnection.doc.html) - # Data quality warnings upstream from this 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. - # **permissionMode**: Results filtering mode. - upstreamDataQualityWarnings( - filter: [DataQualityWarning_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarning_filter.doc.html), - orderBy: [DataQualityWarningSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarningsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DataQualityWarning](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarning.doc.html)!]! - # Data quality warnings upstream from this 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. - # **permissionMode**: Results filtering mode. - upstreamDataQualityWarningsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DataQualityWarning_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarning_filter.doc.html), - orderBy: [DataQualityWarningSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarningsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DataQualityWarningsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarningsconnection.doc.html) - # Labels upstream from this database. 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/current/api/metadata_api/en-us/reference/label_filter.doc.html), - orderBy: [LabelSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/labelsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Label](https://help.tableau.com/current/api/metadata_api/en-us/reference/label.doc.html)!]! - # Labels upstream from this database. 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Label_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/label_filter.doc.html), - orderBy: [LabelSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/labelsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [LabelsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/labelsconnection.doc.html) - # Tags associated with 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. - tags(filter: [Tag_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/tag_filter.doc.html), orderBy: [TagSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tagsortorder.doc.html)): [[Tag](https://help.tableau.com/current/api/metadata_api/en-us/reference/tag.doc.html)!]! - # Tags associated with 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. - tagsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Tag_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/tag_filter.doc.html), - orderBy: [TagSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tagsortorder.doc.html) - ): [TagsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/tagsconnection.doc.html) - # Databases upstream of this 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. - # **permissionMode**: Results filtering mode. - upstreamDatabases( - filter: [Database_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Database](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html)!]! - # Databases upstream of this 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. - # **permissionMode**: Results filtering mode. - upstreamDatabasesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Database_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabasesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesconnection.doc.html) - # Tables upstream of this 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. - # **permissionMode**: Results filtering mode. - upstreamTables( - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DatabaseTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable.doc.html)!]! - # Tables upstream of this 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. - # **permissionMode**: Results filtering mode. - upstreamTablesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabaseTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesconnection.doc.html) - # Virtual connection tables upstream of this 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. - # **permissionMode**: Results filtering mode. - upstreamVirtualConnections( - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection.doc.html)!]! - # Virtual connection tables upstream of this 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. - # **permissionMode**: Results filtering mode. - upstreamVirtualConnectionsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsconnection.doc.html) - # Virtual connection tables upstream of this 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. - # **permissionMode**: Results filtering mode. - upstreamVirtualConnectionTables( - filter: [VirtualConnectionTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnectionTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable.doc.html)!]! - # Virtual connection tables upstream of this 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. - # **permissionMode**: Results filtering mode. - upstreamVirtualConnectionTablesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnectionTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesconnection.doc.html) - # Flows upstream of this 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. - # **permissionMode**: Results filtering mode. - upstreamFlows( - filter: [Flow_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Flow](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow.doc.html)!]! - # Flows upstream of this 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. - # **permissionMode**: Results filtering mode. - upstreamFlowsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Flow_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FlowsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsconnection.doc.html) - # Datasources upstream of this 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. - # **permissionMode**: Results filtering mode. - upstreamDatasources( - filter: [PublishedDatasource_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[PublishedDatasource](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource.doc.html)!]! - # Datasources upstream of this 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. - # **permissionMode**: Results filtering mode. - upstreamDatasourcesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [PublishedDatasource_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [PublishedDatasourcesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesconnection.doc.html) - # Databases downstream of this 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. - # **permissionMode**: Results filtering mode. - downstreamDatabases( - filter: [Database_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Database](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html)!]! - # Databases downstream of this 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. - # **permissionMode**: Results filtering mode. - downstreamDatabasesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Database_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabasesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesconnection.doc.html) - # Tables downstream of this 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. - # **permissionMode**: Results filtering mode. - downstreamTables( - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DatabaseTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable.doc.html)!]! - # Tables downstream of this 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. - # **permissionMode**: Results filtering mode. - downstreamTablesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabaseTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesconnection.doc.html) - # Virtual connection tables downstream of this 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. - # **permissionMode**: Results filtering mode. - downstreamVirtualConnections( - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection.doc.html)!]! - # Virtual connection tables downstream of this 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. - # **permissionMode**: Results filtering mode. - downstreamVirtualConnectionsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsconnection.doc.html) - # Virtual connection tables downstream of this 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. - # **permissionMode**: Results filtering mode. - downstreamVirtualConnectionTables( - filter: [VirtualConnectionTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnectionTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable.doc.html)!]! - # Virtual connection tables downstream of this 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. - # **permissionMode**: Results filtering mode. - downstreamVirtualConnectionTablesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnectionTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesconnection.doc.html) - # Flows downstream of this 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. - # **permissionMode**: Results filtering mode. - downstreamFlows( - filter: [Flow_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Flow](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow.doc.html)!]! - # Flows downstream of this 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. - # **permissionMode**: Results filtering mode. - downstreamFlowsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Flow_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FlowsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsconnection.doc.html) - # Published datasources 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. - # **permissionMode**: Results filtering mode. - downstreamDatasources( - filter: [PublishedDatasource_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[PublishedDatasource](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource.doc.html)!]! - # Published datasources 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. - # **permissionMode**: Results filtering mode. - downstreamDatasourcesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [PublishedDatasource_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [PublishedDatasourcesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesconnection.doc.html) - # Lenses 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. - # **permissionMode**: Results filtering mode. - downstreamLenses( - filter: [Lens_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/lens_filter.doc.html), - orderBy: [LensSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/lenssortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Lens](https://help.tableau.com/current/api/metadata_api/en-us/reference/lens.doc.html)!]! - # Lenses 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. - # **permissionMode**: Results filtering mode. - downstreamLensesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Lens_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/lens_filter.doc.html), - orderBy: [LensSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/lenssortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [LensesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensesconnection.doc.html) - # Workbooks 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. - # **permissionMode**: Results filtering mode. - downstreamWorkbooks( - filter: [Workbook_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbook_filter.doc.html), - orderBy: [WorkbookSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Workbook](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbook.doc.html)!]! - # Workbooks 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. - # **permissionMode**: Results filtering mode. - downstreamWorkbooksConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Workbook_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbook_filter.doc.html), - orderBy: [WorkbookSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [WorkbooksConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksconnection.doc.html) - # Dashboards 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. - # **permissionMode**: Results filtering mode. - downstreamDashboards( - filter: [Dashboard_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard_filter.doc.html), - orderBy: [DashboardSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboardsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Dashboard](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard.doc.html)!]! - # Dashboards 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. - # **permissionMode**: Results filtering mode. - downstreamDashboardsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Dashboard_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard_filter.doc.html), - orderBy: [DashboardSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboardsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DashboardsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboardsconnection.doc.html) - # Sheets 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. - # **permissionMode**: Results filtering mode. - downstreamSheets( - filter: [Sheet_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Sheet](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html)!]! - # Sheets 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. - # **permissionMode**: Results filtering mode. - downstreamSheetsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Sheet_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [SheetsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsconnection.doc.html) - # Metrics 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. - # **permissionMode**: Results filtering mode. - downstreamMetrics( - filter: [Metric_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metric_filter.doc.html), - orderBy: [MetricSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Metric](https://help.tableau.com/current/api/metadata_api/en-us/reference/metric.doc.html)!]! - # Metrics 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. - # **permissionMode**: Results filtering mode. - downstreamMetricsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Metric_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metric_filter.doc.html), - orderBy: [MetricSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [MetricsConnection](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/tableauuser_filter.doc.html), - orderBy: [TableauUserSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauusersortorder.doc.html) - ): [[TableauUser](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [TableauUser_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauuser_filter.doc.html), - orderBy: [TableauUserSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauusersortorder.doc.html) - ): [TableauUsersConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauusersconnection.doc.html) - # The custom SQL queries that reference this 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. - # **permissionMode**: Results filtering mode. - referencedByQueries( - filter: [CustomSQLTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/customsqltable_filter.doc.html), - orderBy: [CustomSQLTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/customsqltablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[CustomSQLTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/customsqltable.doc.html)] - # The custom SQL queries that reference this 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. - # **permissionMode**: Results filtering mode. - referencedByQueriesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [CustomSQLTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/customsqltable_filter.doc.html), - orderBy: [CustomSQLTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/customsqltablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [CustomSQLTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/customsqltablesconnection.doc.html) - # Tables belonging to this 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. - # **permissionMode**: Results filtering mode. - tables( - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DatabaseTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable.doc.html)] - # Tables belonging to this 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. - # **permissionMode**: Results filtering mode. - tablesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabaseTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesconnection.doc.html) - # Metric definitions downstream from this 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. - # **permissionMode**: Results filtering mode. - downstreamMetricDefinitions( - filter: [MetricDefinition_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinition_filter.doc.html), - orderBy: [MetricDefinitionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[MetricDefinition](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinition.doc.html)]! - # Metric definitions downstream from this 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. - # **permissionMode**: Results filtering mode. - downstreamMetricDefinitionsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [MetricDefinition_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinition_filter.doc.html), - orderBy: [MetricDefinitionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [MetricDefinitionsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsconnection.doc.html) - } ` ## [_link_](#require-by) Require by - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/api/metadata_api/en-us/reference/query.doc.html "Query - Query root for Metadata GraphQL interface") - [WebDataConnectorsConnection_Connection Type for WebDataConnector_](https://help.tableau.com/current/api/metadata_api/en-us/reference/webdataconnectorsconnection.doc.html "WebDataConnectorsConnection - Connection Type for WebDataConnector") _menu_ Types INPUT\_OBJECT # WebDataConnector\_Filter Filter by GraphQL field and given value ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input WebDataConnector_Filter { - # True if the database has an active data quality warning - hasActiveWarning: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) - # True if the database has an active data quality warning - hasActiveWarningWithin: [[Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html)] - # Locally unique identifier used for the REST API on the Tableau Server - luid: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Locally unique identifier used for the REST API on the Tableau Server - luidWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)] - # True if this database contains an active data quality certification - isCertified: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) - # True if this database contains an active data quality certification - isCertifiedWithin: [[Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html)] - # Name shown in server and desktop clients - name: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Name shown in server and desktop clients - nameWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)] - # A web data connector is always embedded in Tableau content - isEmbedded: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) - # A web data connector is always embedded in Tableau content - isEmbeddedWithin: [[Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.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/current/api/metadata_api/en-us/reference/id.doc.html) - # Unique identifier used by the Metadata API. Not the same as the numeric ID used - # on server - idWithin: [[ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html)] - # The name of the project in which the database is visible. Will be empty if the - # database is not in a project. - projectName: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # The name of the project in which the database is visible. Will be empty if the - # database is not in a project. - projectNameWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)] - # The type of web data connector - connectionType: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # The type of web data connector - connectionTypeWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)] - # Filter the output based on text query. - text: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - } ` ## [_link_](#require-by) Require by - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/api/metadata_api/en-us/reference/query.doc.html "Query - Query root for Metadata GraphQL interface") _menu_ Types ENUM # WebDataConnectorOrderField Enum for fields that can be used for sorting ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - enum WebDataConnectorOrderField { - # Sort by downstreamDatasources count - DOWNSTREAM_DATASOURCES_COUNT - # Sort by downstreamVirtualConnections count - DOWNSTREAM_VIRTUAL_CONNECTIONS_COUNT - # Sort by downstreamWorkbooks count - DOWNSTREAM_WORKBOOKS_COUNT - # Sort by connectionType - CONNECTION_TYPE - # Sort by hasActiveWarning - HAS_ACTIVE_WARNING - # Sort by id - ID - # Sort by isCertified - IS_CERTIFIED - # Sort by isEmbedded - IS_EMBEDDED - # Sort by luid - LUID - # Sort by name - NAME - # Sort by projectName - PROJECT_NAME - } ` ## [_link_](#require-by) Require by - [WebDataConnectorSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/webdataconnectorsortorder.doc.html "WebDataConnectorSortOrder - 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.") _menu_ Types OBJECT # WebDataConnectorsConnection Connection Type for WebDataConnector ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type WebDataConnectorsConnection { - # List of nodes - nodes: [[WebDataConnector](https://help.tableau.com/current/api/metadata_api/en-us/reference/webdataconnector.doc.html)!]! - # Information for pagination - pageInfo: [PageInfo](https://help.tableau.com/current/api/metadata_api/en-us/reference/pageinfo.doc.html)! - # Total number of objects in connection - totalCount: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html)! - } ` ## [_link_](#require-by) Require by - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/api/metadata_api/en-us/reference/query.doc.html "Query - Query root for Metadata GraphQL interface") _menu_ Types INPUT\_OBJECT # WebDataConnectorSortOrder 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. ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input WebDataConnectorSortOrder { - # GraphQL field to sort on - field: [WebDataConnectorOrderField](https://help.tableau.com/current/api/metadata_api/en-us/reference/webdataconnectororderfield.doc.html)! - # Order direction to sort output - direction: [OrderDirection](https://help.tableau.com/current/api/metadata_api/en-us/reference/orderdirection.doc.html)! - } ` ## [_link_](#require-by) Require by - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/api/metadata_api/en-us/reference/query.doc.html "Query - Query root for Metadata GraphQL interface") _menu_ Types OBJECT # 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). ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type Workbook implements [Taggable](https://help.tableau.com/current/api/metadata_api/en-us/reference/taggable.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/current/api/metadata_api/en-us/reference/id.doc.html)! - # Name shown in server and desktop clients - name: [String](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/string.doc.html)! - # True if the workbook contains unsupported custom SQL, in which case lineage may - # be incomplete - containsUnsupportedCustomSql: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) - # The site in which the workbook is visible and usable - site: [TableauSite](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableausite.doc.html)! - # The ID of the project in which the workbook is visible and usable. Will be null - # if the workbook is not in a project. - projectVizportalUrlId: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # The name of the project in which the workbook is visible and usable. - projectName: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # The luid of the project in which the workbook is visible and usable. Available - # in Tableau Cloud June 2022 / Server 2022.3 and later. - projectLuid: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # The type of the container in which the workbook is visible and usable. Either - # personal space or project. - containerType: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)! - # The name of the container in which the workbook is visible and usable. Either a - # personal space or project. - containerName: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # User who owns this workbook - owner: [TableauUser](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauuser.doc.html)! - # Tags associated with the workbook - # - # 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/current/api/metadata_api/en-us/reference/tag_filter.doc.html), orderBy: [TagSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tagsortorder.doc.html)): [[Tag](https://help.tableau.com/current/api/metadata_api/en-us/reference/tag.doc.html)!]! - # Tags associated with the workbook - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Tag_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/tag_filter.doc.html), - orderBy: [TagSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tagsortorder.doc.html) - ): [TagsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/tagsconnection.doc.html) - # Views that are contained in this workbook - # - # 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. - views( - filter: [View_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/view_filter.doc.html), - orderBy: [ViewSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/viewsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[View](https://help.tableau.com/current/api/metadata_api/en-us/reference/view.doc.html)!]! - # Views that are contained in this workbook - # - # 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. - viewsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [View_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/view_filter.doc.html), - orderBy: [ViewSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/viewsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [ViewsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/viewsconnection.doc.html) - # Worksheets that are contained in this workbook - # - # 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. - sheets( - filter: [Sheet_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Sheet](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html)!]! - # Worksheets that are contained in this workbook - # - # 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. - sheetsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Sheet_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [SheetsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheetsconnection.doc.html) - # Dashboards that are contained in this workbook - # - # 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. - dashboards( - filter: [Dashboard_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard_filter.doc.html), - orderBy: [DashboardSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboardsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Dashboard](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard.doc.html)!]! - # Dashboards that are contained in this workbook - # - # 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. - dashboardsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Dashboard_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard_filter.doc.html), - orderBy: [DashboardSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboardsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DashboardsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboardsconnection.doc.html) - # Data sources that are embedded in this workbook - # - # 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. - embeddedDatasources( - filter: [EmbeddedDatasource_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/embeddeddatasource_filter.doc.html), - orderBy: [EmbeddedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/embeddeddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[EmbeddedDatasource](https://help.tableau.com/current/api/metadata_api/en-us/reference/embeddeddatasource.doc.html)!]! - # Data sources that are embedded in this workbook - # - # 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. - embeddedDatasourcesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [EmbeddedDatasource_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/embeddeddatasource_filter.doc.html), - orderBy: [EmbeddedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/embeddeddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [EmbeddedDatasourcesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/embeddeddatasourcesconnection.doc.html) - # Parameters that are contained in this workbook - # - # 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. - parameters( - filter: [Parameter_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/parameter_filter.doc.html), - orderBy: [ParameterSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/parametersortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Parameter](https://help.tableau.com/current/api/metadata_api/en-us/reference/parameter.doc.html)!]! - # Parameters that are contained in this workbook - # - # 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. - parametersConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Parameter_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/parameter_filter.doc.html), - orderBy: [ParameterSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/parametersortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [ParametersConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/parametersconnection.doc.html) - # Description of the workbook - description: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Uri of the workbook - uri: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # VizPortal URL ID; used for URL generation - vizportalUrlId: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)! - # Time the workbook was created - createdAt: [DateTime](https://help.tableau.com/current/api/metadata_api/en-us/reference/datetime.doc.html)! - # Time the workbook was updated - updatedAt: [DateTime](https://help.tableau.com/current/api/metadata_api/en-us/reference/datetime.doc.html)! - # Data quality warnings upstream from this workbook - # - # 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/current/api/metadata_api/en-us/reference/dataqualitywarning_filter.doc.html), - orderBy: [DataQualityWarningSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarningsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DataQualityWarning](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarning.doc.html)!]! - # Data quality warnings upstream from this workbook - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DataQualityWarning_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarning_filter.doc.html), - orderBy: [DataQualityWarningSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarningsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DataQualityWarningsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarningsconnection.doc.html) - # Labels upstream from this workbook. 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/current/api/metadata_api/en-us/reference/label_filter.doc.html), - orderBy: [LabelSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/labelsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Label](https://help.tableau.com/current/api/metadata_api/en-us/reference/label.doc.html)!]! - # Labels upstream from this workbook. 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Label_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/label_filter.doc.html), - orderBy: [LabelSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/labelsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [LabelsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/labelsconnection.doc.html) - # Metrics downstream from this workbook - # - # 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/current/api/metadata_api/en-us/reference/metric_filter.doc.html), - orderBy: [MetricSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Metric](https://help.tableau.com/current/api/metadata_api/en-us/reference/metric.doc.html)!]! - # Metrics downstream from this workbook - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Metric_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metric_filter.doc.html), - orderBy: [MetricSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [MetricsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricsconnection.doc.html) - # Metric owners downstream from this workbook - # - # 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/current/api/metadata_api/en-us/reference/tableauuser_filter.doc.html), - orderBy: [TableauUserSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauusersortorder.doc.html) - ): [[TableauUser](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauuser.doc.html)!]! - # Metric owners downstream from this workbook - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [TableauUser_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauuser_filter.doc.html), - orderBy: [TableauUserSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauusersortorder.doc.html) - ): [TableauUsersConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableauusersconnection.doc.html) - # The Databases that are upstream to this Workbook - # - # 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/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Database](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html)]! - # The Databases that are upstream to this Workbook - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Database_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabasesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasesconnection.doc.html) - # The Published Datasources that are upstream to this Workbook - # - # 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/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[PublishedDatasource](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource.doc.html)]! - # The Published Datasources that are upstream to this Workbook - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [PublishedDatasource_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [PublishedDatasourcesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesconnection.doc.html) - # The Lenses that are upstream of this workbook - # - # 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. - upstreamLenses( - filter: [Lens_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/lens_filter.doc.html), - orderBy: [LensSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/lenssortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Lens](https://help.tableau.com/current/api/metadata_api/en-us/reference/lens.doc.html)] - # The Lenses that are upstream of this workbook - # - # 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. - upstreamLensesConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Lens_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/lens_filter.doc.html), - orderBy: [LensSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/lenssortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [LensesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensesconnection.doc.html) - # The flows that are upstream of this workbook - # - # 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/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Flow](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow.doc.html)] - # The flows that are upstream of this workbook - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Flow_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FlowsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsconnection.doc.html) - # The tables upstream to this Workbook - # - # 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/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DatabaseTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable.doc.html)]! - # The tables upstream to this Workbook - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DatabaseTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabaseTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/databasetablesconnection.doc.html) - # The virtual connection upstream to this Workbook - # - # 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. - upstreamVirtualConnections( - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection.doc.html)]! - # The virtual connection upstream to this Workbook - # - # 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. - upstreamVirtualConnectionsConnection( - after: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsconnection.doc.html) - # The virtual connection table upstream to this Workbook - # - # 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/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnectionTable](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable.doc.html)]! - # The virtual connection table upstream to this Workbook - # - # 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/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [VirtualConnectionTable_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontable_filter.doc.html), - orderBy: [VirtualConnectionTableSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionTablesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectiontablesconnection.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/current/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/current/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/current/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/current/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/current/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/current/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/current/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/current/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.") - [Dashboard_A dashboard contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard.doc.html "Dashboard - A dashboard contained in a published workbook.") - [Database_A database containing tables_](https://help.tableau.com/current/api/metadata_api/en-us/reference/database.doc.html "Database - A database containing tables") - [DatabaseServer_A database server connection_](https://help.tableau.com/current/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/current/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.*") - [Datasource_Root GraphQL type for embedded and published data sources Data sources are a way to represent how Tableau Desktop and Tableau Server model and connect to data. Data sources can be published separately, as a published data source, or may be contained in a workbook as an embedded data source. See https://onlinehelp.tableau.com/current/server/en-us/datasource.htm_](datasource.doc.html "Datasource - Root GraphQL type for embedded and published data sources Data sources are a way to represent how Tableau Desktop and Tableau Server model and connect to data. Data sources can be published separately, as a published data source, or may be contained in a workbook as an embedded data source. See https://onlinehelp.tableau.com/current/server/en-us/datasource.htm") - [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/current/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.") - [EmbeddedDatasource_A data source embedded in a workbook_](https://help.tableau.com/current/api/metadata_api/en-us/reference/embeddeddatasource.doc.html "EmbeddedDatasource - A data source embedded in a workbook") - [Field_Base GraphQL type for a field_](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [File_A file connection_](https://help.tableau.com/current/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/current/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/current/api/metadata_api/en-us/reference/flowcolumnoutputfield.doc.html "FlowColumnOutputField - Column output field implementation") - [FlowFieldOutputField_Field output field implementation_](https://help.tableau.com/current/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/current/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/current/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/current/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.*") - [Metric_Metrics are time series data constructed from fields contained in views. \*Retired in Tableau Cloud February 2024 / Server 2024.2.\*_](metric.doc.html "Metric - Metrics are time series data constructed from fields contained in views. *Retired in Tableau Cloud February 2024 / Server 2024.2.*") - [Parameter_Tableau Parameter. For more info see https://onlinehelp.tableau.com/current/pro/desktop/en-us/parameters\_create.html_](https://help.tableau.com/current/api/metadata_api/en-us/reference/parameter.doc.html "Parameter - Tableau Parameter. For more info see https://onlinehelp.tableau.com/current/pro/desktop/en-us/parameters_create.html") - [PublishedDatasource_A Tableau data source that has been published separately to Tableau Server. It can be used by multiple workbooks._](https://help.tableau.com/current/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/current/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/current/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") - [Sheet_A sheet contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html "Sheet - A sheet contained in a published workbook.") - [Table_A table containing columns_](https://help.tableau.com/current/api/metadata_api/en-us/reference/table.doc.html "Table - A table containing columns") - [TableauSite_Site on Tableau server_](https://help.tableau.com/current/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/current/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/current/api/metadata_api/en-us/reference/tag.doc.html "Tag - A tag associated with content items") - [View_A view contained in a published workbook. Views can be sheets or dashboards._](https://help.tableau.com/current/api/metadata_api/en-us/reference/view.doc.html "View - A view contained in a published workbook. Views can be sheets or dashboards.") - [VirtualConnection_A virtual connection. \*Available in Tableau Cloud March 2022 / Server 2022.1 and later.\*_](virtualconnection.doc.html "VirtualConnection - A virtual connection. *Available in Tableau Cloud March 2022 / Server 2022.1 and later.*") - [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/current/api/metadata_api/en-us/reference/webdataconnector.doc.html "WebDataConnector - A web data connector") - [WorkbooksConnection_Connection Type for Workbook_](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksconnection.doc.html "WorkbooksConnection - Connection Type for Workbook") _menu_ Types INPUT\_OBJECT # Workbook\_Filter Filter by GraphQL field and given value ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input Workbook_Filter { - # True if the workbook contains unsupported custom SQL, in which case lineage may - # be incomplete - containsUnsupportedCustomSql: [Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html) - # True if the workbook contains unsupported custom SQL, in which case lineage may - # be incomplete - containsUnsupportedCustomSqlWithin: [[Boolean](https://help.tableau.com/current/api/metadata_api/en-us/reference/boolean.doc.html)] - # VizPortal URL ID; used for URL generation - vizportalUrlId: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # VizPortal URL ID; used for URL generation - vizportalUrlIdWithin: [[String](https://help.tableau.com/current/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/current/api/metadata_api/en-us/reference/string.doc.html) - # Locally unique identifier used for the REST API on the Tableau Server - luidWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)] - # The name of the container in which the workbook is visible and usable. Either a - # personal space or project. - containerName: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # The name of the container in which the workbook is visible and usable. Either a - # personal space or project. - containerNameWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)] - # Name shown in server and desktop clients - name: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # Name shown in server and desktop clients - nameWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)] - # The luid of the project in which the workbook is visible and usable. Available - # in Tableau Cloud June 2022 / Server 2022.3 and later. - projectLuid: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # The luid of the project in which the workbook is visible and usable. Available - # in Tableau Cloud June 2022 / Server 2022.3 and later. - projectLuidWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.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/current/api/metadata_api/en-us/reference/id.doc.html) - # Unique identifier used by the metadata API. Not the same as the numeric ID used - # on server - idWithin: [[ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html)] - # The name of the project in which the workbook is visible and usable. - projectName: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html) - # The name of the project in which the workbook is visible and usable. - projectNameWithin: [[String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.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/current/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/current/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/current/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/current/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/current/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/current/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/current/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/current/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/current/api/metadata_api/en-us/reference/database.doc.html "Database - A database containing tables") - [DatabaseServer_A database server connection_](https://help.tableau.com/current/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/current/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.*") - [Datasource_Root GraphQL type for embedded and published data sources Data sources are a way to represent how Tableau Desktop and Tableau Server model and connect to data. Data sources can be published separately, as a published data source, or may be contained in a workbook as an embedded data source. See https://onlinehelp.tableau.com/current/server/en-us/datasource.htm_](datasource.doc.html "Datasource - Root GraphQL type for embedded and published data sources Data sources are a way to represent how Tableau Desktop and Tableau Server model and connect to data. Data sources can be published separately, as a published data source, or may be contained in a workbook as an embedded data source. See https://onlinehelp.tableau.com/current/server/en-us/datasource.htm") - [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/current/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.") - [EmbeddedDatasource_A data source embedded in a workbook_](https://help.tableau.com/current/api/metadata_api/en-us/reference/embeddeddatasource.doc.html "EmbeddedDatasource - A data source embedded in a workbook") - [Field_Base GraphQL type for a field_](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [File_A file connection_](https://help.tableau.com/current/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/current/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/current/api/metadata_api/en-us/reference/flowcolumnoutputfield.doc.html "FlowColumnOutputField - Column output field implementation") - [FlowFieldOutputField_Field output field implementation_](https://help.tableau.com/current/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/current/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/current/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/current/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.*") - [Metric_Metrics are time series data constructed from fields contained in views. \*Retired in Tableau Cloud February 2024 / Server 2024.2.\*_](metric.doc.html "Metric - Metrics are time series data constructed from fields contained in views. *Retired in Tableau Cloud February 2024 / Server 2024.2.*") - [PublishedDatasource_A Tableau data source that has been published separately to Tableau Server. It can be used by multiple workbooks._](https://help.tableau.com/current/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/current/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/current/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/current/api/metadata_api/en-us/reference/table.doc.html "Table - A table containing columns") - [TableauSite_Site on Tableau server_](https://help.tableau.com/current/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/current/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/current/api/metadata_api/en-us/reference/tag.doc.html "Tag - A tag associated with content items") - [VirtualConnection_A virtual connection. \*Available in Tableau Cloud March 2022 / Server 2022.1 and later.\*_](virtualconnection.doc.html "VirtualConnection - A virtual connection. *Available in Tableau Cloud March 2022 / Server 2022.1 and later.*") - [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/current/api/metadata_api/en-us/reference/webdataconnector.doc.html "WebDataConnector - A web data connector") _menu_ Types ENUM # WorkbookOrderField Enum for fields that can be used for sorting ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - enum WorkbookOrderField { - # Sort by dashboards count - DASHBOARDS_COUNT - # Sort by embeddedDatasources count - EMBEDDED_DATASOURCES_COUNT - # Sort by owner count - OWNER_COUNT - # Sort by sheets count - SHEETS_COUNT - # Sort by views count - VIEWS_COUNT - # Sort by containerName - CONTAINER_NAME - # Sort by containsUnsupportedCustomSql - CONTAINS_UNSUPPORTED_CUSTOM_SQL - # Sort by id - ID - # Sort by luid - LUID - # Sort by name - NAME - # Sort by projectLuid - PROJECT_LUID - # Sort by projectName - PROJECT_NAME - # Sort by vizportalUrlId - VIZPORTAL_URL_ID - } ` ## [_link_](#require-by) Require by - [WorkbookSortOrder_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._](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksortorder.doc.html "WorkbookSortOrder - 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.") _menu_ Types OBJECT # WorkbooksConnection Connection Type for Workbook ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type WorkbooksConnection { - # List of nodes - nodes: [[Workbook](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbook.doc.html)!]! - # Information for pagination - pageInfo: [PageInfo](https://help.tableau.com/current/api/metadata_api/en-us/reference/pageinfo.doc.html)! - # Total number of objects in connection - totalCount: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.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/current/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/current/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/current/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/current/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/current/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/current/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/current/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/current/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/current/api/metadata_api/en-us/reference/database.doc.html "Database - A database containing tables") - [DatabaseServer_A database server connection_](https://help.tableau.com/current/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/current/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.*") - [Datasource_Root GraphQL type for embedded and published data sources Data sources are a way to represent how Tableau Desktop and Tableau Server model and connect to data. Data sources can be published separately, as a published data source, or may be contained in a workbook as an embedded data source. See https://onlinehelp.tableau.com/current/server/en-us/datasource.htm_](datasource.doc.html "Datasource - Root GraphQL type for embedded and published data sources Data sources are a way to represent how Tableau Desktop and Tableau Server model and connect to data. Data sources can be published separately, as a published data source, or may be contained in a workbook as an embedded data source. See https://onlinehelp.tableau.com/current/server/en-us/datasource.htm") - [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/current/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.") - [EmbeddedDatasource_A data source embedded in a workbook_](https://help.tableau.com/current/api/metadata_api/en-us/reference/embeddeddatasource.doc.html "EmbeddedDatasource - A data source embedded in a workbook") - [Field_Base GraphQL type for a field_](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [File_A file connection_](https://help.tableau.com/current/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/current/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/current/api/metadata_api/en-us/reference/flowcolumnoutputfield.doc.html "FlowColumnOutputField - Column output field implementation") - [FlowFieldOutputField_Field output field implementation_](https://help.tableau.com/current/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/current/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/current/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/current/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.*") - [Metric_Metrics are time series data constructed from fields contained in views. \*Retired in Tableau Cloud February 2024 / Server 2024.2.\*_](metric.doc.html "Metric - Metrics are time series data constructed from fields contained in views. *Retired in Tableau Cloud February 2024 / Server 2024.2.*") - [PublishedDatasource_A Tableau data source that has been published separately to Tableau Server. It can be used by multiple workbooks._](https://help.tableau.com/current/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/current/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/current/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/current/api/metadata_api/en-us/reference/table.doc.html "Table - A table containing columns") - [TableauSite_Site on Tableau server_](https://help.tableau.com/current/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/current/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/current/api/metadata_api/en-us/reference/tag.doc.html "Tag - A tag associated with content items") - [VirtualConnection_A virtual connection. \*Available in Tableau Cloud March 2022 / Server 2022.1 and later.\*_](virtualconnection.doc.html "VirtualConnection - A virtual connection. *Available in Tableau Cloud March 2022 / Server 2022.1 and later.*") - [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/current/api/metadata_api/en-us/reference/webdataconnector.doc.html "WebDataConnector - A web data connector") _menu_ Types INPUT\_OBJECT # WorkbookSortOrder 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. ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - input WorkbookSortOrder { - # GraphQL field to sort on - field: [WorkbookOrderField](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbookorderfield.doc.html)! - # Order direction to sort output - direction: [OrderDirection](https://help.tableau.com/current/api/metadata_api/en-us/reference/orderdirection.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/current/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/current/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/current/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/current/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/current/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/current/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/current/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/current/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/current/api/metadata_api/en-us/reference/database.doc.html "Database - A database containing tables") - [DatabaseServer_A database server connection_](https://help.tableau.com/current/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/current/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.*") - [Datasource_Root GraphQL type for embedded and published data sources Data sources are a way to represent how Tableau Desktop and Tableau Server model and connect to data. Data sources can be published separately, as a published data source, or may be contained in a workbook as an embedded data source. See https://onlinehelp.tableau.com/current/server/en-us/datasource.htm_](datasource.doc.html "Datasource - Root GraphQL type for embedded and published data sources Data sources are a way to represent how Tableau Desktop and Tableau Server model and connect to data. Data sources can be published separately, as a published data source, or may be contained in a workbook as an embedded data source. See https://onlinehelp.tableau.com/current/server/en-us/datasource.htm") - [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/current/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.") - [EmbeddedDatasource_A data source embedded in a workbook_](https://help.tableau.com/current/api/metadata_api/en-us/reference/embeddeddatasource.doc.html "EmbeddedDatasource - A data source embedded in a workbook") - [Field_Base GraphQL type for a field_](https://help.tableau.com/current/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [File_A file connection_](https://help.tableau.com/current/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/current/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/current/api/metadata_api/en-us/reference/flowcolumnoutputfield.doc.html "FlowColumnOutputField - Column output field implementation") - [FlowFieldOutputField_Field output field implementation_](https://help.tableau.com/current/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/current/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/current/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/current/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.*") - [Metric_Metrics are time series data constructed from fields contained in views. \*Retired in Tableau Cloud February 2024 / Server 2024.2.\*_](metric.doc.html "Metric - Metrics are time series data constructed from fields contained in views. *Retired in Tableau Cloud February 2024 / Server 2024.2.*") - [PublishedDatasource_A Tableau data source that has been published separately to Tableau Server. It can be used by multiple workbooks._](https://help.tableau.com/current/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/current/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/current/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/current/api/metadata_api/en-us/reference/table.doc.html "Table - A table containing columns") - [TableauSite_Site on Tableau server_](https://help.tableau.com/current/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/current/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/current/api/metadata_api/en-us/reference/tag.doc.html "Tag - A tag associated with content items") - [VirtualConnection_A virtual connection. \*Available in Tableau Cloud March 2022 / Server 2022.1 and later.\*_](virtualconnection.doc.html "VirtualConnection - A virtual connection. *Available in Tableau Cloud March 2022 / Server 2022.1 and later.*") - [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/current/api/metadata_api/en-us/reference/webdataconnector.doc.html "WebDataConnector - A web data connector")