# tableau 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 - ") ## @tableau/taco-toolkit - v2.1.0 ### Index ### Modules [app](https://help.tableau.com/current/api/webdataconnector/en-us/reference/modules/app.html) [handlers](https://help.tableau.com/current/api/webdataconnector/en-us/reference/modules/handlers.html) ### Settings #### Member Visibility - Inherited #### Theme OSLightDark Generated using [TypeDoc](https://typedoc.org/) # 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 - (Undefined variable: `Variables.PT_server_long`) (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/?_ga=2.61225580.1994005306.1652119972-235774019.1630077324) on the Salesforce website. #### On This Page [Skip to main content](#main-content) # 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 - (Undefined variable: Variables.PT\_server\_long) (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. # 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. # About Tableau Help 🕐 _1 min read_ ## 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. [Skip to main content](#main-content) # 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 - (Undefined variable: Variables.PT\_server\_long) (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. # 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. # About Tableau Help 🕐 _1 min read_ ## 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. **Deprecated** - This repository will be removed with the Tableau 26.3 release. The Web Data Connector 3.0 framework is deprecated and will not receive further updates. Migrate to the [REST API Connector on Tableau Exchange](https://exchange.tableau.com/products/1111)—built by Tableau, supports JSON and CSV over HTTP GET, Basic/Bearer/OAuth authentication, and runs on Tableau 2023.3 and later. Note: this connector is extract-only and requires a JDBC driver installation. # About Tableau Help 🕐 _1 min read_ ## 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. # About the Embedding API v3 The Embedding API v3 is a modern JavaScript library that supports Tableau viz web components. You can embed Tableau views in web pages and web applications using the JavaScript library methods directly, or embed views using the Tableau viz web components and attributes in your HTML code without using the API directly. * * * ## Embedding API v3 interfaces The top-level object is the `Viz` object. You can create, or instantiate, a `Viz` object as either a `TableauViz` object (to embed a view) or a `TableauAuthoringViz` object (to embed a web authoring view). From the `Viz` object, you can access all the workbooks, sheets, methods, and properties contained in the `Viz` object. You can also embed a view or a web authoring view using the Tableau web components (`` and ``). From these web components you can also access the `Viz` object for further processing. You configure the `Viz` objects or web components by setting attributes or properties. For information about creating a `Viz` object, see [Basic Embedding](/current/api/embedding_api/en-us/docs/embedding_api_basic.html). For information about configuring the `Viz` object, see [Configure Embedding Objects and Components](/current/api/embedding_api/en-us/docs/embedding_api_configure.html). The Embedding API v3 provides a rich set of interfaces. The basic interfaces are shown in the following diagram. After you create the `Viz` object (in either viewing or authoring mode), you can navigate to the individual worksheets and elements in the view through these interfaces. classDiagram class Viz Viz <|-- Workbook Workbook <|-- Sheet Sheet <|-- Dashboard Sheet <|-- Story Sheet <|-- Worksheet Viz: +height string Viz: +src string Viz: +width string Viz: +workbook Workbook Viz: ... Viz: +addEventListeners() Viz: +addFilter() Viz: ...() class Sheet{ +index: int +name: string ... } class Workbook { +name string +activeSheet Sheet ...() } class Worksheet { +isActive: bool +name: string ... +applyFilterAsync(): +getSelectedMarksAsync() : MarksCollection +getUnderlyingDataAsync(): DataTable ...() } class Dashboard { +index: int +isActive: bool ... +applyFilterAsync() +getFiltersAsync() ...() } class Story { +activeStoryPoint: StoryPoint +index: int ... +activateStoryPointAsync() +activateNextStoryPointAsync() ...() } For example, if you have a `Viz` object, you can transverse the interfaces to apply a filter to the currently active worksheet, by first accessing the `workbook` and then the `activeSheet` property. ``` // create the viz object, assumes an
element exists with id="tableauViz" import { TableauViz, } from 'https://public.tableau.com/javascripts/api/tableau.embedding.3.latest.min.js'; const viz = new TableauViz(); viz.src = 'https://my-server/views/my-workbook/my-view'; viz.toolbar = 'hidden'; // add the viz object to the DOM document.getElementById('tableauViz').appendChild(viz); let sheet = viz.workbook.activeSheet; sheet.applyFilterAsync("Container", ["Boxes"], FilterUpdateType.Replace); ``` For more information about the Embedding API v3 interfaces, see the [Embedding API Reference](/current/api/embedding_api/en-us/reference/index.html). * * * ## Importing the Embedding API v3 library The Embedding API v3 library is available as a JavaScript ES6 module and requires some special considerations. To include the library in the HTML code for your web application, you need to set the `type` attribute to `module` in the ` ``` If you’re creating a JavaScript file(s) as part of your embedded web application, to improve load times, import just the features you need from the Embedding API v3 library. For example, you might import `TableauViz` to create the JavaScript object and `TableauEventType` to set an event listener. If you include your JavaScript file in your web application, be sure to set the `type` to `module` in the ` ``` Replace `my-server` with the name of your Tableau Server. For example, if your server is `www.example.com`, to use the Embedding API v3 library you would include this line in your HTML page: ``` ``` For Tableau Cloud, use the following: ``` ``` Replace `Tableau-Pod` with the name of your pod. For example, if your Tableau Pod is `10ax`, the URL would look like this: ``` ``` For Tableau Public, use the following: ``` ``` * * * ## Installing the npm package Starting with Tableau Cloud (December 2023), the [Embedding API v3 library](https://www.npmjs.com/package/@tableau/embedding-api) is available from Node Package Manager (npm). Always use a version of the library that is compatible with the version of Tableau that hosts the view or metric. See [Versions of the Tableau Embedding API](#versions-of-the-tableau-embedding-api). The following command installs the Embedding API v3 library in the `node_modules` folder of the current directory. ```dotnetcli npm i @tableau/embedding-api ``` To install a specific version of the library, append `@` to the command. For example, to install the 3.12.1 library, use the command. ```dotnetcli npm i @tableau/embedding-api@3.12.1 ``` You can verify the installation by checking files in the `node_modules` folder (there should be a `@tableau` folder). If a `package.json` file exists in the directory where you ran the npm command to install the package, and specifies the version of the library to use, the latest version of the library that satisfies the semantic versioning is installed. If no `package.json` exists, or no dependency for the library is specified, the latest version of the library is installed. The following entry in the `package.json` file specifies the `3.12.1` library. The tilde (`~`) in front of the version number indicates that updates to the latest patched minor versions of that library can be used (that is, `3.12.*`). Be sure the version you use matches the version of the library used by the Tableau instance hosting the viz or metric. If you must lock it to a specific version or minor version, omit the tilde (`~`) or wildcard (`*`). ``` "dependencies": { "@tableau/embedding-api": "~3.12.1" } ``` ### Import the npm package In your JavaScript or TypeScript code, import the `TableauViz` object and any other classes and objects you need from the Embedding API v3 library. To simplify your code and improve load times, import just the classes you need, for example `TableauViz` to create the JavaScript object and `TableauEventType` to set an event listener. To import `TableauViz` and `TableauEventType`, use the following statement. Note that you import the library using the scoped package. ``` import { TableauViz, TableauEventType } from '@tableau/embedding-api'; ``` If you import the library, which is an ES module, be sure to specify `"type": "module"` in your `package.json` file. ``` { "name": "tableau-viz-demo", "version": "0.1.0", "private": true, "type": "module", "dependencies": { "@tableau/embedding-api": "~3.12.1", "etc. ....": "this example is not complete", } } ``` * * * ## Installing the React npm package A [React version of the Embedding API v3 library](https://www.npmjs.com/package/@tableau/embedding-api-react) is available from Node Package Manager (npm). For information about installing and using the Tableau Embedding React package, see [Using the Tableau Embedding API React Components](/current/api/embedding_api/en-us/docs/embedding_api_react.html). #### On This Page # Add Custom Context Menus You can create the custom menu items to enable users to run external actions, based upon the marks they’ve selected in a view. The context menu is added to the Uber tooltip that appears when users select marks, as shown in the following example. ![Example of a custom context menu](/current/api/embedding_api/en-us/assets/context_menu_example2.png "Example of a custom context menu on Uber tooltip") The context menu is integrated into the view, and lets you provide users with seamless access to external actions that you choose. * * * ## Context menu methods Starting with version 3.2 of the Embedding API 3.2 library, you can use the following methods to add or remove custom context menu items. For information about each method, click on the links.
MethodDescription
appendContextMenuAsyncAdds a new menu item.
renameContextMenuAsyncRenames the menu header. The default name is Embedded.
removeContextMenuAsyncRemoves the context menu and menu item.
The following section shows the steps you go through to add a menu item to the Uber tooltip and then tie that menu item to drive an external action. ## Add a custom context menu item To add a custom context menu item, use the `Worksheet.appendContextMenuAsync()` method. The method takes two parameters. The first specifies the location of the context menu. In this case, it is `ApiMenuType.Ubertip`, the only location currently supported. The second parameter specifies the context menu options and specifies the text that appears for the menu item. If the method succeeds, it returns the identifier for the menu item that was added. You use this identifier to remove the menu item or to know which menu item was clicked. For example, the following code snippet adds a menu item called “Run my app.” The ID returned by the `appendContextMenuAsync` method and the name of the menu item are mapped and stored in an array. ``` // The following assumes that you are calling this code from an `async` // function. ... const menuItemName = "Run my app"; const config = { displayName: menuItemName }; const menuItemMap = {}; // Stores identifiers of newly inserted context menu items try { const menuItemId = await worksheet.appendContextMenuAsync(ApiMenuType.Ubertip, config); menuItemMap[menuItemName] = menuItemId; } catch (e) { alert("An exception was thrown: " + e); } finally { return; } ... ``` ## Rename the default menu header By default, the menu heading in the Uber tip says “Embedded.” To change this to something that is more descriptive of the menu item(s) that you are adding, use the `Worksheet.renameContextMenuAsync()` method. In this case, the code snippet shows how you change the name of the menu header to “Actions” from “Embedding” (the default heading). You can use the `menuDescription` to provide a tooltip for the menu. ``` // The following assumes that you are calling this code from an `async` // function. ... const menuName = "Actions"; const menuDescription = "Run custom actions"; try { await worksheet.renameContextMenuAsync(ApiMenuType.Ubertip, menuName, menuDescription); } catch (e) { alert("An exception was thrown: " + e); } finally { return; } ... ``` ## Add an event listener for the custom context menu item Add an event listener and create an event handler for your custom menu item. You need to specify the event type as a `TableauEventType.CustomMarkContextMenuEvent`. The following code snippet specifies an event handler, called _customMarkEventHandler_, to take action when someone clicks the context menu item. ``` ... // Add the event listener viz.addEventListener(TableauEventType.CustomMarkContextMenuEvent, customMarkEventHandler); ... ``` ## Create the event handler for the menu item When the event occurs, the event handler is called and it takes the `CustomMarkContextMenuEvent` as a parameter. From the details of `CustomMarkContextMenuEvent`, you can get the identifier for the menu item that was clicked and the marks that were selected. You can use this information to take further action. In this example, the action is to call another method (`displaySelectedMarks`) that displays information about the selected marks. In your own code, you could use the selected data to call into another application or to drive actions within your web application. ``` // Get the context menu id function setMenuItemId(customMarkContextMenuEvent) { contextMenuId = customMarkContextMenuEvent.detail.getContextMenuId(); } function getMenuItemId() { return contextMenuId; } // define the event handler for the context menu item function customMarkEventHandler(customMarkContextMenuEvent) { console.log("Reached the customMarkContextMenuEvent"); // check the context menu id and run custom actions with the marks selected setMenuItemId(customMarkContextMenuEvent); return customMarkContextMenuEvent.detail.getSelectedMarksAsync().then(displaySelectedMarks); } // example action that shows how to process display the marks function displaySelectedMarks(marks) { const html = []; for (let markIndex = 0; markIndex < marks.data[0].data.length; markIndex++) { const columns = marks.data[0].columns; html.push(`Mark ${markIndex}, MenuId ${getMenuItemId()}:
    `); for (let colIndex = 0; colIndex < columns.length; colIndex++) { html.push(`
  • Field Name: ${columns[colIndex].fieldName}`); html.push(`
    Value: ${marks.data[0].data[markIndex][colIndex].formattedValue}
    • `); } html.push("
"); const infoDiv = document.getElementById("markDetails"); infoDiv.innerHTML = html.join(''); } } ``` #### On This Page # Add Event Listeners to Tableau Pulse You can use event listeners to create actions based on events that happen with the Tableau Pulse metric. When users make changes to filters, time dimensions, or when they discover new insights, you could use these events to gather information about the current state of the metric. Using this knowledge, you could add new interactions and make changes to your embedded application to suit the needs of your users. * * * ## Supported Tableau Pulse events The Embedding API supports the JavaScript `addEventListener()` method. You can register event listeners for Tableau Pulse objects. The Embedding API supports the following event types (`TableauEventType`) for Tableau Pulse metrics.
TableauEventTypeString literalDescription
FirstInteractivefirstinteractiveRaised when an embedded Pulse metric has completed its initial rendering and is interactive.
FirstPulseMetricSizeKnownfirstpulsemetricsizeknownRaised when the size of the Pulse metric is known.
PulseErrorpulseerrorRaised when an internal Pulse error occurs.
PulseFiltersChangedpulsefilterschangedRaised when a Pulse filter change occurs. See Adding an event listener for a PulseFiltersChanged event.
PulseInsightDiscoveredpulseinsightdiscoveredRaised when a Pulse insight is discovered.
PulseMetricSizeChangedpulsemetricsizechangedRaised when the size of the Pulse metric changes.
PulseTimeDimensionChangedpulsetimedimensionchangedRaised when a Pulse time dimension change occurs.
PulseUrlChangedpulseurlchangedRaised when a Pulse URL change occurs. Note that changes to Pulse filters or time dimensions creates a new URL for the Pulse metric with those settings.
* * * ## Add an event listener using the addEventListener() method 1. Get the `TableauPulse` object. 2. Add the event listener by calling the JavaScript `addEventListener()` method on the `TableauPulse` object. 3. Specify the type of event and the event handler. The type of the event must be one of the supported types defined in the `TableauEventType` enumeration (see [Supported Pulse events](#supported-tableau-pulse-events)). The event handler can either be a callback function or an anonymous inline function. The callback method or inline function can handle the event object raised to retrieve additional data captured in the event. ### Example: Adding an event listener for a `FirstInteractive` event In some cases you might want to take actions immediately after the Pulse metric first loads. For example, you want to set filters or perform some other customization for those viewing the embedded metric. You can do this by adding an event listener for a `TableauEventType.FirstInteractive` event. After the Pulse metric has rendered and is interactive, the first interactive event is raised, which calls your event handler. You can use your event handler to call other methods that you want to run after initialization. The following example shows an event handler that uses an inline anonymous function that writes the event to the console. ``` // assumes a Pulse object has been created const tableauPulse = document.querySelector("tableau-pulse"); tableauPulse.addEventListener(TableauEventType.FirstInteractive, (e) => { console.log(e.type); // call methods to run immediately after loading }); ``` Here’s the same event handler, this time using a callback function. ``` // assumes a Pulse object has been created const tableauPulse = document.querySelector("tableau-pulse"); tableauPulse.addEventListener(TableauEventType.FirstInteractive, firstInteractiveHandler); function firstInteractiveHandler(e) { console.log(e.type); // call methods to run immediately after loading }; ``` * * * ## Remove an event listener 1. Get the `TableauPulse` object. 2. Remove the event listener by calling the JavaScript `removeEventListener()` method and specifying the event type and the name of your event handler. For example, to remove the event handler for the `TableauEventType.FirstInteractive` event called, `firstInteractiveHandler` you might use something like the following: ``` const tableauPulse = document.querySelector("tableau-pulse"); tableauPulse.removeEventListener(TableauEventType.FirstInteractive, firstInteractiveHandler); ``` * * * ## Examples: Tableau Pulse event listeners The following section shows how you could add event listeners to embedded Pulse metrics to gather information or to take further action. * * * ### Adding an event listener for a `FirstPulseMetricSizeKnown` event You can add an event listener to watch for the moment the Tableau Pulse metric fully renders, and its dimensions are known. The following example shows how you might extract the dimensions of the Pulse metric from the event details. Use the dimensions to set the style properties for the Pulse iframe, and to adjust and customize other components in your embedded application. ``` // assumes a Pulse object has been created named "tableauPulse" tableauPulse.addEventListener(TableauEventType.FirstPulseMetricSizeKnown, (e) => { console.log(TableauEventType.FirstPulseMetricSizeKnown, e.detail); // Extract the width and height from the event details const { width, height } = e.detail; // Set the width and height properties of the Pulse iframe style tableauPulse.iframe.style.width = `${width}px`; tableauPulse.iframe.style.height = `${height}px`; }); ``` * * * ### Adding an event listener for a `PulseUrlChanged` event When users change filters or change the time dimensions on an embedded Pulse metric, the changes also create a new URL for the metric. You can capture these events using the `PulseUrlChanged` event. The information returned from the event includes the old URL and the new URL, and also information about the context. Currently, the value returned for `context` is either `undefined` or `"session-expired"`, if the Tableau Pulse session has timed out. To ensure a seamless experience for users, you could add an event listener that checks for (`context = 'session-expired'`) and use that information to generate a new JWT to keep users logged in. ``` // assumes a Pulse object has been created named "tableauPulse" tableauPulse.addEventListener(TableauEventType.PulseUrlChanged, (e) => { console.log(TableauEventType.PulseUrlChanged); console.log('oldUrl', e.detail.oldUrl); console.log('newUrl', e.detail.newUrl); console.log('context', e.detail.context) }); ``` * * * ### Adding an event listener for a `PulseTimeDimensionChanged` event You can add an event listener to watch for any change to the time dimension in the Pulse metric. When users change the time dimensions on an embedded Pulse metric, the change also creates a new URL for the metric. This event is also raised whenever you call the `applyTimeDimensionAsync()` method. ``` // assumes a Pulse object has been created named "tableauPulse" tableauPulse.addEventListener(TableauEventType.PulseTimeDimensionChanged, (e) => { console.log(TableauEventType.PulseTimeDimensionChanged); console.log('timeDimension', e.detail.timeDimension); }); ``` * * * ### Adding an event listener for a `PulseFiltersChanged` event You can add an event listener to watch for any changes to the filters that are applied to the Pulse metric. This includes changes made in the Tableau Pulse user interface, by selecting and applying filter options, or by Embedding API calls to the Pulse filter methods (`applyFilterAsync`, `applyFiltersAsync`, `clearFilterAsync`, `clearFiltersAsync`). Note that because applying filters to a Pulse metric creates and navigates to a new metric, it’s best to ensure the new metric has loaded before attempting to interact with it. The easiest way to do this is by adding a one-time event listener for the next `TableauEventType.FirstInteractive` event and wrapping it in a promise that resolves when the event occurs. For example, the following code inserts a first interactive event that must resolve before calling the `getFiltersAsync` method. Note that the event handler for the Pulse filter change event is an anonymous `async` call and that the two method calls (the `addEventListener()` promise and the `getFiltersAsync()`) use the `await` keyword. The event listener for the first interactive event uses the `once` option, so that the listener is only invoked at most one time before being removed. ``` // assumes a Pulse object has been created named "tableauPulse" tableauPulse.addEventListener(TableauEventType.PulseFiltersChanged, async (e) => { console.log(TableauEventType.PulseFiltersChanged); await new Promise(resolve => { tableauPulse.addEventListener(TableauEventType.FirstInteractive, resolve { once: true }); }); const filters = await e.detail.getFiltersAsync(); console.log('filters', filters); }); ``` * * * ### Adding an event listener for a `PulseInsightDiscovered` event You can add an event listener to capture the details whenever an insight for a Pulse metric is selected. The following code example shows how you could extract information from the event details, including the type of insight, the question being asked, markup, and score. For example, you could extract the HTML markup of the insight and use that somewhere else in your embedded application. For more information about the insights, see [The Insights Platform and Insight Types in Tableau Pulse](https://help.tableau.com/current/online/en-us/pulse_insights_platform_insight_types.htm). ``` // assumes a Pulse object has been created named "tableauPulse" tableauPulse.addEventListener(TableauEventType.PulseInsightDiscovered, (e) => { console.log(TableauEventType.PulseInsightDiscovered); console.log('id', e.detail.id); console.log('characterization', e.detail.characterization); console.log('markup', e.detail.markup); console.log('question', e.detail.question); console.log('score', e.detail.score); console.log('type', e.detail.type); console.log('version', e.detail.version); }); ``` * * * ### Adding an event listener for a `PulseError` event You can add an event listener to capture the details when a Pulse error occurs. The following code example shows the breakdown of the event details. ``` // assumes a Pulse object has been created named "tableauPulse" tableauPulse.addEventListener(TableauEventType.PulseError, (e) => { console.log(TableauEventType.PulseError); console.log('message', e.detail.message); console.log('httpStatus', e.detail.httpStatus); console.log('messageVisibility', e.detail.messageVisibility); }); ``` * * * ### Adding an event listener for a `PulseMetricSizeChanged` event You can add an event listener to capture the details when the size of a Pulse metric changes. The following example shows how you might extract the dimensions of the Pulse metric from the event details. Use the dimensions to set the style properties for the Pulse iframe, and to adjust and customize other components in your embedded application. ``` tableauPulse.addEventListener(TableauEventType.PulseMetricSizeChanged, (e) => { console.log(TableauEventType.PulseMetricSizeChanged, e.detail); const { width, height } = e.detail; tableauPulse.iframe.style.width = `${width}px`; tableauPulse.iframe.style.height = `${height}px`; }); ``` #### On This Page # Add Event Listeners to the Embedded Tableau View You can use event listeners to create actions based on events that happen with the view. The event listener registers a callback handler, that handler method gets called when an event occurs. The `viz` object acts as the central event hub. This way you only have to go to one place for all events. It also means that events can be raised on an object that might not have been created yet. For example, the `MarkSelectionChanged` event can be raised for a particular sheet even though the `sheet` object hasn’t been created yet. Each event contains an anonymous object with information relating to that event, such as the `sheet` the event occurred on. Listening to an event is done by calling `viz.addEventListener(type, callback)` and passing in a callback function. Here’s an example of listening to an event, where the name of the custom function is `handleFirstInteractive()`. You would define this function in your JavaScript code: ``` const tableauViz = document.getElementById('tableauViz'); tableauViz.addEventListener(TableauEventType.FirstInteractive, handleFirstInteractive); ``` There is an even easier way to add an event listener by adding an attribute to the `` or `` web component. Both of these methods are described in the following section. * * * ## Supported events The Embedding API supports the following event types (`TableauEventType`). The type of event you can listen for depends upon whether you’re embedding a view (using a `` web component or `TableauViz` object, for example) or embedding web authoring (using a`` web component or `TableauAuthoringViz` object). Some events are available when you’re embedding a view in viewing mode. Others apply only for embedded web authoring. And some apply to both viewing and authoring.
TableauEventTypeString literalWeb AttributeDescriptionComponent
CustomMarkContextMenuEvent"custommarkcontextmenu"onCustomMarkContextMenuEventRaised when a custom mark context menu is clicked. See Add a Custom Context MenuViewing
CustomViewLoaded"customviewloaded"onCustomViewLoadedRaised when a custom view has finished loading. This event is raised after the callback function for FirstInteractive (if any) has been called.Viewing
CustomViewRemoved"customviewremoved"onCustomViewRemovedRaised when a custom view has been removed.Viewing
CustomViewSaved"customviewsaved"onCustomViewSavedRaised when a custom view has been saved (newly created or updated).Viewing
CustomViewSetDefault"customviewsetdefault"onCustomViewSetDefaultRaised when a custom view has been set as the default view for a workbook.Viewing
EditButtonClicked"editbuttonclicked"onEditButtonClickedRaised when the user clicks the Edit button.Viewing
EditInDesktopButtonClicked"editindesktopbuttonclicked"onEditInDesktopButtonClickedRaised when the user clicks the Edit In Desktop button.Authoring, Viewing
FilterChanged"filterchanged"onFilterChangedRaised when any filter has a changed state.Viewing
FirstInteractive"firstinteractive"onFirstInteractiveRaised when the viz first becomes interactive after loading.Authoring, Viewing
FirstVizSizeKnown"firstvizsizeknown"onFirstVizSizeKnownRaised when the size of the viz object is known. You can use this event to perform tasks such as resizing the elements surrounding the viz object after the object’s size has been established.Authoring, Viewing
MarkSelectionChanged"markselectionchanged"onMarkSelectionChangedRaised when the selected marks in a viz have changed.Viewing
ToolbarStateChanged"toolbarstatechanged"onToolbarStateChangedRaised when a toolbar button or control becomes available or becomes unavailable.Viewing
TabSwitched"tabswitched"onTabSwitchedRaised after a tab switch occurs (the active sheet has changed). Guarantees the viz object will be interactive after this.Viewing
ParameterChanged"parameterchanged"onParameterChangedA parameter has had its value modified. You can use this event type with Parameter objects.Viewing
UrlAction"urlaction"onUrlActionRaised when Raised when a URL action occurs. See the UrlActionEvent class.Viewing
WorkbookPublished"workbookpublished"onWorkbookPublishedRaised when the workbook has been published.Authoring
WorkbookPublishedAs"workbookpublishedas"onWorkbookPublishedAsRaised when “publish as” is successful.Authoring
WorkbookReadyToClose"workbookreadytoclose"onWorkbookReadyToCloseRaised when the workbook is ready to close.Authoring
* * * **Note** Use the `TableauEventType` enum (for example, `TableauEventType.MarkSelectionChanged`) when you add or remove the event listener using the Tableau Embedding API and the `addEventListener` and `removeEventLister` methods. * * * ## Using simplified event handling Starting in Embedding API v3 (version 3.3), you can link your custom event handler to an event declaratively in the `` or `` web component by specifying the event type attribute. The following example calls a JavaScript function to handle the `onMarkSelectionChanged` event. When a `onMarkSelectionChanged` event occurs, the `handleMarksSelection()` event handler is called. You define the event handler in your JavaScript code. ``` ... ... ``` The following example shows a web authoring component that adds an event listener to handle a published event. ``` ... ... ``` Before v3.3, you could only configure an event listener in JavaScript using the `addEventListener` method. The event type attribute makes it easy to add custom event handlers. * * * ## Add an event listener using the addEventListener() method 1. Get the `viz` object. 2. Add the event listener by calling `addEventListener` and specifying the type of event and the callback method to call. The name of the event must be one of the supported types defined in the `TableauEventType` enumeration. The callback method must handle the event object raised. ``` async function getSelectedMarks(event) { const marksSelected = await event.detail.getMarksAsync(); const numMarks = marksSelected.data[0].data.length; console.log(`${numMarks} marks Selected`); } let viz = document.getElementById('tableauViz'); viz.addEventListener(TableauEventType.MarkSelectionChanged, getSelectedMarks); ``` ## Remove an event listener 1. Get the `viz` object. 2. Remove the event listener by using the `removeEventListener` method and specifying the name of your event handler. For example, to remove the event handler for the `TableauEventType.MarkSelectionChanged` event called, `getSelectedMarks` you might use something like the following: ``` let viz = document.getElementById('tableauViz'); viz.removeEventListener(TableauEventType.MarkSelectionChanged, getSelectedMarks); ``` ## Add an event listener after the viz is first loaded In some cases you might want to take actions right after the view is first loaded. For example, you might want to set the filtering or perform some other customization for the person who is viewing the embedded viz. You can do this by adding an event listener on `TableauEventType.FirstInteractive` event type. In addition, you can wrap the call in a `window.onload` event handler, so that your `FirstInteractive` event is called after all the dependent resources have been loaded. ``` window.onload = function () { let viz = document.getElementById('tableauViz'); viz.addEventListener(TableauEventType.FirstInteractive, async (event) => { console.log(`Event type is ${event.type}`); // call methods to run immediately after loading }); } ``` #### On This Page - [@tableau/taco-toolkit](https://help.tableau.com/current/api/webdataconnector/en-us/reference/index.html) - [app](https://help.tableau.com/current/api/webdataconnector/en-us/reference/modules/app.html) - [AggType](https://help.tableau.com/current/api/webdataconnector/en-us/reference/enums/app.AggType.html) # Enumeration AggType The aggregation type for a table column. It can be assigned as metadata for columns of the int and float dataType. ##### Index ### Enumeration Members [Avg](https://help.tableau.com/current/api/webdataconnector/en-us/reference/enums/app.AggType.html#Avg) [Count](https://help.tableau.com/current/api/webdataconnector/en-us/reference/enums/app.AggType.html#Count) [CountDist](https://help.tableau.com/current/api/webdataconnector/en-us/reference/enums/app.AggType.html#CountDist) [Median](https://help.tableau.com/current/api/webdataconnector/en-us/reference/enums/app.AggType.html#Median) [Sum](https://help.tableau.com/current/api/webdataconnector/en-us/reference/enums/app.AggType.html#Sum) ## Enumeration Members ### Avg[](#Avg) Avg: "avg" ### Count[](#Count) Count: "count" ### CountDist[](#CountDist) CountDist: "count\_dist" ### Median[](#Median) Median: "median" ### Sum[](#Sum) Sum: "sum" ### Settings #### Member Visibility - Inherited #### Theme OSLightDark ### On This Page - [Avg](#Avg) - [Count](#Count) - [CountDist](#CountDist) - [Median](#Median) - [Sum](#Sum) Generated using [TypeDoc](https://typedoc.org/) - [@tableau/taco-toolkit](https://help.tableau.com/current/api/webdataconnector/en-us/reference/index.html) - [app](https://help.tableau.com/current/api/webdataconnector/en-us/reference/modules/app.html) - [AjaxResponse](https://help.tableau.com/current/api/webdataconnector/en-us/reference/interfaces/app.AjaxResponse.html) # Interface AjaxResponse #### Type Parameters - #### D = any #### Hierarchy - AjaxResponse ##### Index ### Properties [body](https://help.tableau.com/current/api/webdataconnector/en-us/reference/interfaces/app.AjaxResponse.html#body) [headers](https://help.tableau.com/current/api/webdataconnector/en-us/reference/interfaces/app.AjaxResponse.html#headers) [ok](https://help.tableau.com/current/api/webdataconnector/en-us/reference/interfaces/app.AjaxResponse.html#ok) [status](https://help.tableau.com/current/api/webdataconnector/en-us/reference/interfaces/app.AjaxResponse.html#status) [text](https://help.tableau.com/current/api/webdataconnector/en-us/reference/interfaces/app.AjaxResponse.html#text) [type](https://help.tableau.com/current/api/webdataconnector/en-us/reference/interfaces/app.AjaxResponse.html#type) ## Properties ### body[](#body) body: D ### headers[](#headers) headers: Record ### ok[](#ok) ok: boolean ### status[](#status) status: number ### text[](#text) text: string ### type[](#type) type: string ### Settings #### Member Visibility - Inherited #### Theme OSLightDark ### On This Page - [body](#body) - [headers](#headers) - [ok](#ok) - [status](#status) - [text](#text) - [type](#type) Generated using [TypeDoc](https://typedoc.org/) [Skip to main content](#main-content) # Analytics Extensions Settings Methods Enable and configure [analytics extensions](https://help.tableau.com/current/server/en-us/config_r_tabpy.htm) on sites and, for on premise installations, on servers. With these extensions you can extend Tableau dynamic calculations with languages like R and python, and with other tools and platforms. For more information, see [Analytics Extensions API](https://tableau.github.io/analytics-extensions-api/). When upgrading from a server version less than 2020.2, analytics extensions must be enabled on each site even if external services were enabled on the server being upgraded. Connections for sites must be ported manually. Using the analytics extensions settings methods you can: - Enable and disable analytics extensions for a Tableau server (on-premise only) or for a site. - Create and manage an extension's connections to the service hosting your custom calculations. # Use Postman Our Postman collection of requests enables you to construct, send, and examine HTTP requests to the Tableau Server or Tableau Cloud API without writing initial code. Postman is a free online app used by many developers for prototyping API calls, investigating issues, and generating request code in a variety of languages. Postman: [Analytics Extensions Settings Methods](https://www.postman.com/salesforce-developers/workspace/salesforce-developers/folder/12721794-2273366b-11e3-454c-8f8a-f68a59a7b375) ## Add analytics extension connection to site Adds a new analytics extension connection for an external service to a site. **Version:** Available in API 3.11 (Tableau Cloud March 2021 / Server 2021.1) and later. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** This method can only be called by users with server or site administrator permissions. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** \`tableau:analytics\_extensions:create\`. Added in API 3.28. Access Scopes Overview: [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) or [Server](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) POST {server}/api/-/settings/site/extensions/analytics/connections [view details](#) ## Delete analytics extension connection from site Deletes a specific analytics extension connection for an external service from a site. **Version:** Available in API 3.11 (Tableau Cloud March 2021 / Server 2021.1) and later. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Can only be called by users with site or server administrator permissions. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** Not available. [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) DELETE {server}/api/-/settings/site/extensions/analytics/connections/{connection\_luid} [view details](#) ## Remove current analytics extension connection for workbook Remove the currently used analytics extension connection to an external service from the specified workbook. The connection remains configured, and is available for further usage by the workbook. **Version:** Available in API 3.11 (Tableau Cloud March 2021 / Server 2021.1) and later. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** This method can be called by users that have permissions to the specified workbook. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** \`tableau:analytics\_extensions:delete\`. Added in API 3.28. Access Scopes Overview: [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) or [Server](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) DELETE {server}/api/-/settings/site/extensions/analytics/workbooks/{workbook\_luid}/selected\_connection [view details](#) ## Get analytics extension details Get the details of a specified analytics extension connection to an external service. **Version:** Available in API 3.11 (Tableau Cloud March 2021/ Server 2021.1) and later. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Can only be called by users with site or server administrator permissions. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** \`tableau:analytics\_extensions:read\`. Added in API 3.28. Access Scopes Overview: [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) or [Server](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) GET {server}/api/-/settings/site/extensions/analytics/connections/{connection\_luid} [view details](#) ## List analytics extension connections on site Lists a site's analytics extension connections for external services. **Version:** Available in API 3.11 (Tableau Cloud March 2021 / Server 2021.1) and later. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** This method can only be called by users with server or site administrator permissions. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** \`tableau:analytics\_extensions:read\`. Added in API 3.28. Access Scopes Overview: [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) or [Server](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) GET {server}/api/-/settings/site/extensions/analytics/connections [view details](#) ## Get enabled state of analytics extensions on server Gets the enabled/disabled state of analytics extensions on a server. **Version:** Available in API 3.11 ( Tableau Server 2021.1) and later. Not available for Tableau Cloud. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** This method can only be called by users with server administrator permissions. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** \`tableau:extensions\_server\_settings:read\`. Added in API 3.28. Access Scopes Overview: [Access scopes for connected apps](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) GET {server}/api/-/settings/server/extensions/analytics [view details](#) ## Get enabled state of analytics extensions on site Gets the enabled/disabled state of analytics extensions on a site. **Version:** Available in API 3.11 (Tableau Cloud March 2021 / Server 2021.1) and later. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** This method can only be called by users with server or site administrator permissions. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** \`tableau:analytics\_extensions:read\`. Added in API 3.28. Access Scopes Overview: [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) or [Server](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) GET {server}/api/-/settings/site/extensions/analytics [view details](#) ## List analytics extension connections of workbook Lists basic details of each analytics extension connection available for a specified workbook, including connection type and name. **Version:** Available in API 3.11 (Tableau Cloud March 2021 / Server 2021.1) and later. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** This method can be called by users that have permissions to the specified workbook. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** \`tableau:analytics\_extensions:read\`. Added in API 3.28. Access Scopes Overview: [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) or [Server](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) GET {server}/api/-/settings/site/extensions/analytics/workbooks/{workbook\_luid}/connections [view details](#) ## Get current analytics extension for workbook Gets basic details, including connection type and name, of the analytics extension connection to an external service that the specified workbook is currently using. **Version:** Available in API 3.11 (Tableau Cloud March 2021 / Server 2021.1) and later. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** This method can be called by users that have permissions to the specified workbook. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** \`tableau:analytics\_extensions:read\`. Added in API 3.28. Access Scopes Overview: [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) or [Server](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) GET {server}/api/-/settings/site/extensions/analytics/workbooks/{workbook\_luid}/selected\_connection [view details](#) ## Update analytics extension connection of site Updates the details of specified analytics extension connection for an external service to a site. **Version:** Available in API 3.11 (Tableau Cloud March 2021 / Server 2021.1) and later. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Can only be called by users with site or server administrator permissions. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** \`tableau:analytics\_extensions:update\`. Added in API 3.28. Access Scopes Overview: [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) or [Server](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) PUT {server}/api/-/settings/site/extensions/analytics/connections/{connection\_luid} [view details](#) ## Enable or disable analytics extensions on server Enables or disables analytics extensions on a server. **Version:** Available in API 3.11 ( Tableau Server 2021.1) and later. Not available for Tableau Cloud. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** This method can only be called by users with server administrator permissions. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** \`tableau:extensions\_server\_settings:update\`. Added in API 3.28. Access Scopes Overview: [Access scopes for connected apps](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) PUT {server}/api/-/settings/server/extensions/analytics [view details](#) ## Update enabled state of analytics extensions on site Enables or disables analytics extensions on a site. **Version:** Available in API 3.11 (Tableau Cloud March 2021 / Server 2021.1) and later. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** This method can only be called by users with server or site administrator permissions. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** \`tableau:analytics\_extensions:update\`. Added in API 3.28. Access Scopes Overview: [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) or [Server](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) PUT {server}/api/-/settings/site/extensions/analytics [view details](#) ## Update analytics extension for workbook Updates the analytics extension connection to external service currently used by a workbook. **Version:** Available in API 3.11 (Tableau Cloud March 2021 / Server 2021.1) and later. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** This method can be called by users that have permissions to the specified workbook. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** \`tableau:analytics\_extensions:update\`. Added in API 3.28. Access Scopes Overview: [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) or [Server](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) PUT {server}/api/-/settings/site/extensions/analytics/workbooks/{workbook\_luid}/selected\_connection [view details](#) _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 - AnalyticsObjectType # Enumeration AnalyticsObjectType - Defined in packages/api-external-contract-js/src/ExternalContract/Shared/Namespaces/Tableau.ts:7 ##### Index ### Enumeration Members [Cluster](#cluster) [Forecast](#forecast) [TrendLine](#trendline) ## Enumeration Members ### Cluster[](#cluster) Cluster: "cluster" - Defined in packages/api-external-contract-js/src/ExternalContract/Shared/Namespaces/Tableau.ts:8 ### Forecast[](#forecast) Forecast: "forecast" - Defined in packages/api-external-contract-js/src/ExternalContract/Shared/Namespaces/Tableau.ts:9 ### TrendLine[](#trendline) TrendLine: "trend-line" - Defined in packages/api-external-contract-js/src/ExternalContract/Shared/Namespaces/Tableau.ts:10 ### Settings Member Visibility - Protected - Inherited - External ThemeOSLightDark ### On This Page Enumeration Members [Cluster](#cluster)[Forecast](#forecast)[TrendLine](#trendline) - Annotation # Interface Annotation Represents an annotation in a worksheet. interface Annotation {     [annotationHTML](#annotationhtml): string;     [annotationId](#annotationid): number;     [annotationText](#annotationtext): string;     [annotationType](#annotationtype): [AnnotationType](https://help.tableau.com/current/api/embedding_api/en-us/reference/enums/AnnotationType.html);     [tupleId](#tupleid): number; } - Defined in packages/api-external-contract-js/src/ExternalContract/Shared/AnnotationInterfaces.ts:6 ##### Index ### Properties [annotationHTML](#annotationhtml) [annotationId](#annotationid) [annotationText](#annotationtext) [annotationType](#annotationtype) [tupleId](#tupleid) ## Properties ### annotationHTML[](#annotationhtml) annotationHTML: string #### Returns[](#returns) The formatted annotation as a HTML string. HTML is currently not accepted when adding an annotation. - Defined in packages/api-external-contract-js/src/ExternalContract/Shared/AnnotationInterfaces.ts:10 ### annotationId[](#annotationid) annotationId: number #### Returns[](#returns-1) Unique id representing the annotation. - Defined in packages/api-external-contract-js/src/ExternalContract/Shared/AnnotationInterfaces.ts:15 ### annotationText[](#annotationtext) annotationText: string #### Returns[](#returns-2) The plain text of the annotation. - Defined in packages/api-external-contract-js/src/ExternalContract/Shared/AnnotationInterfaces.ts:20 ### annotationType[](#annotationtype) annotationType: [AnnotationType](https://help.tableau.com/current/api/embedding_api/en-us/reference/enums/AnnotationType.html) #### Returns[](#returns-3) The annotation type. - Defined in packages/api-external-contract-js/src/ExternalContract/Shared/AnnotationInterfaces.ts:25 ### tupleId[](#tupleid) tupleId: number #### Returns[](#returns-4) Unique tuple representing the mark that is being annotated. The tupleId will be 0 for Area or Point annotations. - Defined in packages/api-external-contract-js/src/ExternalContract/Shared/AnnotationInterfaces.ts:30 ### Settings Member Visibility - Protected - Inherited - External ThemeOSLightDark ### On This Page Properties [annotationHTML](#annotationhtml)[annotationId](#annotationid)[annotationText](#annotationtext)[annotationType](#annotationtype)[tupleId](#tupleid) - AnnotationType # Enumeration AnnotationType - Defined in packages/api-external-contract-js/src/ExternalContract/Shared/Namespaces/Tableau.ts:13 ##### Index ### Enumeration Members [Area](#area) [Mark](#mark) [Point](#point) ## Enumeration Members ### Area[](#area) Area: "area" - Defined in packages/api-external-contract-js/src/ExternalContract/Shared/Namespaces/Tableau.ts:16 ### Mark[](#mark) Mark: "mark" - Defined in packages/api-external-contract-js/src/ExternalContract/Shared/Namespaces/Tableau.ts:14 ### Point[](#point) Point: "point" - Defined in packages/api-external-contract-js/src/ExternalContract/Shared/Namespaces/Tableau.ts:15 ### Settings Member Visibility - Protected - Inherited - External ThemeOSLightDark ### On This Page Enumeration Members [Area](#area)[Mark](#mark)[Point](#point) [Skip to main content](#main-content) # API Reference **Important changes for the Tableau JavaScript API** As of February 2024, the Tableau JavaScript API is deprecated. Use the Embedding API v3 instead for embedding interactive views into web pages and applications. For guidance on embedding Tableau views, see the [Tableau Embedding API v3 Help](https://help.tableau.com/current/api/embedding_api/en-us/index.html). This section describes classes and methods of the Tableau JavaScript API. The JavaScript API files are located on the server (including Tableau Cloud and Tableau Public). There is no separate download. To use the JavaScript API, you just specify the URL to the JavaScript API file in your web page. For more information, see [Access the API](https://help.tableau.com/current/api/js_api/en-us/JavaScriptAPI/js_api_concepts_get_API.htm). ## Style and Conventions Tableau's JavaScript API follows these JavaScript standards for formatting names: - **Classes** use PascalCase (initial capital letter, with each subsequent word capitalized). - **Namespaces, methods, parameters, and variables** use camelCase (initial lower-case letter, with each subsequent word capitalized). - **Constants and enum values** use UPPERCASE; multi-word names use UPPERCASE\_UNDERSCORE\_DELIMITED. - **Protected variables or method** start with an initial underscore ( \_ ) character, indicating that it should not be referenced by the programmer. Tableau does not provide support for programs that customers create that use the Tableau JavaScript API. For help with your code, submit questions and ask for help on the Tableau developer community forums. Tableau does provide support for potential bugs in the Tableau JavaScript API code itself, and for unmodified sample code that isn't working. ## Top-Level Class Diagram The following class diagram shows the relationships between the top-level classes, as well as the inheritance hierarchy for the `Sheet`, `Dashboard`, `Story` and `Worksheet` classes. Note that there's always a way to traverse back up the containment hierarchy with parent pointers. The exception of `VizManager`, because that's a static class and always accessible. ![](/tableau/current/en-us/api/js_api/en-us/Img/jsapi_toplevel.png) ## Asynchronous and Error Classes ### Promise Class Represents a promise to return a value from an asynchronous method in the future. The Tableau JavaScript API implements the [Promises/A](http://wiki.commonjs.org/wiki/Promises/A) specification. #### Methods

Name

Return Type

Description

then(callback: Function, errback: Function)

Promise

Creates a link in the asynchronous callable chain. The callback function is called on success. The errback function is called when there is an error. Both parameters are optional.

always(callback: Function)

Promise

Registers a callback that will be called when a promise is resolved or rejected. Shortcut for then(callback, callback).
otherwise(errback: Function) Promise Registers a rejection handler. Shortcut for then(null, errback).
### TableauException Class The `TableauException` class is not a real class, but simply adds an `id` field to the standard JavaScript `Error` object when an exception is thrown from within the API. This allows you to uniquely identify the error without having to parse the error string. It also allows you to add localized messages. #### Constructor There is no public constructor. The only way to get a reference to a `TableauException` object is within a `catch` block. #### Fields

Name

Type

Description

tableauSoftwareErrorCode

ErrorCode

Represents an ErrorCode enum value.

message

string

This is already defined on the standard Error object, but the message will contain a description of the exception that the API code specifies.
### ErrorCode Enum Here's a list of the different exceptions that the API can throw:

Name

Value

Description

BROWSER_NOT_CAPABLE

browserNotCapable

The browser is not capable of supporting the Tableau JavaScript API.

DOWNLOAD_WORKBOOK_ NOT_ALLOWED

downloadWorkbookNotAllowed

The permissions on a workbook or a view do not allow downloading the workbook.

FILTER_CANNOT_BE_ PERFORMED

filterCannotBePerformed

An error occurred while attempting to perform a filter operation.

INDEX_OUT_OF_RANGE

indexOutOfRange

Attempted to switch to a sheet by index that does not exist in the workbook.

INTERNAL_ERROR

internalError

An error occurred within the Tableau JavaScript API. Contact Tableau Support.
INVALID_AGGREGATION_ FIELD_NAME invalidAggregationFieldName An invalid aggregation was specified for the filter, such as setting a range filter to "SUM(Sales)" instead of "Sales".

INVALID_CUSTOM_VIEW_ NAME

invalidCustomViewName

An operation was attempted on a custom view that does not exist.

INVALID_DATE_PARAMETER

invalidDateParameter

An invalid date was specified in a method that required a date parameter.

INVALID_FILTER_ FIELDNAME

invalidFilterFieldName

A filter operation was attempted on a field that does not exist in the data source.

INVALID_FILTER_ FIELDNAME_OR_VALUE

invalidFilterFieldNameOrValue

Either a filter operation was attempted on a field that does not exist in the data source, or the value supplied in the filter operation is the wrong data type or format.

INVALID_FILTER_ FIELDVALUE

invalidFilterFieldValue

A filter operation was attempted using a value that is the wrong data type or format.

INVALID_PARAMETER

invalidParameter

A parameter is not the correct data type or format. The name of the parameter is specified in the Error.message field.

INVALID_SELECTION_DATE

invalidSelectionDate

An invalid date value was specified in a Sheet.selectMarksAsync() call for a date field.

INVALID_SELECTION_ FIELDNAME

invalidSelectionFieldName

A field was specified in a Sheet.selectMarksAsync() call that does not exist in the data source.

INVALID_SELECTION_VALUE

invalidSelectionValue

An invalid value was specified in a Sheet.selectMarksAsync() call.

INVALID_SIZE

invalidSize

A negative size was specified or the maxSize value is less than minSize in Sheet.changeSizeAsync().

INVALID_SIZE_BEHAVIOR_ ON_WORKSHEET

invalidSizeBehaviorOnWorksheet

A behavior other than SheetSizeBehavior.AUTOMATIC was specified in Sheet.changeSizeAsync() when the sheet is a Worksheet instance.

INVALID_URL

invalidUrl

The URL specified in the Viz class constructor is not valid.

MISSING_MAX_SIZE

missingMaxSize

The maxSize field is missing in Sheet.changeSizeAsync() when specifying SheetSizeBehavior.ATMOST.

MISSING_MIN_SIZE

missingMinSize

The minSize field is missing in Sheet.changeSizeAsync() when specifying SheetSizeBehavior.ATLEAST.

MISSING_MINMAX_SIZE

missingMinMaxSize

Either or both of the minSize or maxSize fields is missing in Sheet.changeSizeAsync() when specifying SheetSizeBehavior.RANGE.

MISSING_RANGEN_FOR_ RELATIVE_DATE_FILTERS

missingRangeNForRelativeDateFilters

The rangeN field is missing for a relative date filter of type LASTN or NEXTN.

NO_URL_FOR_HIDDEN_ WORKSHEET

noUrlForHiddenWorksheet

An attempt was made to access Sheet.getUrl() on a hidden sheet. Hidden sheets do not have URLs.

NO_URL_OR_PARENT_ ELEMENT_NOT_FOUND

noUrlOrParentElementNotFound

One or both of the parentElement or the URL parameters is not specified in the Viz constructor.

NOT_ACTIVE_SHEET

notActiveSheet

An operation was attempted on a sheet that is not active or embedded within the active dashboard.

NULL_OR_EMPTY_ PARAMETER

nullOrEmptyParameter

A required parameter was not specified, null, or an empty string/array.

SERVER_ERROR

serverError

A general-purpose server error occurred. Details are contained in the Error object.

SHEET_NOT_IN_WORKBOOK

sheetNotInWorkbook

An operation was attempted on a sheet that does not exist in the workbook.

STALE_DATA_REFERENCE

staleDataReference

An operation is performed on a CustomView object that is no longer valid (it has been removed).

UNSUPPORTED_EVENT_ NAME

unsupportedEventName

An unknown event name was specified in the call to Viz.addEventListener or Viz.removeEventListener.

VIZ_ALREADY_IN_MANAGER

vizAlreadyInManager

A Viz object has already been created as a child of the parentElement specified in the Viz constructor.
## Viz Classes ### VizManager Class Manages all of the `Viz` instances on the page. This is a static class, meaning that all properties and methods are static and there is only a single instance of the class. This class can manage views that have been created using Tableau 8.0 or later. It cannot manage views created using earlier versions of Tableau. #### Properties

Name

Type

Description

getVizs()

Viz[]

Collection of views on the hosting page.
### Viz Class Wraps an `iframe` element showing one or more sheets in a Tableau workbook. Contains all of the chrome surrounding the view. #### Constructor

Signature

Description

Viz(parentElement: domNode, url: string, options: VizCreateOptions)

Creates a new Tableau Viz inside of the given HTML container, which is typically a <div> element. Each option as well as the options parameter is optional. If there is already a Viz associated with the parentElement, an exception is thrown. Before reusing the parentElement you must first call dispose().
#### Properties

Name

Type

Description

getAreTabsHidden()

bool

Indicates whether the tabs are displayed in the UI. It does not actually hide individual tabs.

getIsToolbarHidden()

bool

Indicates whether the toolbar is displayed.

getIsHidden()

bool

Indicates whether the visualization is displayed on the hosting page.

getParentElement()

domNode

Returns the node that was specified in the constructor.

getUrl()

string

The URL of the visualization, as specified in the constructor

getWorkbook()

Workbook

One Workbook is supported per visualization.

getAreAutomaticUpdatesPaused()

bool

Indicates whether automatic updates are currently paused.
#### Events Events are added or removed via the following two calls.

Name

Return Type

Description

addEventListener(
type: TableauEventName,
listener: Function)

None

Adds an event listener to the specified event.

removeEventListener(
type: TableauEventName,
listener: Function)

None

Removes an event listener from the specified event.
#### Methods

Name

Type

Description

show()
hide()

None

Shows or hides the iframe element hosting the visualization.

dispose()

None

Cleans up any resources associated with the visualization, removes the visualization from the VizManager instance, and removes any DOM elements from the parentElement object. In effect, this method restores the page to what it was before a Viz object was instantiated.
Note Before you call this method, make sure you are done referencing any objects.

pauseAutomaticUpdatesAsync()
resumeAutomaticUpdatesAsync()
toggleAutomaticUpdatesAsync()

None

Pauses or resumes layout updates. This is useful if you are resizing the visualization or performing multiple calls that could affect the layout.

revertAllAsync()

None

Equivalent to clicking on the Revert All toolbar button, which restores the workbook to its starting state.

refreshDataAsync ()

None

Equivalent to clicking on the Refresh Data toolbar button.
showDownloadDialog() None Equivalent to clicking on Download from the toolbar, which shows the Download dialog box allowing the user to select the type of download.

showDownloadWorkbookDialog()

None

Equivalent to clicking on Download > Tableau Workbook from the toolbar, which downloads a copy of the original workbook.

showExportImageDialog()

None

Equivalent to clicking on Download > Image from the toolbar, which creates a PNG file of the current visualization.

showExportPDFDialog()

None

Equivalent to clicking on Download > PDF from the toolbar, which shows a dialog allowing the user to select options for downloading a PDF file.
showExportPowerPointDialog() None

Equivalent to clicking on Download > PowerPoint from the toolbar, which shows a dialog allowing the user to choose the sheets from the workbook or dashboard to download in a PowerPoint file.
showExportDataDialog( worksheetInDashboard: Sheet or SheetInfo or string) None Shows the Export Data dialog, which is currently a popup window. The worksheetInDashboard parameter is optional. If not specified, the currently active Worksheet is used. If there is no currently active Worksheet, the method throws an exception.
showExportCrossTabDialog( worksheetInDashboard: Sheet or SheetInfo or string) None Shows the Export CrossTab dialog. You can choose to download the crosstab data as a CSV file or to cancel the operation. The worksheetInDashboard parameter is optional. If not specified, the currently active Worksheet is used. If there is no currently active Worksheet, the method throws an exception.
exportCrossTabToExcel( worksheetInDashboard: Sheet or SheetInfo or string) None Downloads the crosstab data as an Excel file to the default location specified by the browser. The worksheetInDashboard parameter is optional. If not specified, the currently active Worksheet is used. If there is no currently active Worksheet, the method throws an exception.

showShareDialog()

None

Equivalent to clicking on the Share toolbar button, which displays a dialog allowing the user to share the visualization by email or by embedding its HTML in a web page.

setFrameSize(width: int, height: int)

None

Sets the size of the iframe element, which causes the visualization to expand or collapse to fit the iframe element if the visualization size (current sheet's size) is set to AUTOMATIC.

getCurrentUrlAsync()

String

Gets the URL of the visualization asynchronously.

redoAsync()

None

Redoes last action on a sheet, defaults to a single redo unless optional parameters is specified.

undoAsync()

None

Undoes action on sheet, defaults to a single undo unless optional parameters is specified.
### VizCreateOptions Record Defines options that are specified in the `Viz` constructor. #### Fields

Name

Type

Description

disableUrlActionsPopups

bool

 Indicates whether to suppress the execution of URL actions. This option does not prevent the URL action event from being raised. You can use this option to change what happens when a URL action occurs. If set to trueand you create an event listener for the URL_ACTION event, you can use an event listener handler to customize the actions. For example, you can direct the URL to appear in an iframeon your web page. See URL Action Example.

hideTabs

bool

 Indicates whether tabs are hidden or shown.

hideToolbar

bool

Indicates whether the toolbar is hidden or shown.

The toolbar is always shown if the view is hosted on Tableau Public.

instanceIdToClone string

Specifies the ID of an existing instance to make a copy (clone) of. This is useful if the user wants to continue analysis of an existing visualization without losing the state of the original. If the ID does not refer to an existing visualization, the cloned version is derived from the original visualization.

height

string

Can be any valid CSS size specifier. If not specified, defaults to the published height of the view.

width

string

Can be any valid CSS size specifier. If not specified, defaults to the published width of the view.

device

string

Specifies a device layout for a dashboard, if it exists. Values can be default, desktop, tablet, or phone. If not specified, defaults to loading a layout based on the smallest dimension of the hosting iframe element.
"filter name" string Apply a filter that you specify to the view when it is first rendered. For example, if you have an Academic Year filter and only want to display data for 2022, you might enter "Academic Year": "2022". For more information, see Filtering.

onFirstInteractive

callback(e: TableauEvent)

Callback function that is invoked when the Viz object first becomes interactive. This is only called once, but it’s guaranteed to be called. If the Viz object is already interactive, it will be called immediately, but on a separate "thread."

If a listener has been attached to the CUSTOM_VIEW_LOAD event, that event is raised after the callback function specified for onFirstInteractive has been called.

 Custom views are not guaranteed to be loaded when the viz becomes interactive. Use the getCustomViewsAsync method to make sure that all the views are loaded before you call the showCustomViewAsync method.

onFirstVizSizeKnown

callback(e: VizResizeEvent)

Callback function that's invoked when the size of the Viz object is known. You can use this callback to perform tasks such as resizing the elements surrounding the Viz object once the object's size has been established.

toolbarPosition

ApiToolbarPosition

Specifies the position of the toolbar, if it is shown. The values can be ApiToolbarPosition.Top or ApiToolbarPosition.Bottom.
#### InitViz Example The following example shows how the Viz object can be created in a initialization function. The initialization function can be called in your HTML page on page load. The Viz constructor takes three parameters: the div container on the hosting HTML page, the URL of the visualization on Tableau Server (includes Tableau Cloud and Tableau Public), and a set of options (see `VizCreateOptions`). For information about creating the Viz object, see [Initialize the API](https://help.tableau.com/current/api/js_api/en-us/JavaScriptAPI/js_api_concepts_initializing.htm). ``` ``` ### ApiToolbarPosition Enum #### Enumeration

Name

Description

TOP

Positions the toolbar along the top of the visualization.

BOTTOM

Positions the toolbar along the bottom of the visualization.
### ToolbarState Class Wraps the toolbar state. Using this class allows you to determine whether or not a toolbar button is enabled. See [Toolbar State Example](#Toolbar). #### Properties

Name

Type

Description

getViz()

Viz

Gets the Viz object associated with the toolbar.

isButtonEnabled(toolbarButtonName)

bool

Gets a value indicating whether the specified toolbar button is enabled. The supported buttons are defined in the ToobarButtonName enum. Currently, only Undo and Redo are supported. Checking this property with a toolbar button that is not supported causes an InvalidToolbarButtonName error.

### ToolbarButtonName Enum #### Enumeration

Name

Description

UNDO

Specifies the Undo button in the toolbar.

REDO

Specifies the Redo button in the toolbar.
## Viz Event Classes ### TableauEventName Enum Defines strings passed to the `Viz.addEventListener` and `Viz.removeEventListener` methods. The values of the enums are all lowercase strings with no underscores. For example, `CUSTOM_VIEW_LOAD` is `customviewload`. Either the fully-qualified enum (`tableau.TableauEventName.FILTER_CHANGE`) or the raw string (`filterchange`) is acceptable.

Name

Event Class Passed in the Callback

Description

CUSTOM_MARK_CONTEXT_MENU

CustomMarkContextMenu

Raised when a custom mark context menu item is selected.

CUSTOM_VIEW_LOAD

CustomViewEvent

Raised when a custom view has finished loading. This event is raised after the callback function for onFirstInteractive (if any) has been called.

CUSTOM_VIEW_REMOVE

CustomViewEvent

Raised when the user removes a custom view.

CUSTOM_VIEW_SAVE

CustomViewEvent

Raised when the user saves a new or existing custom view.

CUSTOM_VIEW_SET_DEFAULT

CustomViewEvent

Raised when a custom view has been made the default view for this visualization.

FILTER_CHANGE

FilterEvent

Raised when any filter has changed state. The Viz object may not be interactive yet.

MARKS_SELECTION

MarksEvent

Raised when marks are selected or deselected.

PARAMETER_VALUE_CHANGE

ParameterEvent

Raised when any parameter has changed state.
STORY_POINT_SWITCH StoryPointSwitchEvent Raised after a story point becomes active.

TAB_SWITCH

TabSwitchEvent

Raised after the tab switched, but the Viz object may not yet be interactive.

TOOLBAR_STATE_CHANGE

ToolbarStateEvent Raised when the state of the specified toolbar button changes. See Toolbar State Example.
URL_ACTION UrlActionEvent

Raised when a URL action occurs. See the UrlActionEvent class and the URL Action Example.

VIZ_RESIZE

VizResizeEvent

Raised every time the frame size is calculated from the available size and the Viz object's published size.

### TableauEvent Class #### Properties

Name

Type

Description

getViz()

Viz

Gets the Viz object associated with the event.

getEventName()

TableauEventName

Gets the name of the event, which is a string, but is also one of the items in the TableauEventName enum.
### CustomMarkContextMenu Class #### Properties

Name

Type

Description

getContextMenuId()

string

Gets the contextMenuId used to identify the menu item associated with the event.
### CustomViewEvent Class #### Properties

Name

Type

Description

getViz()

Viz

Gets the Viz object associated with the event.

getEventName()

TableauEventName

Gets the name of the event, which is a string, but is also one of the items in the TableauEventName enum.
#### Methods

Name

Return Type

Description

getCustomViewAsync()

Promise<CustomView>

Gets the CustomView object associated with the event.
### FilterEvent Class #### Properties

Name

Type

Description

getViz()

Viz

Gets the Viz object associated with the event.

getWorksheet()

Worksheet

Gets the Worksheet object associated with the event.

getEventName()

TableauEventName

Gets the name of the event, which is a string, but is also one of the items in the TableauEventName enum.

getFieldName()

string

Gets the name of the field.
#### Methods

Name

Return Type

Description

getFilterAsync()

Promise<Filter>

Gets the Filter object associated with the event.
### MarksEvent Class #### Properties

Name

Type

Description

getViz()

Viz

Gets the Viz object associated with the event.

getWorksheet()

Worksheet

Gets the Worksheet object associated with the event.

getEventName()

TableauEventName

Gets the name of the event, which is a string, but is also one of the items in the TableauEventName enum.
#### Methods

Name

Return Type

Description

getMarksAsync()

Promise<Mark[]>

Gets the selected marks on the Worksheet that triggered the event.
### ParameterEvent Class #### Properties

Name

Type

Description

getViz()

Viz

Gets the Viz object associated with the event.

getEventName()

TableauEventName

Gets the name of the event, which is a string, but is also one of the items in the TableauEventName enum.

getParameterName()

string

Gets the name of the parameter that changed.
#### Methods

Name

Return Type

Description

getParameterAsync()

Promise<Parameter>

Gets the Parameter object that triggered the event.
### StoryPointSwitchEvent Class Returned in the callback for the STORY\_POINT\_SWITCH event. #### Properties

Name

Type

Description

getViz() Viz Gets the Viz object associated with the event.
getEventName() TableauEventName Gets the name of the event, which is a string, but is also one of the items in the TableauEventName enum. In this case, it is STORY_POINT_SWITCH.
getOldStoryPointInfo() StoryPointInfo Gets the StoryPointInfo that was active before the story point switch event occurred. The returned object reflects the state of the story point before the switch occurred. The returned object reflects the state of the story point after the switch occurred.
getNewStoryPoint() StoryPoint Gets the StoryPoint that is currently active.
### TabSwitchEvent Class #### Properties

Name

Type

Description

getViz()

Viz

Gets the Viz object associated with the event.

getEventName()

TableauEventName

Gets the name of the event, which is a string, but is also one of the items in the TableauEventName enum.

getOldSheetName()

string

Gets the name of the sheet that was active before the tab switch event occurred.

getNewSheetName()

string

Gets the name of the sheet that is currently active.
### ToolbarStateEvent Class An event class that can signal when a toolbar button or control becomes available or becomes unavailable. #### Properties

Name

Type

Description

getToolbarState()

ToolbarState

Returns the new ToolbarState.
#### Toolbar State Example The following example shows how a toolbar state change can be used to enable custom undo and redo buttons. Note that the toolbar is always shown if the view is hosted on Tableau Public. ``` Undo and Redo

``` ### UrlActionEvent Class An event class that can signal when a URL action occurs. #### Properties

Name

Type

Description

getURL()

String

Returns the URL object associated with event.
getTarget() String Returns the target attribute associated with URL (for example, the identifier associated with a browser tab).
#### URL Action Example The following code snippet shows how you might add an event handler for a URL action to the `initViz()` method. You can be use the event handler to add custom functions to your web page, such as using the event to open the URL in a special `iframe` in your web page. To add the new functionality, you need to suppress the default URL action by setting `disableUrlActionsPopups` to `true`. Note that this is not a complete example of all the JavaScript and HTML code you need. You also need a workbook that has a URL action and Tableau Server running 2020.1 or later. ``` function initViz() { var containerDiv = document.getElementById("vizContainer"), url = "https://path-to-viz-with-url-action", options = { disableUrlActionsPopups: true, hideTabs: true, onFirstInteractive: function () { viz.addEventListener(tableau.TableauEventName.URL_ACTION, urlActionEventHandler); console.log("Run this code when the viz has finished loading."); }, }; viz = new tableau.Viz(containerDiv, url, options); // Create a viz object and embed it in the container div. function urlActionEventHandler(event) { // Provide an event handler for the URL action to add a new feature to the dashboard. console.log("URL: ", event.getUrl()); console.log("Target: ", event.getTarget()); } } ``` ### VizResizeEvent Class #### Properties

Name

Type

Description

getViz()

Viz

Gets the Viz object associated with the event.

getEventName()

TableauEventName

Gets the name of the event, which is a string, but is also one of the items in the TableauEventName enum.

GetAvailableSize()

Size

Gets the sheetSize record for the current sheet. For more information, see SheetSize Record.
## Workbook Classes ### Class Diagram ![](/tableau/current/en-us/api/js_api/en-us/Img/jsapi_workbookclass.png) ### Workbook Class A Workbook has a collection of Sheets represented as tabs. It also has associated objects like `DataSources` and `CustomViews`. #### Properties

Name

Type

Description

getViz()

Viz

Gets the Viz object that contains the workbook.

getActiveSheet()

Sheet

Gets the currently active sheet (the active tab)

getActiveCustomView()

CustomView

Gets the currently active custom view, or null if no custom view is active.

getPublishedSheetsInfo()

SheetInfo[]

Note that this is synchronous, meaning that all of the sheets are expected when loaded.

getName()

string

Gets the name of the workbook saved to the server. Note that this is not necessarily the file name.
#### Methods

Name

Return Type

Description

activateSheetAsync(sheetNameOrIndex: object) Promise<Sheet> Activates the sheet, either by name or index, and returns a promise of the sheet that was activated.

revertAllAsync()

Promise

Reverts the workbook to its last saved state.

getParametersAsync()

Promise<Parameter[]>

Fetches the parameters for this workbook.

changeParameterValueAsync(
name: string,
value: object)

Promise<Parameter>

Changes the value of the parameter with the given name and returns the new Parameter. The value should be the same data type as the parameter and within the allowable range of values. It also needs to be the aliased value and not the raw value. For more information and examples, see changeParameterValueAsync() Additional Information

getCustomViewsAsync()

Promise<CustomView[]>

 Gets the collection of CustomView objects associated with the workbook.

showCustomViewAsync(
customViewName: string)

Promise<CustomView>

Changes the visualization to show the named saved state.

workbook.showCustomViewAsync("Awesome" ).then(function() { // do something });

To reset a custom view to the original view, pass in a null value for the customViewName parameter.

workbook.showCustomViewAsync().then(function() { // do something });

removeCustomViewAsync(
customViewName: string)

Promise<CustomView>

Removes the named custom view.

rememberCustomViewAsync(
customViewName: string)

Promise<CustomView> Remembers the current state of the workbook by assigning a custom view name.

setActiveCustomViewAsDefaultAsync()

None

Sets the active custom view as the default.
#### changeParameterValueAsync() Additional Information The value parameter needs to meet the following conditions: 1. The data type should be the same underlying JavaScript type as is returned in `Parameter.getCurrentValue()`. For example, if `Parameter.getDataType()` is `FLOAT` or `INTEGER`, the value parameter should be a native JavaScript Number. The following table maps the ParameterDataType values to native JavaScript types.
ParameterDataTypeNative JavaScript Type
FLOATNumber
INTEGERNumber
STRINGString
BOOLEANBoolean
DATEDate
DATETIMEDate
When the parameter is a `FLOAT`, if the browser locale uses a decimal separator other than a decimal point (`.`), you should pass a string with the correct locale separator. For example, if the locale uses the comma as a separator, use `"3,5"` instead of the number, `3.5`, as in `viz.getWorkbook().changeParameterValueAsync("FLOAT_PARAM", "3,5")` . 7. If the parameter is restricted to a list of allowable values, the value should be one of those values. Querying `Parameter.getAllowableValuesType()` will indicate if the parameter values are restricted by returning `tableau.ParameterAllowableValuesType.LIST`. 8. If the parameter is restricted to a range of values, the value should be within the minimum and maximum values, inclusive. Querying `Parameter.getAllowableValuesType()` will indicate if the parameter values are restricted by returning `tableau.ParameterAllowableValuesType.RANGE`. The minimum and maximum values are returned via `Parameter.getMinValue()` and `Parameter.getMaxValue()`. 9. The value needs to be the aliased value, and not the raw value. To view the raw and aliased values, go to the Edit Parameter dialog box inTableau Desktop. In that dialog, use the values in the **Display As** column and not the **Value** column, as shown below. ![](/tableau/current/en-us/api/js_api/en-us/Img/jsapi_changeParameterValueAsync.png) #### Examples The following examples will help illustrate these concepts.

// Change a parameter called "Product Type" to "Coffee" when the parameter is

// restricted to the following allowable values:

// "Coffee", "Espresso", "Tea"

workbook.changeParameterValueAsync("Product Type", "Coffee");

// Change a parameter called "Measure" to a value that is aliased, "Sale". This

// example corresponds to the screen shot above.

workbook.changeParameterValueAsync("Measure", "Sale");

// Change a date parameter named "DateParam" to January 1, 2014 (UTC):

workbook.changeParameterValueAsync("DateParam", new Date(Date.UTC(2014, 0, 1)));

### DataSource Class The `Workbook` contains one or more data sources. Each `Worksheet` will have a primary data source and can have multiple secondary data sources. #### Properties

Name

Type

Description

getName()

string

The name of the DataSource as seen in the UI.

getIsPrimary()

bool

Indicates whether this DataSource is a primary or a secondary data source.

getFields()

Field[]

Gets an array of Fields associated with the DataSource.
### Field Class A field contains information about what data source it belongs to, its role, and the type of aggregation it is. #### Properties

Name

Type

Description

getName()

string

Gets the field name (i.e. caption).

getAggregation()

FieldAggregationType

Gets the type of aggregation, which is one of the following values: SUM, AVG, MIN, MAX, STDEV, STDEVP, VAR, VARP, COUNT, COUNTD, MEDIAN, ATTR, NONE, PERCENTILE, TRUNC_YEAR, TRUNC_QTR, TRUNC_MONTH, TRUNC_WEEK, TRUNC_DAY, TRUNC_HOUR, TRUNC_MINUTE, TRUNC_SECOND, QUART1, QUART3, SKEWNESS, KURTOSIS, INOUT, SUM_XSQR, USER

getDataSource()

DataSource

Gets the data source to which this field belongs.

getRole()

FieldRoleType

One of the following values: DIMENSION, MEASURE, UKNOWN
### CustomView Class Represents a named snapshot of the workbook at a specific moment. #### Properties

Name

Type

Description

getName()
setName()

string

User-friendly name for the custom view

getAdvertised()
setAdvertised()

bool

Indicates whether the custom view is public or private.

getDefault()

bool

Gets or sets whether this is the default custom view.

getOwnerName()

string

Gets the user that created the custom view.

getUrl()

string

Unique URL to load this view again.

getWorkbook()

Workbook

 Gets the Workbook to which this CustomView belongs.
#### Methods

Name

Return Type

Description

saveAsync()

Promise<CustomView>

After saveAsync() is called, the result of the getUrl method is no longer blank.
## Sheet Classes ### Class Diagram ![](/tableau/current/en-us/api/js_api/en-us/Img/jsapi_sheetclass.png) ### SheetInfo Class Contains information about a `WORKSHEET`, a `DASHBOARD`, or a `STORY` and no methods. Returned as part of `Workbook.getPublishedSheetsInfo()`. #### Constructor There is no public constructor. You can only get instances of this class from `Workbook.getPublishedSheetsInfo()`. #### Properties

Name

Type

Description

getName()

string

Gets the name of the sheet.

getIndex()

int

Gets the index of the sheet within the published tabs. Note that hidden tabs are still counted in the ordering, as long as they are published.

getIsActive()

bool

Gets a value indicating whether the sheet is the currently active sheet.Due to a technical limitation, this will always return false if the object is a Worksheet instance that is part of a Dashboard.

getIsHidden()

bool

Gets a value indicating whether the sheet is hidden in the UI. Note that if the entire tab control is hidden, it does not affect the state of this flag. This sheet may still report that it is visible even when the tabs control is hidden.

getSheetType()

SheetType

Gets the type of the sheet. SheetType is an enum with the following values: WORKSHEET, DASHBOARD and STORY.

getSize()

SheetSize

Gets the size information that the author specified when publishing the workbook.

getUrl()

string

Gets the URL for this sheet.

getWorkbook()

Workbook

Gets the Workbook to which this Sheet belongs.
### Sheet Class #### Constructor There is no public constructor. You can only get instances of this class from `Workbook.getActiveSheet()`or `Dashboard.getObjects()`. #### Properties

Name

Type

Description

getName()

string

Gets the name of the sheet.

getIndex()

int

Gets the index of the sheet within the published tabs. Note that hidden tabs are still counted in the ordering, as long as they are published.

getIsActive()

bool

Gets a value indicating whether the sheet is the currently active sheet.

getIsHidden()

bool

Gets a value indicating whether the sheet is hidden in the UI. Note that if the entire tab control is hidden, it does not affect the state of this flag. This sheet may still report that it is visible even when the tabs control is hidden.

getSheetType()

SheetType

Gets the type of the sheet. SheetType is an enum with the following values: WORKSHEET , DASHBOARD and STORY.

getSize()

SheetSize

Gets the size information that the author specified when publishing the workbook.

getUrl()

string

Gets the URL for this sheet.

getWorkbook()

Workbook

Gets the Workbook to which this Sheet belongs.
#### Methods

Name

Return Type

Description

changeSizeAsync(SheetSize)

Promise<SheetSize>

Sets the size information on a sheet. Note that if the sheet is a Worksheet, only SheetSizeBehavior.AUTOMATIC is allowed since you can’t actually set a Worksheet to a fixed size.
#### SheetSize Record Describes the way a Sheet should be sized. #### Fields

Name

Type

Description

behavior

SheetSizeBehavior

Contains an enumeration value of one of the following: AUTOMATIC, EXACTLY, RANGE, ATLEAST, and ATMOST.

maxSize

Size

This is only defined when behavior is RANGE or ATMOST.

minSize

Size

This is only defined when behavior is EXACTLY, RANGE, or ATLEAST.
### DataTable Class When you call the `getSummaryDataAsync`, `getUnderlyingDataAsync`, or `getUnderlyingTableDataAsync` methods on a worksheet, Tableau Server returns a `DataTable` object. #### Methods

Name

Return Type

Description

getName()

string

Either "Underlying Data Table" or "Summary Data Table".
getData() array A two-dimensional array of data without the sheet or column metadata. The first array index is the row index and the second array index is the column index.
getColumns() array<Column> The column information, including the name, data type, and index.
getTotalRowCount() int The number of rows in the returned data.
getIsSummaryData() bool Whether the data is summary data or underlying data. Returns true for summary data.
### LogicalTable Class Represents a logical table in the worksheet. In Tableau 2020.2 and later, a data source can have multiple logical tables, and a logical table can contain one or more physical tables. When you call the `getUnderlyingTablesAsync` method on a worksheet, Tableau Server returns an array of `LogicalTable` objects corresponding to the measures referenced by the worksheet. To get the underlying data from the table, you use the id returned by `getTableId()`when you call the `getUnderlyingTableDataAsync()` method. For an example of how these methods are used, see the [Get Underlying Table Data Example](#gettabledata). #### Properties

Name

Return Type

Description

getTableId()

string

The identifier that uniquely identifies the logical table. You use the table identifier to get data when you call the getUnderlyingTableDataAsync() method.
getCaption() string The name of the logical table as it appears to users in Tableau 2020.2 and later.
#### Get Underlying Table Data Example To get data from worksheets in Tableau 2020.2 and later, you need to use the `getUnderlyingTablesAsync()` and `getUnderlyingTableDataAsync()` methods. The following example is based on the [Get Data](https://help.tableau.com/current/api/js_api/en-us/JavaScriptAPI/js_api_samples_get_data.htm) sample. In this example, a call is made to `getUnderlyingTablesAsync()`to get the tables in the data source used by the worksheet. In this case, the workbook contains a data source that was created prior to Tableau 2020.2, so it does not use multiple logical tables. The data source of the worksheet only contains one table, and we use that table id (`tables[0].getTableId()`) to access the underlying data in the call to `getUnderlyingTableDataAsync()`. These two methods replace the `getUnderlyingDataAysnc()` method to get the data in Tableau 2020.2 and later. These methods are available in the `tableau-2.5.0.min.js` library starting with Tableau 2020.2. ``` getData() Basic Table Example -

getData() Basic Example

Click the "Get Data" button to get underlying data for the viz.

``` ### Column Class When you call the `getColumns` method on a `DataTable` object, Tableau Server returns an array of `Column` objects. For a particular object in the array, you can call the following methods: #### Methods

Name

Return Type

Description

getFieldName()

string

The name of the column.
getDataType() string The data type of the column. Possible values are float, integer, string, boolean, date, and datetime.
getIsReferenced() bool Whether the column data is referenced in the visualization.
getIndex() int The number of rows in the returned data.
### Worksheet Class Represents a worksheet tab in the workbook or a dashboard object. These are two separate concepts: a worksheet and a worksheet instance. However, for simplicity in the API, they are both combined into the `Worksheet` class. #### Constructor There is no public constructor. You can only get instances of this class from `Workbook.getPublishedSheetsInfo()` or `Dashboard.getObjects()`. #### Properties

Name

Type

Description

getParentDashboard()

Dashboard

Returns the Dashboard object to which this Worksheet belongs (if it’s on a dashboard). Otherwise, it returns null.
getParentStoryPoint() StoryPoint Returns the StoryPoint object to which this Worksheet belongs (if it’s on a story sheet). Otherwise, it returns null. If the Worksheet instance does not come from a call to StoryPoint.getContainedSheet(), it also returns null.
#### Methods

Name

Return Type

Description

getDataSourcesAsync()

Promise<DataSource[]>

Gets the primary and all of the secondary data sources for this worksheet. Note that by convention the primary data source should always be the first element.
getSummaryDataAsync(getSummaryDataOptions) Promise<DataTable> Gets aggregated data for the fields used in the currently active sheet and returns it as an object. You can specify options with an optional parameter. This can only be called on sheets of the WORKSHEET type.
getUnderlyingDataAsync(getUnderlyingDataOptions) Promise<DataTable> Gets data for all fields in the data source used by the currently active sheet and returns it as an object. You can specify options with an optional parameter. This can only be called on sheets of the WORKSHEET type. Available in Tableau 2020.1 and earlier.
getUnderlyingTablesAsync() Promise<LogicalTable[]> Gets the underlying logical tables used by the worksheet. The resulting logical tables are determined by the measures in the worksheet. If a worksheet's data source contains multiple logical tables and the worksheet contains only measures from one logical table, this method will return one logical table. This can only be called on sheets of the WORKSHEET type. Available in Tableau 2020.2 and later. See LogicalTable and the Get Underlying Table Data Example.
getUnderlyingTableDataAsync(tableID, getUnderlyingDataOptions) Promise<DataTable>

Gets data for all fields in the specified logical table used by the currently active sheet and returns it as an object. You can specify options with an optional parameter. This can only be called on sheets of the WORKSHEET type. Available in Tableau 2020.2 and later. See DataTable and the Get Underlying Table Data Example.
AppendContextMenuAsync( targetMenu: ApiMenuType, config: ContextMenuOptions) Promise<string>

Appends a new menu item into the place specified by targetMenu. Currently, the only allowed location is ApiMenuType.Ubertip (the tooltip that appears when marks are selected). Use the config option to specify the name of the menu item (ContextMenuOptions Class). If successful, this method returns the menuItemId of the new menu item.

var config = { displayName: "myMenuItemName" };

menuId = worksheet.appendContextMenuAsync(tableauSoftware.MenuType.UBERTIP, config);

RemoveContextMenuAsync( targetMenu: ApiMenuType, menuItemId: string) Promise<void>

Removes the menu item specified by menuItemId from the designated context menu.

worksheet.removeContextMenuAsync(tableauSoftware.MenuType.UBERTIP, menuId);

ExecuteContextMenuAsync( targetMenu: ApiMenuType, menuItemId: string)

Promise<void> Executes the menu item specified by menuItemId from the designated context menu. You can use this method for testing the context menu item.
Filtering methods are described in [Worksheet Class (Filtering)](#worksheet_class_filtering). Marks selection methods are described in [Worksheet Class (Selecting Marks)](#_Worksheet_Class_\(Selecting). To use the `getSummaryDataAsync`, `getUnderlyingDataAsync`, `getUnderlyingTablesAsync`, or `getUnderlyingTableDataAsync` methods on a worksheet, you must have permission to download data for the worksheet in Tableau Server. Ensure that your Tableau Server user account has the Download Summary Data and Download Full Data permissions for the workbook that contains the worksheet you want to download data for. #### getSummaryDataOptions Record

Name

Value

Description

ignoreAliases bool Do not use aliases specified in the data source in Tableau. Default is false.
ignoreSelection bool Only return data for the currently selected marks. Default is false.
maxRows int

The number of rows of data that you want to return. Enter 0 to return all rows.

#### getUnderlyingDataOptions Record

Name

Value

Description

ignoreAliases bool Do not use aliases specified in the data source in Tableau. Default is false.
ignoreSelection bool Only return data for the currently selected marks. Default is false.
includeAllColumns bool Return all the columns for the data source. Default is false.
maxRows int

The number of rows of data that you want to return. Enter 0 to return all rows.

### Dashboard Class Contains a collection of `DashboardObject` instances and a notion of the active object. #### Constructor There is no constructor. You get an instance of this from `Workbook.getActiveSheet()`. #### Properties

Name

Type

Description

getObjects()

DashboardObject[]

Gets the collection of objects.

getWorksheets()

Worksheet[]

Gets the collection of worksheets contained in the dashboard. Note that this is a helper method and is equivalent to looping through getObjects() and collecting all of the DashboardObject.Worksheet pointers when DashboardObject.getType() === tableau.DashboardObjectType.WORKSHEET.
getParentStoryPoint() StoryPoint Returns the StoryPoint object to which this Dashboard belongs (if it’s on a story sheet). Otherwise, it returns null. If the Dashboard instance does not come from a call to StoryPoint.getContainedSheet(), it also returns null.
### DashboardObject Class Represents one of a series of different areas of the dashboard. #### Constructor There is no constructor. You get an instance of this from `Dashboard.getObjects()`. #### Properties

Name

Type

Description

getObjectType()

DashboardObjectType

Gets what the object represents, which is an enum with the following values: BLANK, WORKSHEET, QUICK_FILTER, PARAMETER_CONTROL, PAGE_FILTER, LEGEND, TITLE, TEXT, IMAGE, WEB_PAGE.

getDashboard()

Dashboard

Gets the Dashboard object that contains this object.

getWorksheet()

Worksheet

If getType() returns WORKSHEET, this contains a pointer to the Worksheet object.

getPosition()

Point

Gets the coordinates relative to the top-left corner of the dashboard of the object.

getSize()

Size

Gets the size of the object.
### Story Class Contains a collection of StoryPoint instances and the ability to switch between them. Derives from the Sheet class. #### Constructor There is no constructor. You get an instance of this from `Workbook.getActiveSheet()`. #### Properties (Derived from Sheet)

Name

Type

Description

getName()

string

Gets the name of the sheet.

getIndex()

int

Gets the index of the sheet within the published tabs. Note that hidden tabs are still counted in the ordering, as long as they are published.

getIsActive()

bool

Gets a value indicating whether the sheet is the currently active sheet.

getIsHidden()

bool

Gets a value indicating whether the sheet is hidden in the UI. Note that if the entire tab control is hidden, it does not affect the state of this flag. This sheet may still report that it is visible even when the tabs control is hidden.

getSheetType()

SheetType

Gets the type of the sheet, which should always be tableau.SheetType.STORY.
getSize() SheetSize Gets the size information that the author specified when publishing the workbook.
getUrl() string Gets the URL for this sheet.
getWorkbook() Workbook Gets the Workbook to which this Sheet belongs.
#### Properties

Name

Type

Description

getStoryPointsInfo()

StoryPointInfo[]

Gets an array (not a collection) of StoryPointInfo objects. Note that this is not a collection, since we don’t have a unique string key for a story point. We only need ordinal access to the story points (by index).
getActiveStoryPoint() StoryPoint Gets the currently active story point.
#### Methods (Derived from Sheet)

Name

Type

Description

changeSizeAsync(size: SheetSize)

Promise<SheetSize>

Sets the size information on a sheet.
#### Methods

Name

Type

Description

activateStoryPointAsync(index: int)

Promise<StoryPoint>

Activates the story point at the specified index and returns a promise of the activated StoryPoint. Throws a tableau.ErrorCode.INDEX_OUT_OF_RANGE error if the index is less than zero or greater than or equal to the number of story points in the array.
activateNextStoryPointAsync() Promise<StoryPoint> Activates the next story point if there is one. If the current story point is the last one, then is stays active.
activatePreviousStoryPointAsync() Promise<StoryPoint> Activates the previous story point if there is one. If the current story point is the first one, then it stays active.
revertStoryPointAsync(index: int) Promise<StoryPoint> Reverts the story point at the specified index and returns a promise of the reverted StoryPoint. Throws a tableau.ErrorCode.INDEX_OUT_OF_RANGE error if the index is less than zero or greater than or equal to the number of story points in the array.
### StoryPointInfo Class Contains information about a `StoryPoint` with no methods. Returned as part of `Story.getStoryPointsInfo()`. #### Properties

Name

Type

Description

getIndex()

int

Gets the zero-based index of this story point within the parent Story sheet.
getCaption() string Gets the content of the textual description for this story point.
getIsActive() Bool Gets a value indicating whether the story point is the currently active point in the story.
getIsUpdated() Bool Gets a value indicating whether the story point is updated, meaning that there are no changes from the last time the story point was “captured”.
getParentStory() Story Gets the Story object that contains the story point.
### StoryPoint Class A `StoryPoint` is a distinct snapshot within a `Story` sheet. #### Properties

Name

Type

Description

getIndex()

int

Gets the zero-based index of this story point within the parent Story sheet.
getCaption() string Gets the content of the textual description for this story point.
getIsActive() Bool Gets a value indicating whether the story point is the currently active point in the story.
getIsUpdated() Bool Gets a value indicating whether the story point is updated, meaning that there are no changes from the last time the story point was “captured”.
getContainedSheet() Sheet Gets the sheet that this story point contains. This will be null if the story point does not have a contained sheet.
getParentStory() Story Gets the Story object that contains this story point.
## Parameter Classes ### Parameter Class Contains information about a workbook parameter. To actually set a parameter’s value, call `workbook.changeParameterValueAsync()`. #### Properties

Name

Type

Description

getName()

string

A unique identifier for the parameter, as specified by the user.

getCurrentValue()

DataValue

The current value of the parameter.

getDataType()

ParameterDataType

The data type of the parameter can be one of the following: FLOAT, INTEGER, STRING, BOOLEAN, DATE, DATETIME.

getAllowableValuesType()

ParameterAllowableValuesType

The type of allowable values that the parameter can accept. It can be one of the following enumeration items: ALL, LIST, RANGE.

getAllowableValues()

DataValue[]

If the parameter is restricted to a list of allowable values, this property contains the array of those values. Note that this is not a standard collection, but a JavaScript array.

getMinValue()

DataValue

If getAllowableValuesType is RANGE, this defines the minimum allowable value, inclusive. Otherwise it’s undefined/null.

getMaxValue()

DataValue

If getAllowableValuesType is RANGE, this defines the maximum allowable value, inclusive. Otherwise it’s undefined/null.

getStepSize()

Number

If getAllowableValuesType is RANGE, this defines the step size used in the parameter UI control slider. Otherwise it’s undefined/null.

getDateStepPeriod()

PeriodType

If getAllowableValuesType is RANGE and getDataType is DATE or DATETIME, this defines the step date period used in the Parameter UI control slider. Otherwise it’s undefined/null.
## Filtering There is a difference between querying existing filter state and setting new or existing filters. Querying filters is done via `Worksheet.getFiltersAsync()`, which returns a collection of `Filter` classes used in the worksheet, or by using `Dashboard.getFiltersAsync()`, which returns a collection of `Filter` classes used in the dashboard. Setting filters is done via `Worksheet.applyFilterAsync` (and its variants) and `Dashboard.applyFilterAsync`. These are function calls that don't require you to instantiate a `Filter` class. When you specify fields in a filter, you should use the caption as shown in the UI, not the database field name. For example, use **Container** (the caption) instead of **Product Container** (the actual field name). The exception is hierarchical filters, which use the full hierarchical name (for example, `[Product].[All Product].[Espresso]`). Captions can use the optional `[]` delimiters around names. ### Class Diagram ![](/tableau/current/en-us/api/js_api/en-us/Img/jsapi_filterclass.png) ### Dashboard Class (Filtering) This methods are on the `Dashboard` class, but are listed here for convenience. #### Methods

Name

Return Type

Description

getFiltersAsync()

Promise<Filter[]>

Fetches the collection of filters used on the dashboard.

applyFilterAsync(
fieldName: string,
values: object[] or object,
updateType: FilterUpdateType,
options?: FilterOptions)

Promise<string>

Applies a simple categorical filter (non-date) to the dashboard. This method is similar to the method used for worksheets, but applies the filter to all the worksheets in the dashboard that have that same field. Note that the filter is ignored by a worksheet if the worksheet doesn't have the relevant field in its data source. The method eturns the fieldName that was filtered.
See the filtering examples for more details on these functions.

For example:

dashboard.applyFilterAsync("Region", "Central", tableau.FilterUpdateType.REPLACE)

### Worksheet Class (Filtering) These methods are on the `Worksheet` class, but are listed here for convenience. #### Methods

Name

Return Type

Description

getFiltersAsync()

Promise<Filter[]>

Fetches the collection of filters used on the sheet.

applyFilterAsync(
fieldName: string,
values: object[] or object,
updateType: FilterUpdateType,
options?: FilterOptions)

Promise<string>

Applies a simple categorical filter (non-date). See the filtering examples for more details on these functions. Returns the fieldName that was filtered.

For example:

worksheet.applyFilterAsync("Product Type", "Coffee", tableau.FilterUpdateType.REPLACE)

applyRangeFilterAsync(
fieldName: string,
range: RangeFilterOptions)

Promise<string>

Applies a quantitative filter to a field or to a date. If a range is specified that is outside of the domain min/max values, no error is raised and the command is allowed. Subsequent calls to getFiltersAsync[] will return these values even if they are outside of the bounds of the domain. This is equivalent to the behavior in Tableau when you use the Filter dialog box for dimensions and measures.

You can also specify NullOption values as part of the RangeFilterOptions Record to include or exclude null values.

applyRelativeDateFilterAsync(
fieldName: string,
options: RelativeDateFilterOptions) 		Promise<string> Applies a relative date filter.
applyHierarchicalFilterAsync(
fieldName: string,
values: object,
options: HierarchicalFilterOptions) 		Promise<string> Applies a hierarchical filter. The values parameter is either a single value, an array of values, or an object { levels: ["1", "2"] }.
clearFilterAsync(fieldName: string) Promise<string> Clears the filter, no matter what kind of filter it is. Note that the filter is removed as long as no associated quick filter is showing for the field. If there is a quick filter showing, then the filter is kept, but it’s reset to the “All” state (effectually canceling the filter). For relative date filters, however, an error is returned since there is no “All” state for a relative date filter. To clear a relative date filter with a quick filter showing, you can call applyRelativeDateFilter() instead using a range that makes sense for the specific field.
### FilterOptions Record Passed into the `applyFilter` methods to control advanced filtering options. #### Fields

Name

Type

Description

isExcludeMode

bool

Determines whether the filter will apply in exclude mode or include mode. The default is include, which means that you use the fields as part of a filter. Exclude mode means that you include everything else except the specified fields.
### RangeFilterOptions Record Passed into the `applyRangeFilterAsync` method to control advanced filtering options. These options reflect the options for dimensions and measures as shown in the Filter dialog box in Tableau. #### Fields

Name

Type

Description

min

int or date

Minimum value for the range (inclusive). Optional. Leave blank if you want a <= filter.

max

int or date

Maximum value for the range (inclusive). Optional. Leave blank if you want a >= filter.

nullOption

NullOption

Specifies whether to include null values. The options are as follows.

To only include null values: tableauSoftware.NullOption.NULL_VALUES

To only include non-null values:  tableauSoftware.NullOption.NON_NULL_VALUES

To include all values, null and non-null:
tableauSoftware.NullOption.ALL_VALUES
**Examples:** ``` worksheet.applyRangeFilterAsync("SUM(Sales)", {min: 2000, max: 4000}); ``` ``` worksheet.applyRangeFilterAsync("Date", {min: new Date(Date.UTC(2010, 3, 1)), max: new Date(Date.UTC(2010, 12, 31))}); ``` ``` worksheet.applyRangeFilterAsync("AVG(Verbosity)", { min: "5.0", max: "10", nullOption: tableauSoftware.NullOption.ALL_VALUES }); ``` ``` worksheet.applyRangeFilterAsync("AVG(Verbosity)", {nullOption: tableauSoftware.NullOption.NON_NULL_VALUES }); ``` ### RelativeDateFilterOptions Record Passed into the `applyRelativeDateFilterAsync` method to control advanced filtering options. #### Fields

Name

Type

Description

anchorDate

Date

The UTC date from which to filter.

periodType

PeriodType

Year, quarter, month, etc.

rangeType

DateRangeType

LAST, LASTN, NEXT, etc.

rangeN

int

The number used when the rangeType is LASTN or NEXTN.
### Filter Class An abstract base class for all of the filter types. #### Properties

Name

Type

Description

getWorksheet()

Worksheet

Gets the parent worksheet

getFilterType()

FilterType

Gets the type of the filter. See FilterType Enum for the values in the enum.

getFieldName()

string

Gets the name of the field being filtered. Note that this is the caption as shown in the UI and not the actual database field name.
#### Methods

Name

Return Type

Description

getAppliedWorksheetsAsync()

Promise<string[]>

Gets the list of worksheets that have the filter applied.

getFieldAsync()

Promise<Field>

Gets the field that is currently being filtered.
setAppliedWorksheetsAsync(applyToWorksheets: string[] ) Promise<string[]> Applies the filter to the specified list of worksheets. If the worksheet(s) do not exist or do not contain the field in their data sources, an exception is thrown.
### NullOption Enum An enumeration that indicates what to do with null values for a given filter or mark selection call. #### **Enumeration**

Name

Description

NULL_VALUES

Only include null values in the filter.

NON_NULL_VALUES

Only include non-null values in the filter.

ALL_VALUES

Include null and non-null values in the filter.
### CategoricalFilter Class #### Properties

Name

Type

Description

getIsExcludeMode()

bool

Gets a value indicating whether the filter is exclude or include (default).

getAppliedValues()

DataValue[]

Gets the collection of values that are currently set on the filter. This is a native JavaScript array and not a keyed collection. If more than 5000 values are selected, only the first 200 are returned.

getIsAllSelected()

bool Gets a value indicating whether all values for the filter are selected. Returns true if all values in the filter are selected.
### QuantitativeFilter Class #### Properties

Name

Type

Description

getDomainMin()

DataValue

Gets the minimum value as specified in the domain.

getDomainMax()

DataValue

Gets the maximum value as specified in the domain.

getMin()

DataValue

Gets the minimum value, inclusive, applied to the filter.

getMax()

DataValue

Gets the maximum value, inclusive, applied to the filter.

getIncludeNullValues()

bool

Indicates whether null values are included in the filter.
### RelativeDateFilter Class #### Properties

Name

Type

Description

getPeriod()

PeriodType

The date period of the filter. See PeriodType Enum for the values in the enum.

getRange()

DateRangeType

The range of the date filter (years, months, etc.). See DateRangeType Enum for the values in the enum.

getRangeN()

int

When getRange returns LASTN or NEXTN, this is the N value (how many years, months, etc.).
### DataValue Record A DataValue contains both the raw and formatted value for a filter or parameter. Date values are always expressed in UTC dates. #### Fields

Name

Type

Description

value object Contains the raw native value as a JavaScript type, which is one of String, Number, Boolean, or Date

formattedValue

string

The value formatted according to the locale and the formatting applied to the field or parameter.
### FilterType Enum An enumeration of the valid types of filters that can be applied. #### **Enumeration**

Name

Description

CATEGORICAL

Categorical filters are used to filter to a set of values within the domain.

QUANTITATIVE

Quantitative filters are used to filter to a range of values from a continuous domain.

HIERARCHICAL

Hierarchical filters are used to filter to a set of values organized into a hierarchy within the domain.

RELATIVE_DATE

Relative date filters are used to filter a date/time domain to a range of values relative to a fixed point in time.
### FilterUpdateType Enum An enumeration of the valid types of filtering that can be done. #### **Enumeration**

Name

Description

ALL

Adds all values to the filter. Equivalent to checking the (All) value in a quick filter.

REPLACE

Replaces the current filter values with new ones specified in the call.

ADD

Adds the filter values as specified in the call to the current filter values. Equivalent to checking a value in a quick filter.

REMOVE

Removes the filter values as specified in the call from the current filter values. Equivalent to unchecking a value in a quick filter.
### PeriodType Enum An enumeration of a date period used in filters and in parameters. #### **Enumeration**

Name

YEARS

QUARTERS

MONTHS

WEEKS

DAYS

HOURS

MINUTES

SECONDS

### DateRangeType Enum An enumeration of the valid date ranges for a relative date filter. #### **Enumeration**

Name

Description

LAST

Refers to the last day, week, month, etc. of the date period.

LASTN

Refers to the last N days, weeks, months, etc. of the date period.

NEXT

Refers to the next day, week, month, etc. of the date period.

NEXTN

Refers to the next N days, weeks, months, etc. of the date period.

CURRENT

Refers to the current day, week, month, etc. of the date period.

TODATE

Refers to everything up to and including the current day, week, month, etc. of the date period.
## Marks Selection Selecting marks is almost identical to filtering. For filtering, you use one of the `Worksheet.applyFilterAsync()` methods. For selecting marks, you use `Worksheet.selectMarksAsync()`. The parameters for marks selection are almost identical to those used for filtering.This provides a very simple, easy to learn, and consistent way to accomplish the two most common use cases for the API: filtering and selection. ### Worksheet Class (Selecting Marks) These methods are on the `Worksheet class`, but are shown here for convenience. #### Methods

Name

Return Type

Description

clearSelectedMarksAsync()

void

Clears the selection for this worksheet.

getSelectedMarksAsync()

Promise<Mark[]>

Gets the collection of marks that are currently selected.

selectMarksAsync(
fieldName: string,
value: object or object[],
updateType: SelectionUpdateType)

void

Selects the marks and returns them.

For example, a single field (dimension) and value:


worksheet.selectMarksAsync("Product", "Mint", tableau.SelectionUpdateType.REPLACE);


Or single field and multiple values:


worksheet.selectMarksAsync("Product", ["Chamomile", "Mint"], tableau.SelectionUpdateType.REPLACE);

Or select marks based upon range:


sheet.selectMarksAsync( {"College": [ "Business", "Engineering" ], "Total Score": { min:1600, max:2300 } }, tableau.SelectionUpdateType.REPLACE );

selectMarksAsync(
fieldValuesMap: object,
updateType: SelectionUpdateType)

void

Allows selection based on this syntax for the first parameter:
{
"Field1": value,
"Field2": [1, 2, 3]
}

For example, selecting by product and state.


worksheet.selectMarks({"Product": ["Caffe Latte", "Caffe Mocha"],"State": ["California","Florida"]},tableauSoftware.FilterUpdateType.ADD);

For more examples of how you can use this method, see Selecting Marks and the Select Marks sample.

selectMarksAsync(
marks: Mark[],
updateType: SelectionUpdateType)

void

Selects an array of marks. See the Mark Class and the following example.

**Example of selectMarksAsync using the Mark class:** ``` (function (marks) { // filter out only the Washington and Oregon marks var onlyWashingtonAndOregon = []; for (var i = 0, len = marks.length; i < len; i++) { var m = marks[i]; var pair = m.getPairs().get("State"); if (pair && (pair.value === "Washington" || pair.value === "Oregon")) { onlyWashingtonAndOregon.push(m); } } return worksheet.selectMarksAsync( onlyWashingtonAndOregon, tableau.SelectionUpdateType.REPLACE); }) ``` ### Mark Class A mark represents a single data point on the visualization. It is independent of the type of visualization (bar, line, pie, etc.). #### Constructor

Signature

Description

Mark(pairs: Pair[])

Creates a new Mark with the specified pairs.
#### Properties

Name

Type

Description

getPairs()

Pair[]

Gets a collection of field name/value pairs associated with the mark.
### Pair Class A pair contains a field name and a value (both the raw and formatted values). #### Constructor

Signature

Description

Pair(fieldName: string, value: object)

Creates a new Pair with the specified field name/value pairing
#### Fields

Name

Type

Description

fieldName string The field name to which the value is applied.
value object Contains the raw native value for the field as a JavaScript type, which is one of String, Number, Boolean, or Date.

formattedValue

string

The value formatted according to the locale and the formatting applied to the field.
### SelectionUpdateType Enum An enumeration of the valid types of marks selection that can be done. #### **Enumeration**

Name

Description

REPLACE

Replaces the current marks values with new ones specified in the call.

ADD

Adds the values as specified in the call to the current selection. Equivalent to control-clicking in desktop.

REMOVE

Removes the values as specified in the call from the current selection. Equivalent to control-clicking an already selected mark in desktop.
## Other Classes ### Size Record Represents a width and height in pixels. This is implemented as a plain JavaScript object (it’s not a class). #### Fields

Name

Type

Description

width

int

Expressed in pixel units.

height

int

Expressed in pixel units.
### Point Record Represents an x/y coordinate in pixels. This is implemented as a plain JavaScript object (it’s not a class). #### Fields

Name

Type

Description

x

int

Expressed in pixel units.

y

int

Expressed in pixel units.
### ContextMenuOptions Class Represents the options for the menu item that appears in the custom context menu. You can use the context menu to run commands outside of Tableau. Fields

Name

Type

Description

displayName

string

The name of the custom menu item as you want it to appear in Tableau.
### ApiMenuType Enum Represents the location of a context menu where users can add external menu items. Fields

Name

Type

Description

Ubertip

string

The custom menu item will appear in the marks selection tooltip (also known as an "ubertip").

- ApiMenuType # Enumeration ApiMenuType Represents the location of a context menu where users can add external menu items. - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/Enums.ts:494 ##### Index ### Enumeration Members [Ubertip](#ubertip) ## Enumeration Members ### Ubertip[](#ubertip) Ubertip: "ubertip" External menu item will be injected in ubertip dialog - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/Enums.ts:496 ### Settings Member Visibility - Protected - Inherited - External ThemeOSLightDark ### On This Page Enumeration Members [Ubertip](#ubertip) - [@tableau/taco-toolkit](https://help.tableau.com/current/api/webdataconnector/en-us/reference/index.html) - [app](https://help.tableau.com/current/api/webdataconnector/en-us/reference/modules/app.html) # Module app ##### Index ### References [default](https://help.tableau.com/current/api/webdataconnector/en-us/reference/modules/app.html#default) ### Enumerations [AggType](https://help.tableau.com/current/api/webdataconnector/en-us/reference/enums/app.AggType.html) [ColumnRole](https://help.tableau.com/current/api/webdataconnector/en-us/reference/enums/app.ColumnRole.html) [ColumnType](https://help.tableau.com/current/api/webdataconnector/en-us/reference/enums/app.ColumnType.html) [DataType](https://help.tableau.com/current/api/webdataconnector/en-us/reference/enums/app.DataType.html) [GeographicRole](https://help.tableau.com/current/api/webdataconnector/en-us/reference/enums/app.GeographicRole.html) [NumberFormat](https://help.tableau.com/current/api/webdataconnector/en-us/reference/enums/app.NumberFormat.html) [UnitsFormat](https://help.tableau.com/current/api/webdataconnector/en-us/reference/enums/app.UnitsFormat.html) ### Classes [Connector](https://help.tableau.com/current/api/webdataconnector/en-us/reference/classes/app.Connector.html) [Logger](https://help.tableau.com/current/api/webdataconnector/en-us/reference/classes/app.Logger.html) [OAuthCredentials](https://help.tableau.com/current/api/webdataconnector/en-us/reference/classes/app.OAuthCredentials.html) ### Interfaces [AjaxResponse](https://help.tableau.com/current/api/webdataconnector/en-us/reference/interfaces/app.AjaxResponse.html) [ConnectorRequestOptions](https://help.tableau.com/current/api/webdataconnector/en-us/reference/interfaces/app.ConnectorRequestOptions.html) ### Type Aliases [AuthHeader](https://help.tableau.com/current/api/webdataconnector/en-us/reference/types/app.AuthHeader.html) [AuthTokens](https://help.tableau.com/current/api/webdataconnector/en-us/reference/types/app.AuthTokens.html) [HandlerInput](https://help.tableau.com/current/api/webdataconnector/en-us/reference/types/app.HandlerInput.html) [SecretsType](https://help.tableau.com/current/api/webdataconnector/en-us/reference/types/app.SecretsType.html) ### Functions [getAuthHeader](https://help.tableau.com/current/api/webdataconnector/en-us/reference/functions/app.getAuthHeader.html) [getBasicAuthHeader](https://help.tableau.com/current/api/webdataconnector/en-us/reference/functions/app.getBasicAuthHeader.html) [getOAuthHeader](https://help.tableau.com/current/api/webdataconnector/en-us/reference/functions/app.getOAuthHeader.html) ## References ### default[](#default) Renames and re-exports [Connector](https://help.tableau.com/current/api/webdataconnector/en-us/reference/classes/app.Connector.html) ### Settings #### Member Visibility - Inherited #### Theme OSLightDark ### On This Page - [default](#default) Generated using [TypeDoc](https://typedoc.org/) # Architecture 🕐 _2 min read_ The Migration SDK is designed as a local application that primarily downloads content from Tableau Server to a local machine and then publishes it to Tableau Server. The Migration SDK exclusively uses the [Tableau REST API](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api.htm) to migrate content. graph LR A <--> B C <--> B B <--> D subgraph Tableau Server A\[APIs\] end subgraph User Application B\[Migration SDK\] end subgraph Tableau Cloud C\[APIs\] end D\[(Temporary storage)\] ## API Throttling Tableau Cloud has published [Site Capacity limits](https://help.tableau.com/current/online/en-us/to_site_capacity.htm) to ensure all customers have a consistent performance experience. This includes limits on how many API calls a user can make on a specific Tableau Cloud Site within an hour. The Migration SDK is limited by Tableau’s throttling limits for REST API operations. Tableau Cloud limits REST API usage to 40,000 calls per user per site per hour. Additionally, select REST API calls have lower limits detailed in [Tableau Cloud Site Capacity](https://help.tableau.com/current/online/en-us/to_site_capacity.htm). If a throttling limit is hit, API operations will be paused until the next hour. Because of this, you might notice delays in the migration progress. This is normal and expected. ## Security The Migration SDK relies on HTTPS to secure data in transit. Tableau Cloud API connections require HTTPS, and we recommend configuring HTTPS to connect to Tableau Server when available. The Migration SDK encrypts downloaded files by default to secure data at rest. The Migration SDK requires a personal access tokens (PAT) to authenticate the user running the migration with Tableau APIs. These tokens must be created on both Tableau Server and Tableau Cloud. For more information, see [Personal Access Tokens](https://help.tableau.com/current/online/en-us/security_personal_access_tokens.htm) in the Tableau Help Documentation. The Migration SDK does not persist PATs. We recommend that you securely store your tokens. [Skip to main content](#main-content) # Ask Data Lens Methods - Retired * * * ## Retired in API 3.22 (Cloud February 2024 / Server 2024.2) > > [!WARNING] > > > > **Important changes for Ask Data and Metrics** > > Tableau's Ask Data and Metrics features were retired in Tableau Cloud in February 2024 and in Tableau Server version 2024.2. With advances in natural language technologies, we're developing an improved interface that will make it easier to ask questions of your data and stay on top of changes. For more information, see [How Tableau GPT and Tableau Pulse are reimagining the data experience](https://www.tableau.com/blog/tableau-pulse-and-tableau-gpt). * * * * * * Ask data lenses enable you to refine the way a user's natural language query is interpreted, based on the specific audience they belong to. For instance, you might make one lens for medical staff at a hospital, and another for administrative staff. A lens allows you to define synonyms to associate key words with common terms used for them. For instance, "SF" for "San Francisco", or "Rx" for "prescription". You can also configure recommended visualizations for each lens. > Introduced: Tableau Cloud June 2022. Not currently available for Tableau Server. > > Using the Tableau REST API, you can: > > - Create a lens and configure its properties > - Delete a lens > - Import an existing lens > - Get a list of lenses on a site or the details of a specified lens ## Use Postman Our Postman collection of requests enables you to construct, send, and examine HTTP requests to the Tableau Server or Tableau Cloud API without writing initial code. Postman is a free online app used by many developers for prototyping API calls, investigating issues, and generating request code in a variety of languages. Postman: [Ask Data Lens Methods - Retired](https://www.postman.com/salesforce-developers/workspace/salesforce-developers/folder/12721794-42ceab2a-996a-4466-a9b7-aa8e5239d560) ## Create ask data lens - Retired in API 3.22 * * * Retired in API 3.22 (Cloud February 2024 / Server 2024.2) > > [!WARNING] > > > > **Important changes for Ask Data and Metrics** > > Tableau's Ask Data and Metrics features were retired in Tableau Cloud in February 2024 and in Tableau Server version 2024.2. With advances in natural language technologies, we're developing an improved interface that will make it easier to ask questions of your data and stay on top of changes. For more information, see [How Tableau GPT and Tableau Pulse are reimagining the data experience](https://www.tableau.com/blog/tableau-pulse-and-tableau-gpt). * * * Create an ask data lens. **Version:** Available in API 3.16 ( Tableau Cloud June 2022 / Server 2022.3) and later. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** This method can be called by users who have Create permissions for lenses on the site. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** \`tableau:lenses:create\` [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) POST {server}/api/-/askdata/lenses [view details](#) ## Delete ask data lens - Retired in API 3.22 * * * Retired in API 3.22 (Cloud February 2024 / Server 2024.2) > > [!WARNING] > > > > **Important changes for Ask Data and Metrics** > > Tableau's Ask Data and Metrics features were retired in Tableau Cloud in February 2024 and in Tableau Server version 2024.2. With advances in natural language technologies, we're developing an improved interface that will make it easier to ask questions of your data and stay on top of changes. For more information, see [How Tableau GPT and Tableau Pulse are reimagining the data experience](https://www.tableau.com/blog/tableau-pulse-and-tableau-gpt). * * * Delete an ask data lens. **Version:** Available in API 3.16 ( Tableau Cloud June 2022 / Server 2022.3) and later. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** This method can be called by users with administrator and lens owner permissions. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** \`tableau:lenses:delete\` [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) DELETE {server}/api/-/askdata/lenses/{lens\_id} [view details](#) ## Get ask data lens - Retired in API 3.22 * * * Retired in API 3.22 (Cloud February 2024 / Server 2024.2) > > [!WARNING] > > > > **Important changes for Ask Data and Metrics** > > Tableau's Ask Data and Metrics features were retired in Tableau Cloud in February 2024 and in Tableau Server version 2024.2. With advances in natural language technologies, we're developing an improved interface that will make it easier to ask questions of your data and stay on top of changes. For more information, see [How Tableau GPT and Tableau Pulse are reimagining the data experience](https://www.tableau.com/blog/tableau-pulse-and-tableau-gpt). * * * Get the details of the specified ask data lens. **Version:** Available in API 3.16 ( Tableau Cloud June 2022 / Server 2022.3) and later. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** This method can be called by users who have Read access to the lens. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** \`tableau:lenses:read\` [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) GET {server}/api/-/askdata/lenses/{lens\_id} [view details](#) ## Import ask data lens - Retired in API 3.22 * * * Retired in API 3.22 (Cloud February 2024 / Server 2024.2) > > [!WARNING] > > > > **Important changes for Ask Data and Metrics** > > Tableau's Ask Data and Metrics features were retired in Tableau Cloud in February 2024 and in Tableau Server version 2024.2. With advances in natural language technologies, we're developing an improved interface that will make it easier to ask questions of your data and stay on top of changes. For more information, see [How Tableau GPT and Tableau Pulse are reimagining the data experience](https://www.tableau.com/blog/tableau-pulse-and-tableau-gpt). * * * Import an existing ask data lens on a server to a site, and optionally transform the metadata of the lens in the process. **Version:** Available in API 3.16 ( Tableau Cloud June 2022 / Server 2022.3) and later. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** This method can only be called by server administrators or site administrators. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** \`tableau:lenses:create\` [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) POST {server}/api/-/askdata/lenses/import [view details](#) ## List ask data lenses in site - Retired in API 3.22 * * * Retired in API 3.22 (Cloud February 2024 / Server 2024.2) > > [!WARNING] > > > > **Important changes for Ask Data and Metrics** > > Tableau's Ask Data and Metrics features were retired in Tableau Cloud in February 2024 and in Tableau Server version 2024.2. With advances in natural language technologies, we're developing an improved interface that will make it easier to ask questions of your data and stay on top of changes. For more information, see [How Tableau GPT and Tableau Pulse are reimagining the data experience](https://www.tableau.com/blog/tableau-pulse-and-tableau-gpt). * * * Returns a list of ask data lenses in a site. **Version:** Available in API 3.16 ( Tableau Cloud June 2022 / Server 2022.3) and later. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** This method can be called by any user. Responses will include only the lenses to the user has access to. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** \`tableau:lenses:read\` [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) GET {server}/api/-/askdata/lenses [view details](#) - AskData # Interface AskData The interface for the top level AskData object. #### Deprecated[](#deprecated) interface AskData {     [debug](#debug)?: boolean;     [height](#height)?: string | number;     [iframeAttributeClass](#iframeattributeclass)?: string;     [iframeAttributeLoading](#iframeattributeloading)?: string;     [iframeAttributeStyle](#iframeattributestyle)?: string;     [iframeAuth](#iframeauth)?: boolean;     [origin](#origin)?: string;     [showEmbed](#showembed)?: boolean;     [showPin](#showpin)?: boolean;     [showSave](#showsave)?: boolean;     [showShare](#showshare)?: boolean;     [src](#src)?: null | string;     [token](#token)?: string;     [width](#width)?: string | number; } #### Hierarchy ([View Summary](https://help.tableau.com/current/api/embedding_api/en-us/reference/hierarchy.html#AskData)) - [AskDataSettings](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/AskDataSettings.html) - AskData - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/AskDataInterfaces.ts:65 ##### Index ### Properties [debug?](#debug) [height?](#height) [iframeAttributeClass?](#iframeattributeclass) [iframeAttributeLoading?](#iframeattributeloading) [iframeAttributeStyle?](#iframeattributestyle) [iframeAuth?](#iframeauth) [origin?](#origin) [showEmbed?](#showembed) [showPin?](#showpin) [showSave?](#showsave) [showShare?](#showshare) [src?](#src) [token?](#token) [width?](#width) ## Properties ### `Optional`debug[](#debug) debug?: boolean Indicates whether the non-minified version of JavaScript is loaded. If specified (or set to true), the non-minified version is used for both the local component and the Tableau Server visualization (if enabled). If not specified (or set to false), the minified version of the JavaScript files are loaded. ``` ``` Inherited from [AskDataSettings](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/AskDataSettings.html).[debug](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/AskDataSettings.html#debug) - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/WebComponentInterfaces.ts:50 ### `Optional`height[](#height) height?: string | number Represents height in pixels Can be any valid CSS size specifier. If not specified, defaults to the published height of the view. Inherited from [AskDataSettings](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/AskDataSettings.html).[height](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/AskDataSettings.html#height) - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/WebComponentInterfaces.ts:20 ### `Optional`iframeAttributeClass[](#iframeattributeclass) iframeAttributeClass?: string The value of the 'class' attribute of the embedded iframe providing access to any custom selectors defined in the `` child tag. ``` .red-border { border: 1px solid red; } ``` Inherited from [AskDataSettings](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/AskDataSettings.html).[iframeAttributeClass](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/AskDataSettings.html#iframeattributeclass) - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/WebComponentInterfaces.ts:101 ### `Optional`iframeAttributeLoading[](#iframeattributeloading) iframeAttributeLoading?: string The value of the 'loading' attribute of the embedded iframe. See: [https://developer.mozilla.org/en-US/docs/Web/HTML/Element/iframe#loading](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/iframe#loading) ``` ``` Inherited from [AskDataSettings](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/AskDataSettings.html).[iframeAttributeLoading](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/AskDataSettings.html#iframeattributeloading) - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/WebComponentInterfaces.ts:74 ### `Optional`iframeAttributeStyle[](#iframeattributestyle) iframeAttributeStyle?: string The value of the 'style' attribute of the embedded iframe. ``` ``` Inherited from [AskDataSettings](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/AskDataSettings.html).[iframeAttributeStyle](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/AskDataSettings.html#iframeattributestyle) - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/WebComponentInterfaces.ts:85 ### `Optional`iframeAuth[](#iframeauth) iframeAuth?: boolean Indicates whether to use the old auth mechanism for authentication which happens inside the iframe. If specified, VizLoadErrorEvents triggered due to auth failures will not be thrown. ``` ``` Inherited from [AskDataSettings](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/AskDataSettings.html).[iframeAuth](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/AskDataSettings.html#iframeauth) - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/WebComponentInterfaces.ts:62 ### `Optional`origin[](#origin) origin?: string Used for telemetry ``` ``` Inherited from [AskDataSettings](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/AskDataSettings.html).[origin](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/AskDataSettings.html#origin) - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/AskDataInterfaces.ts:58 ### `Optional`showEmbed[](#showembed) showEmbed?: boolean Indicates whether the embed button is hidden or visible. ``` ``` Inherited from [AskDataSettings](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/AskDataSettings.html).[showEmbed](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/AskDataSettings.html#showembed) - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/AskDataInterfaces.ts:26 ### `Optional`showPin[](#showpin) showPin?: boolean Indicates whether the pin button is hidden or visible. ``` ``` Inherited from [AskDataSettings](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/AskDataSettings.html).[showPin](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/AskDataSettings.html#showpin) - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/AskDataInterfaces.ts:34 ### `Optional`showSave[](#showsave) showSave?: boolean Indicates whether the save button is hidden or visible. ``` ``` Inherited from [AskDataSettings](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/AskDataSettings.html).[showSave](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/AskDataSettings.html#showsave) - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/AskDataInterfaces.ts:42 ### `Optional`showShare[](#showshare) showShare?: boolean Indicates whether the share button is hidden or visible. ``` ``` Inherited from [AskDataSettings](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/AskDataSettings.html).[showShare](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/AskDataSettings.html#showshare) - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/AskDataInterfaces.ts:50 ### `Optional`src[](#src) src?: null | string The viz src Inherited from [AskDataSettings](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/AskDataSettings.html).[src](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/AskDataSettings.html#src) - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/WebComponentInterfaces.ts:8 ### `Optional`token[](#token) token?: string The token used for authorization ``` ``` Inherited from [AskDataSettings](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/AskDataSettings.html).[token](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/AskDataSettings.html#token) - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/WebComponentInterfaces.ts:37 ### `Optional`width[](#width) width?: string | number Represents width in pixels Can be any valid CSS size specifier. If not specified, defaults to the published width of the view. Inherited from [AskDataSettings](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/AskDataSettings.html).[width](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/AskDataSettings.html#width) - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/WebComponentInterfaces.ts:14 ### Settings Member Visibility - Protected - Inherited - External ThemeOSLightDark ### On This Page Properties [debug](#debug)[height](#height)[iframeAttributeClass](#iframeattributeclass)[iframeAttributeLoading](#iframeattributeloading)[iframeAttributeStyle](#iframeattributestyle)[iframeAuth](#iframeauth)[origin](#origin)[showEmbed](#showembed)[showPin](#showpin)[showSave](#showsave)[showShare](#showshare)[src](#src)[token](#token)[width](#width) _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") - AskDataSettings # Interface AskDataSettings #### Deprecated[](#deprecated) interface AskDataSettings {     [debug](#debug)?: boolean;     [height](#height)?: string | number;     [iframeAttributeClass](#iframeattributeclass)?: string;     [iframeAttributeLoading](#iframeattributeloading)?: string;     [iframeAttributeStyle](#iframeattributestyle)?: string;     [iframeAuth](#iframeauth)?: boolean;     [origin](#origin)?: string;     [showEmbed](#showembed)?: boolean;     [showPin](#showpin)?: boolean;     [showSave](#showsave)?: boolean;     [showShare](#showshare)?: boolean;     [src](#src)?: null | string;     [token](#token)?: string;     [width](#width)?: string | number; } #### Hierarchy ([View Summary](https://help.tableau.com/current/api/embedding_api/en-us/reference/hierarchy.html#AskDataSettings)) - [WebComponentSettingsShared](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/WebComponentSettingsShared.html) - [WebComponentLocalSettings](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/WebComponentLocalSettings.html) - AskDataSettings - [AskData](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/AskData.html) - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/AskDataInterfaces.ts:19 ##### Index ### Properties [debug?](#debug) [height?](#height) [iframeAttributeClass?](#iframeattributeclass) [iframeAttributeLoading?](#iframeattributeloading) [iframeAttributeStyle?](#iframeattributestyle) [iframeAuth?](#iframeauth) [origin?](#origin) [showEmbed?](#showembed) [showPin?](#showpin) [showSave?](#showsave) [showShare?](#showshare) [src?](#src) [token?](#token) [width?](#width) ## Properties ### `Optional`debug[](#debug) debug?: boolean Indicates whether the non-minified version of JavaScript is loaded. If specified (or set to true), the non-minified version is used for both the local component and the Tableau Server visualization (if enabled). If not specified (or set to false), the minified version of the JavaScript files are loaded. ``` ``` Inherited from [WebComponentSettingsShared](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/WebComponentSettingsShared.html).[debug](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/WebComponentSettingsShared.html#debug) - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/WebComponentInterfaces.ts:50 ### `Optional`height[](#height) height?: string | number Represents height in pixels Can be any valid CSS size specifier. If not specified, defaults to the published height of the view. Inherited from [WebComponentLocalSettings](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/WebComponentLocalSettings.html).[height](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/WebComponentLocalSettings.html#height) - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/WebComponentInterfaces.ts:20 ### `Optional`iframeAttributeClass[](#iframeattributeclass) iframeAttributeClass?: string The value of the 'class' attribute of the embedded iframe providing access to any custom selectors defined in the `` child tag. ``` .red-border { border: 1px solid red; } ``` Inherited from [WebComponentSettingsShared](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/WebComponentSettingsShared.html).[iframeAttributeClass](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/WebComponentSettingsShared.html#iframeattributeclass) - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/WebComponentInterfaces.ts:101 ### `Optional`iframeAttributeLoading[](#iframeattributeloading) iframeAttributeLoading?: string The value of the 'loading' attribute of the embedded iframe. See: [https://developer.mozilla.org/en-US/docs/Web/HTML/Element/iframe#loading](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/iframe#loading) ``` ``` Inherited from [WebComponentSettingsShared](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/WebComponentSettingsShared.html).[iframeAttributeLoading](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/WebComponentSettingsShared.html#iframeattributeloading) - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/WebComponentInterfaces.ts:74 ### `Optional`iframeAttributeStyle[](#iframeattributestyle) iframeAttributeStyle?: string The value of the 'style' attribute of the embedded iframe. ``` ``` Inherited from [WebComponentSettingsShared](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/WebComponentSettingsShared.html).[iframeAttributeStyle](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/WebComponentSettingsShared.html#iframeattributestyle) - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/WebComponentInterfaces.ts:85 ### `Optional`iframeAuth[](#iframeauth) iframeAuth?: boolean Indicates whether to use the old auth mechanism for authentication which happens inside the iframe. If specified, VizLoadErrorEvents triggered due to auth failures will not be thrown. ``` ``` Inherited from [WebComponentSettingsShared](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/WebComponentSettingsShared.html).[iframeAuth](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/WebComponentSettingsShared.html#iframeauth) - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/WebComponentInterfaces.ts:62 ### `Optional`origin[](#origin) origin?: string Used for telemetry ``` ``` - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/AskDataInterfaces.ts:58 ### `Optional`showEmbed[](#showembed) showEmbed?: boolean Indicates whether the embed button is hidden or visible. ``` ``` - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/AskDataInterfaces.ts:26 ### `Optional`showPin[](#showpin) showPin?: boolean Indicates whether the pin button is hidden or visible. ``` ``` - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/AskDataInterfaces.ts:34 ### `Optional`showSave[](#showsave) showSave?: boolean Indicates whether the save button is hidden or visible. ``` ``` - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/AskDataInterfaces.ts:42 ### `Optional`showShare[](#showshare) showShare?: boolean Indicates whether the share button is hidden or visible. ``` ``` - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/AskDataInterfaces.ts:50 ### `Optional`src[](#src) src?: null | string The viz src Inherited from [WebComponentLocalSettings](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/WebComponentLocalSettings.html).[src](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/WebComponentLocalSettings.html#src) - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/WebComponentInterfaces.ts:8 ### `Optional`token[](#token) token?: string The token used for authorization ``` ``` Inherited from [WebComponentSettingsShared](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/WebComponentSettingsShared.html).[token](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/WebComponentSettingsShared.html#token) - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/WebComponentInterfaces.ts:37 ### `Optional`width[](#width) width?: string | number Represents width in pixels Can be any valid CSS size specifier. If not specified, defaults to the published width of the view. Inherited from [WebComponentLocalSettings](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/WebComponentLocalSettings.html).[width](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/WebComponentLocalSettings.html#width) - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/WebComponentInterfaces.ts:14 ### Settings Member Visibility - Protected - Inherited - External ThemeOSLightDark ### On This Page Properties [debug](#debug)[height](#height)[iframeAttributeClass](#iframeattributeclass)[iframeAttributeLoading](#iframeattributeloading)[iframeAttributeStyle](#iframeattributestyle)[iframeAuth](#iframeauth)[origin](#origin)[showEmbed](#showembed)[showPin](#showpin)[showSave](#showsave)[showShare](#showshare)[src](#src)[token](#token)[width](#width) - [@tableau/taco-toolkit](https://help.tableau.com/current/api/webdataconnector/en-us/reference/index.html) - [handlers](https://help.tableau.com/current/api/webdataconnector/en-us/reference/modules/handlers.html) - [AsyncParser](https://help.tableau.com/current/api/webdataconnector/en-us/reference/classes/handlers.AsyncParser.html) # Class AsyncParser`Abstract` An abstract class for the implementation of connector custom parsing that asynchronously parses the results yielded from the Fetcher. For TypeScript, the fetcherResult type can be provided via the type parameter. By default, fetcherResult is typed as `any`. #### Example ```ts export default class MyParser extends AsyncParser { async parse(fetcherResult: Uint8Array, options: ParseOptions): Promise { // ... }} ``` #### Type Parameters - #### FetchResult = any #### Hierarchy - BaseParser - AsyncParser ##### Index ### Constructors [constructor](https://help.tableau.com/current/api/webdataconnector/en-us/reference/classes/handlers.AsyncParser.html#constructor) ### Methods [parse](https://help.tableau.com/current/api/webdataconnector/en-us/reference/classes/handlers.AsyncParser.html#parse) [createContainerBuilder](https://help.tableau.com/current/api/webdataconnector/en-us/reference/classes/handlers.AsyncParser.html#createContainerBuilder) ## Constructors ### constructor[](#constructor) - new AsyncParser(): [AsyncParser](https://help.tableau.com/current/api/webdataconnector/en-us/reference/classes/handlers.AsyncParser.html)[](#constructor.new_AsyncParser) - #### Type Parameters - #### FetchResult = any #### Returns [AsyncParser](https://help.tableau.com/current/api/webdataconnector/en-us/reference/classes/handlers.AsyncParser.html) Inherited from BaseParser.constructor ## Methods ### `Abstract` parse[](#parse) - parse(fetcherResult, options): Promise<[DataContainer](https://help.tableau.com/current/api/webdataconnector/en-us/reference/interfaces/handlers.DataContainer.html)\>[](#parse.parse-1) - The method to implement the parsing logic for transforming the fetcherResult into a DataContainer. When a custom parser is defined, the connector must implement this method to perform data parsing. #### Parameters - ##### fetcherResult: FetchResult - ##### options: [ParseOptions](https://help.tableau.com/current/api/webdataconnector/en-us/reference/interfaces/handlers.ParseOptions.html) #### Returns Promise<[DataContainer](https://help.tableau.com/current/api/webdataconnector/en-us/reference/interfaces/handlers.DataContainer.html)\> ### `Static` createContainerBuilder[](#createContainerBuilder) - createContainerBuilder(dataContainer): [DataContainerBuilder](https://help.tableau.com/current/api/webdataconnector/en-us/reference/classes/handlers.DataContainerBuilder.html)[](#createContainerBuilder.createContainerBuilder-1) - A static method to create a DataContainerBuilder instance based on the provided dataContainer object. #### Parameters - ##### dataContainer: [DataContainer](https://help.tableau.com/current/api/webdataconnector/en-us/reference/interfaces/handlers.DataContainer.html) #### Returns [DataContainerBuilder](https://help.tableau.com/current/api/webdataconnector/en-us/reference/classes/handlers.DataContainerBuilder.html) Inherited from BaseParser.createContainerBuilder ### Settings #### Member Visibility - Inherited #### Theme OSLightDark ### On This Page - [constructor](#constructor) - [parse](#parse) - [createContainerBuilder](#createContainerBuilder) Generated using [TypeDoc](https://typedoc.org/) - [@tableau/taco-toolkit](https://help.tableau.com/current/api/webdataconnector/en-us/reference/index.html) - [handlers](https://help.tableau.com/current/api/webdataconnector/en-us/reference/modules/handlers.html) - [Auth](https://help.tableau.com/current/api/webdataconnector/en-us/reference/classes/handlers.Auth.html) # Class Auth`Abstract` #### Deprecated Will be removed in the later release. #### Hierarchy - Auth ##### Index ### Constructors [constructor](https://help.tableau.com/current/api/webdataconnector/en-us/reference/classes/handlers.Auth.html#constructor) ### Methods [authenticate](https://help.tableau.com/current/api/webdataconnector/en-us/reference/classes/handlers.Auth.html#authenticate) [run](https://help.tableau.com/current/api/webdataconnector/en-us/reference/classes/handlers.Auth.html#run) ## Constructors ### constructor[](#constructor) - new Auth(): [Auth](https://help.tableau.com/current/api/webdataconnector/en-us/reference/classes/handlers.Auth.html)[](#constructor.new_Auth) - #### Returns [Auth](https://help.tableau.com/current/api/webdataconnector/en-us/reference/classes/handlers.Auth.html) ## Methods ### `Abstract` authenticate[](#authenticate) - authenticate(options): Promise[](#authenticate.authenticate-1) - #### Parameters - ##### options: [AuthenticateOptions](https://help.tableau.com/current/api/webdataconnector/en-us/reference/interfaces/handlers.AuthenticateOptions.html) #### Returns Promise ### run[](#run) - run(options): Promise[](#run.run-1) - #### Parameters - ##### options: [AuthenticateOptions](https://help.tableau.com/current/api/webdataconnector/en-us/reference/interfaces/handlers.AuthenticateOptions.html) #### Returns Promise ### Settings #### Member Visibility - Inherited #### Theme OSLightDark ### On This Page - [constructor](#constructor) - [authenticate](#authenticate) - [run](#run) Generated using [TypeDoc](https://typedoc.org/) - [@tableau/taco-toolkit](https://help.tableau.com/current/api/webdataconnector/en-us/reference/index.html) - [handlers](https://help.tableau.com/current/api/webdataconnector/en-us/reference/modules/handlers.html) - [AuthenticateOptions](https://help.tableau.com/current/api/webdataconnector/en-us/reference/interfaces/handlers.AuthenticateOptions.html) # Interface AuthenticateOptions #### Hierarchy - AuthenticateOptions ##### Index ### Properties [handlerInput](https://help.tableau.com/current/api/webdataconnector/en-us/reference/interfaces/handlers.AuthenticateOptions.html#handlerInput) [secrets?](https://help.tableau.com/current/api/webdataconnector/en-us/reference/interfaces/handlers.AuthenticateOptions.html#secrets) ## Properties ### handlerInput[](#handlerInput) handlerInput: [HandlerInput](https://help.tableau.com/current/api/webdataconnector/en-us/reference/types/app.HandlerInput.html) ### `Optional` secrets[](#secrets) secrets?: [SecretsType](https://help.tableau.com/current/api/webdataconnector/en-us/reference/types/app.SecretsType.html) ### Settings #### Member Visibility - Inherited #### Theme OSLightDark ### On This Page - [handlerInput](#handlerInput) - [secrets](#secrets) Generated using [TypeDoc](https://typedoc.org/) # Authentication Before you can perform any activities in Tableau Cloud Manager (TCM), you need to authenticate to Tableau Cloud Manager REST API. Authenticating to Tableau Cloud Manager REST API has different requirements than authenticating directly to Tableau Cloud Manager. ### About authenticating to Tableau Cloud Manager REST API To authenticate, or sign in, to Tableau Cloud Manager REST API, you must be a cloud administrator, and use one of the following: - Personal access token (PAT) - Pass a JSON Web Token (JWT) using a unified access token (UAT) After signing in, you acquire a TCM credentials token. A TCM credentials token is required for any subsequent API requests that you make. You can use the [Authentication Methods](/current/api/cloud-manager/en-us/reference/index.html#tag/Authentication-Methods) to sign in to the Tableau Cloud Manager REST API. For more information, see [Sign in to Tableau Cloud Manager REST API](#sign-in-to-tableau-cloud-manager-rest-api) below. #### About unified access tokens (UATs) Beginning in December 2025, you can configure a unified access token (UAT) that enables you to pass a JSON Web Token (JWT) to acquire a TCM credentials token. Among its benefits, UATs enable unified JWT-based authentication across Tableau Cloud Manager REST API and Tableau REST API for tenant and site-level administrative and content tasks. For more information, see [Unified Access Tokens](/current/api/cloud-manager/en-us/docs/unified_access_tokens.html). ### About authenticating to Tableau Cloud Manager To authenticate, or sign in, to the TCM UI, you must be a cloud administrator and one of the following authentication types must be enabled for the tenant: - **Single sign-on (SSO)** using Google, OpenID Connect (OIDC), Salesforce, or Security Assertion Markup Language (SAML) authentication. Setting up SSO with an external identity provider (IdP) requires minimal configuration in TCM. You can use the [Single Sign-on Methods](/current/api/cloud-manager/en-us/reference/index.html#tag/Single-Sign-on-Methods) to do the following: - Enable Google, OIDC, Salesforce, or SAML authentication for TCM users - Enable SAML authentication for Tableau Cloud site users - **Tableau with MFA** authentication. When TCM users sign in to TCM for the first time, they’ll be prompted to set up multi-factor authentication (MFA) with a Tableau username and password. For more information, see [Sign In to Tableau Cloud Manager](https://help.tableau.com/current/online/en-us/cloud_manager_signin.htm) topic in the Tableau Cloud Help. **Notes:** - SSO is not supported for Tableau Cloud Manager REST API authentication. - If SSO is enabled to authenticate users in TCM, we recommend that there’s at least one cloud administrator that uses “Tableau with MFA” authentication to ensure uninterrupted access to TCM. For more information, see [Set up TCM authentication for users](#set-up-tcm-authentication-for-users) below. #### About configuring SAML authentication in Tableau Cloud Manager Beginning in December 2025, the SAML configuration methods in the TCM REST API enable you, the cloud administrator, to programmatically configure both SAML authentication for Tableau Cloud Manager (tenant) and your Tableau Cloud sites. This includes creating, updating, deleting SAML configurations for both the tenant and specific sites. For more information, see [Single Sign-on Methods](/current/api/cloud-manager/en-us/reference/index.html#tag/Single-Sign-on-Methods). **Table of Contents** ## Sign in to Tableau Cloud Manager REST API To sign in to Tableau Cloud Manager REST API, you need to generate a personal access token (PAT) through the TCM UI first. After you create the PAT, you can use it in the **Sign in with personal access token** method request body. **About personal access tokens** PATs are long-lived access tokens. PATs validate that cloud administrators are allowed to sign in to Tableau Cloud Manager REST API. PATs offer the following advantages: - They can be revoked without disabling the user they’re attached to - They can be used concurrently, which make them ideal for use with scripts that run for different functional areas, such as sites, users, and permissions - A user can have multiple PATs For more information about PATs, see the [Personal Access Tokens for Tableau Cloud Manager](https://help.tableau.com/current/online/en-us/cloud_manager_personal_access_tokens.htm) topic in the Tableau Cloud Help. **Notes:** - PATs generated in Tableau Cloud aren’t compatible with TCM. Similarly, PATs generated in TCM aren’t compatible with Tableau Cloud. - To sign in to the Tableau Cloud Manager REST API for the first time, you must generate a PAT using the TCM UI. After that, you can generate new PATs using the [Create personal access token](/current/api/cloud-manager/en-us/reference/index.html#tag/Authentication-Methods/operation/createPersonalAccessToken) method. ### Step 1: Create a personal access token from TCM UI Before you can sign in to the Tableau Cloud Manager REST API for the first time, you must generate a PAT from the TCM UI first. 1. On the [Tableau Cloud Manager sign-in](https://cloudmanager.tableau.com) page, enter your username (email address). **Note:** The username you enter depends on the authentication set up for TCM. 2. Do _one_ of the following depending on what is displayed: - Select the tenant name and click the **Sign In** button. - Enter the tenant name in the **URI** text box and click the **Continue** button. **Note:** If you don’t know the tenant name, see [How to Find Tenant Name](/current/api/cloud-manager/en-us/docs/tenant.html). 3. Follow the prompts to enter your password and complete the sign-in process. **Note:** Your sign-in experience depends on the authentication set up for TCM. 4. Navigate to your account drop-down in the upper-right corner of the page and select **My Account Settings**. 5. In the Personal Access Tokens section, do the following: - 5.1. Click the **Create Token** button. - 5.2. Enter a token name. - 5.3. Optionally, set the token expiration. - 5.4. Click the **Create** button. - 5.5. Click the **Copy Secret** button to use in your Sign In request. Make sure you store the token secret in a safe location. The token secret is only shown once and won’t be accessible after the dialog box is closed. ### Step 2: Make a sign in request with personal access token The following section describes the different components required to sign in to the Tableau Cloud Manager REST API using the [Sign in with personal access token](/current/api/cloud-manager/en-us/reference/index.html#tag/Authentication-Methods/operation/personalAccessTokenLogin) method. **Example URI** To call the Tableau Cloud Manager REST API, first make a request using the **Sign in with personal access token** method to generate a TCM credentials token like in the example below. `POST https://cloudmanager.tableau.com/api/v1/pat/login` **Example request body** The **Sign in with personal access token** request body must contain the PAT secret, `token`, like in the example below. ``` { "token": "JKGpaIjBQaS1vlXIIt9g+A==:-jeD0dkAWu-mwZQPgRf3NvgHQBUZ7atQsPxh911YmPU" } ``` **Example response body** The **Sign in with personal access token** request produces the following response body. The response includes the TCM credentials token, `sessionToken`, like in the example below. ``` { "sessionToken": "+iUzQx+s:E9T43sqund-xDGle-9trR7WPLkqCkT_7zks3_dVsV0By_Jji", "userId": "306982a2-4bb0-b858-b82eeI24b857", "tenantId": "56978815-59b6-4a61-b9e8-ede126e23bab", "sessionExpiration": "2024-0706T84:53:13.688541Z" } ``` **Note:** A `sessionExpiration` value is returned in the sign-in response. This value corresponds to when the PAT expires in UTC time. ### Step 3: Include the `x-tableau-session-token` header in subsequent requests After generating the TCM credentials token, `sessionToken`, add it to the header, `x-tableau-session-token`, for all subsequent Tableau Cloud Manager REST API requests. **Example header** `x-tableau-session-token:+iUzQx+s:E9T43sqund-xDGle-9trR7WPLkqCkT_7zks3_dVsV0By_Jji` The TCM credentials token is short-lived. It expires after 4 hours or when the session is idle for 30 continuous minutes with no requests. When the TCM credentials token expires, you need to sign in to Tableau Cloud Manager REST API again to get a new TCM credentials token. ## Set up TCM authentication for users Using the Tableau Cloud Manager REST API, you can configure authentication to Tableau Cloud Manager (TCM) and assign the authentication type to TCM users. You can set the following types of authentication to enable sign-in for TCM users: - **Single sign-on (SSO):** SSO means that TCM is set up to use the same username and password (credentials) you use for other applications in your company. With SSO, your credentials are managed outside of Tableau by a third-party identity provider (IdP). When you sign in to TCM, it’s the IdP that lets Tableau know you’re an approved user. TCM supports authentication through Google, OIDC, Salesforce, or SAML. - **Tableau with MFA:** When multi-factor authentication (MFA) is enabled with Tableau authentication, you use a combination of your Tableau with MFA credentials and a verification method to access TCM. Tableau credentials are made up of an email address and password that you use for accessing TCM. You can choose a verification method after you register for MFA. For more information, see [Register for multi-factor authentication](https://help.tableau.com/current/online/en-us/cloud_manager_signin.htm#mfa-register-user). **Note:** To use Tableau with MFA authentication, skip Step 1 and go directly to [Step 2: Assign authentication to users](#step-2-assign-authentication-to-users) below. ### Step 1: Configure authentication After you make the sign-in request, you can configure Google, OpenID Connect (OIDC), or Salesforce authentication using the [Create or update OIDC configuration](/current/api/cloud-manager/en-us/reference/index.html#tag/Single-Sign-on-Methods/operation/createOrUpdateOIDCConfiguration) method. Alternatively, you can configure SAML authentication using [Create SAML configuration](/current/api/cloud-manager/en-us/reference/index.html#tag/Single-Sign-on-Methods/operation/createSamlConfiguration) method. The example below sets up Salesforce authentication for the tenant, which has a resource value of `123e4567-e89b-12d3-a456-426614174000` that can be retrieved by using the [Get Tenant](/current/api/cloud-manager/en-us/reference/index.html#tag/Tenant-Methods/operation/areTenantNameAndEncodeUriUnique) method. **Example URI** `PUT https://cloudmanager.tableau.com/api/v1/resources/123e4567-e89b-12d3-a456-426614174000/oidcconfiguration` **Example request body** ``` { "enabled": true, "knownProviderAlias": "Salesforce", "salesforceDomain": "login.salesforce.com" } ``` ### Step 2: Assign authentication to user After the authentication type has been configured for the tenant, assign TCM users to use that authentication. #### To assign single sign-on (SSO) authentication to users Using the [Add tenant user](/current/api/cloud-manager/en-us/reference/index.html#tag/User-Methods/operation/createUserWithMultiRole) method, set the `idp` value to `OpenID`. In this example, Salesforce authentication is assigned to the new TCM user because Salesforce is the authentication type configured for the tenant, which is specified by the `knownProviderAlias` attribute in [Step 1: Configure authentication](#step-1-configure-authentication) above. **Example URI** `POST https://cloudmanager.tableau.com/api/v1/tenants/f97df110-f4de-492e-8849-4a6af68026b0/users` **Example request body** ``` { "linkRoles": [ { "linkID": "ce9cad81-cd67-43fb-b952-2441d7b5a751", "linkRole": "LINK_ADMIN", "idp": "OpenID" } ] } ``` #### To assign Tableau with MFA authentication to users Using the [Add tenant user](/current/api/cloud-manager/en-us/reference/index.html#tag/User-Methods/operation/createUserWithMultiRole) method, set the `idp` value to `TabIDWithMFA`. **Example URI** `POST https://cloudmanager.tableau.com/api/v1/tenants/f97df110-f4de-492e-8849-4a6af68026b0/users` **Example request body** ``` { "linkRoles": [ { "linkID": "ce9cad81-cd67-43fb-b952-2441d7b5a751", "linkRole": "LINK_ADMIN", "idp": "TabIDWithMFA" } ] } ``` # Authentication Lorem ipsum dolor sit amet, consectetur adipiscing elit. Quisque vehicula viverra ex, sit amet vulputate urna. Phasellus volutpat libero ut arcu porta posuere. Praesent mi libero, lacinia nec velit auctor, vestibulum ornare mauris. Pellentesque posuere arcu enim, eu rhoncus lectus vulputate eget. Suspendisse potenti. Sed eu ipsum non augue aliquam imperdiet eu in purus. Aliquam efficitur scelerisque sagittis. In suscipit eros at convallis blandit. Morbi dignissim eleifend diam, eu faucibus est fringilla sit amet. Vestibulum aliquam ultricies velit, non commodo justo varius sit amet. Suspendisse nec nulla eget est ornare pellentesque non eu velit. Maecenas posuere nulla non erat tincidunt, nec dapibus mi condimentum. Duis libero tortor, egestas et ultricies vitae, pretium sed felis. Suspendisse luctus libero laoreet augue mattis, ac pretium urna molestie. Mauris eget erat at erat rutrum dictum. Pellentesque blandit feugiat enim, scelerisque cursus mauris tempor vitae. Phasellus consectetur vel ligula vitae ornare. In feugiat mauris non elementum mollis. Vestibulum ac mattis felis, sed molestie eros. Integer viverra tristique dolor eu egestas. Nunc scelerisque elit ex, nec interdum sem ultrices commodo. Phasellus cursus feugiat egestas. Fusce eget sagittis elit. Cras vel justo elit. Nunc egestas aliquam rhoncus. In vitae lectus non tortor feugiat ullamcorper vel non augue. Pellentesque sit amet nunc a enim commodo pharetra ut et nunc. Curabitur nibh massa, porttitor in orci ultricies, gravida semper sapien. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos. Phasellus pulvinar massa ac mi tempor congue. Duis ultricies, purus nec consequat tempus, leo turpis tempor lorem, ac viverra justo ex id nibh. Nulla accumsan urna eu ornare varius. Duis quam lorem, maximus vel erat non, congue tincidunt ipsum. Duis dapibus in urna vel euismod. Mauris tempus facilisis tortor, eget vestibulum dolor suscipit at. Integer ut ante sed ex molestie feugiat et quis tellus. Aliquam porttitor placerat tempus. Donec a est eget augue convallis volutpat ac vel dolor. Vestibulum et nunc gravida tortor lobortis molestie. Duis consequat tristique quam, id viverra magna dignissim sodales. Sed efficitur magna quis nunc laoreet lobortis. Pellentesque tristique gravida neque, sed finibus mauris pharetra vel. Aliquam sodales ante massa, id pharetra diam finibus eu. Fusce sodales laoreet sapien, quis cursus justo vestibulum non. Aenean vel ullamcorper tellus, eu fermentum metus. Mauris dignissim ut ipsum vel pretium. Sed eget eros mattis, porttitor urna imperdiet, molestie lorem. Vestibulum suscipit ligula ac metus iaculis, at gravida nibh feugiat. Vestibulum sollicitudin eleifend massa vel porttitor. Morbi vel quam arcu. Donec consequat vehicula pharetra. Aliquam convallis mauris ac nisi vulputate convallis. Praesent a neque et ante semper malesuada vitae id ex. Aliquam blandit id nisl a viverra. Phasellus lorem purus, rutrum id nunc eu, volutpat laoreet ligula. Aenean elit lacus, volutpat quis tristique id, eleifend quis nibh. Morbi dignissim erat a magna porttitor faucibus. Curabitur dolor erat, malesuada vitae est vel, sollicitudin sodales ligula. Curabitur sit amet lectus porttitor, vehicula ipsum eu, rutrum urna. Nunc vulputate mi tristique nibh dignissim scelerisque. Donec id purus imperdiet, maximus ligula in, rutrum arcu. Donec metus enim, volutpat ac mattis eu, iaculis sit amet lectus. # Authentication Because the TSM API allows you to perform administrative tasks, it requires authentication over HTTPS. ## User account requirements The account you use to authenticate with TSM must exist on the Tableau Server computer. This user account must use password-based authentication. Additional requirements depend on the operating system used to run Tableau Server: - For Tableau Server on Windows, the user account must also be an administrator on the Tableau Server computer. - For Tableau Server on Linux, the user account must also be a part of the `tsmadmin` group that is authorized to access TSM. This user account is distinct from Tableau Server user accounts, including Tableau Server administrator and site administrator accounts. ### Add a user account to the tsmadmin group (Linux only) When you first run the `initialize-tsm` script to start TSM as part of Tableau Server installation, the user account that you use to run the script is added to the `tsmadmin` group. If you run the script and use the `-u` option to specify a different user account, that user account is used to run the script and then added to the `tsmadmin` group. The `initialize-tsm` script is in the `/opt/tableau/tableau_server/packages/scripts.` directory. To add an existing user account to the `tsmadmin` group after you have already run the `initialize-tsm` script, use the Linux `usermod` command with the `-a` (append) and `-G` (groups) options: `usermod -a -G tsmadmin ` To create a new user account and add it to the `tsmadmin` group, use the following command: `useradd -G tsmadmin ` ## HTTPS requirement All requests and responses must be sent over HTTPS. By default, TSM uses a self-signed SSL certificate. As a result, you might see a warning that the request is not secure depending on the library that you use to send requests.You do not need to do anything to enable SSL for TSM. Just specify `https` in the URI. ## Signing in to TSM Send a POST request to the `login` endpoint to authenticate to TSM: ``` https://your-server:8850/api/1.0/login ``` A login request must include the following: **Content-type header** The header must specify that the content-type is `application/json`. **Authentication body** The body of the request must include an authentication object that includes the user name and password. For example, you might send the following body: ``` { "authentication": { "name": "username", "password": "password" } } ``` A successful login request returns a 204 status code and an authentication cookie. Additional requests that you make to the TSM API must include a valid authentication cookie. ## Signing out of TSM Send a POST request to the `logout` endpoint to invalidate your authentication cookie: ``` https://your-server:8850/api/1.0/logout ``` Alternatively, to invalidate all active authentication cookes for TSM, send a POST request to the `logout/all` endpoint: ``` https://your-server:8850/api/1.0/logout/all ``` A successful logout request returns a 204 status code. ## Sample login and logout requests ``` import json import requests session = requests.Session() login_url = 'https://your-server:8850/api/1.0/login' logout_url = 'https://your-server:8850/api/1.0/logout' headers = { 'content-type': 'application/json' } body = { 'authentication': { 'name': 'username', 'password': 'password' } } # Configure the session to authenticate with the provided credentials. # Do not verify the SSL certificate because this is a self-signed certificate. session = requests.Session() # Sign in login_resp = session.post(login_url, data=json.dumps(body), headers=headers, verify=False) print '{0}: {1}'.format(login_resp.status_code, login_url) # Sign out logout_resp = session.post(logout_url) print '{0}: {1}'.format(logout_resp.status_code, logout_url) ``` # Authentication and Embedding When you embed Tableau content into your web application, you must consider whether users have permission to see that content. This is because when someone accesses the Tableau content in your web application, the same authentication protocols apply as if they were accessing the view on Tableau directly. For example, if you’re writing code to embed a view from Tableau Public, no authentication is required. However, if your code is getting a view from Tableau Cloud or a hosted instance of Tableau Server, authentication is typically required. If the user isn’t already signed in to the server, Tableau redirects the request for a view to the Tableau sign in page, and the user must provide a username and password. After the user has signed in, the browser caches session information, and the user doesn’t have to sign in again unless they have explicitly signed out of Tableau, or until the session token expires. Tableau 2021.4 introduced connected apps for authenticating and authorizing users of embedded content: direct trust and OAuth 2.0 trust. These options use JSON Web Tokens (JWTs) and control permissions and access to projects and control where content can be embedded. Tableau 2025.3 introduced an additional option for authenticating users of embedded content: unified access tokens (UATs). UATs facilitate authentication to embedded content and control access to content by using JSON Web Tokens (JWTs). This topic discusses connected apps and UATs and how you can use them for authentication. For information about the other ways of authentication, see the Tableau Cloud and Tableau Server documentation. For information about the authentication options, see the following: - For Tableau Cloud - [Site Authentication](https://help.tableau.com/current/online/en-us/security_auth.htm) in the Tableau Cloud Help. - For Tableau Server - [Authentication (Windows)](https://help.tableau.com/current/server/en-us/security_auth.htm) or [Authentication (Linux)](https://help.tableau.com/current/server-linux/en-us/security_auth.htm) in the Tableau Server Help. * * * ## Unified access tokens (Tableau Cloud only) Starting in Tableau 2025.3, you can use unified access tokens (UATs), configured through Tableau Cloud Manager (TCM), to enable and authorize access to embedded views using JSON Web Token (JWT). When users visit the embedded content in your web application, the embedded content is scoped to the privileges defined in the JWT. UATs, like connected apps, enable you to control the views and projects that users of your embedded application have access to. For more information about UATs, see [Unified Access Tokens](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html) in the Tableau Cloud Manager REST API Help. ## Tableau connected apps While having users sign in to Tableau generally works, assuming your browser allows 3rd-party cookies, it’s not necessarily the best experience for users of your embedded application. Starting in Tableau 2021.4, when you embed views using the Embedding API v3, you have two options: - Using direct trust, you can configure Tableau to use a connected app for authentication. - Using OAuth 2.0 trust, you can use an external authorization server (EAS) if you’re using an identity provider (IdP) with Tableau Cloud or Tableau Server to authenticate users. Connected apps provide a way to create and manage explicit trust relationships between your Tableau Cloud site or Tableau Server, and custom applications where Tableau content is embedded. You can control the views and projects that users of your embedded application have access to. **Note:** For users to successfully authenticate when they access embedded content, browsers must be configured to allow third-party cookies. ### Configure a connected app Connected apps have a trust relationship with Tableau. You can use Tableau Cloud, Tableau Server, or the Tableau REST API to configure a connected app for your embedded web application. After you set up the connected app, your users are able to authenticate through a JSON Web Token (JWT) generated by your web server by using a shared secret signed by Tableau. When a user visits the embedded content in your web application, the embedded content is scoped to the privileges defined in the JWT. #### Overview for enabling a connected app **Important:** When you embed a Tableau view in your application, your application must conform with your Tableau licensing, which means you must generate a JWT dynamically for each enabled user. Never embed the credentials for one user in your connected app and then use that as authorization for others. For information about usage-based licensing and special licensing for embedded analytics, see [Understanding License Models](https://help.tableau.com/current/online/en-us/license_product_keys.htm). ##### Direct trust There are five parts to enabling a connected app. 1. As a Tableau Cloud site administrator or Tableau Server administrator, sign in to Tableau and create a new connected app. Alternatively, you can use the Tableau REST API’s connected apps methods to create a new connected app. Make note of the client ID, as you’ll need this ID to create the JWT. 2. For security, use the domain allowlist to make sure that Tableau content is only embedded in locations that you allow. See one of the following: - For Tableau Cloud - [Domain allowlist rules (embedding workflows only)](https://help.tableau.com/current/online/en-us/connected_apps_direct.htm#domain-allowlist-rules-embedding-workflows-only) - For Tableau Server - [Domain allowlist rules (embedding workflows only)](https://help.tableau.com/current/server/en-us/connected_apps_direct.htm#domain-allowlist-rules-embedding-workflows-only) 3. Generate the secret for the connected app. Make note of this secret ID and secret value as you’ll need these values when you generate the JWT. 4. Configure the web server that hosts your embedded application to generate the JWT. The JWT is generated dynamically for each user. If you’re not using usage-based licensing, you must provide an appropriate user name in the JWT. For embedding, the JWT must include a registered claim for the scope (`"scp"`). See [Pass the JWT to the Tableau web component](#pass-the-jwt-to-the-tableau-web-component) for more information. There are JWT libraries and packages in various languages that you can use to build the JWT. 5. After you have the JWT, you must pass the JWT to the ``, ``, or `` web component. For more information about configuring a connected app using direct trust, see the following: - For Tableau Cloud - [Configure Connected Apps with Direct Trust](https://help.tableau.com/current/online/en-us/connected_apps_direct.htm) in the Tableau Cloud Help - For Tableau Server - [Configure Connected Apps with Direct Trust](https://help.tableau.com/current/server-linux/en-us/connected_apps_direct.htm) in the Tableau Server Help **Note:** You can use group names in the JWT, but [group sets](https://help.tableau.com/current/online/en-us/group_sets.htm) aren't supported. For information about using dynamic group memberships in the embedding workflow, see [Dynamic group membership using assertions](https://help.tableau.com/current/online/en-us/to_add_users_groups.htm#dynamic-group-membership-using-assertions). ##### OAuth 2.0 trust As a Tableau Cloud site administrator or Tableau Server administrator, you can register an external authorization server (EAS) to establish a trust relationship between Tableau and the EAS. By establishing a trust relationship, you’re able to provide your users a single sign-on (SSO) experience to Tableau content embedded in your custom applications through the identity provider (IdP) you’ve already configured for Tableau. When embedded Tableau content is loaded in your custom application, a standard OAuth flow is used. After users successfully sign in to the IdP, they’re then automatically signed in to Tableau. To use a connected app with OAuth 2.0 trust, your Tableau Cloud site or Tableau Server instance must be using an identity provider (IdP) for authentication. The EAS must be set up to provide a JSON Web Token (JWT). You use the JWT when you embed the Tableau view as a web component in your application. You must configure the JWT so that it includes a registered claim for the scope (`"scp"`). See [Pass the JWT to the Tableau web component](#pass-the-jwt-to-the-tableau-web-component) for more information. There are JWT libraries and packages in various languages that you can use to build the JWT. For more information about configuring a connected app using OAuth 2.0 trust, see the following: - For Tableau Cloud - [Configure Connected Apps with OAuth 2.0 Trust](https://help.tableau.com/current/online/en-us/connected_apps_eas.htm) in the Tableau Cloud Help - For Tableau Server - [Configure Connected Apps with OAuth 2.0 Trust](https://help.tableau.com/current/server-linux/en-us/connected_apps_eas.htm) in the Tableau Server Help * * * ## Pass the JWT to the Tableau web component Whether you’re configuring your embedded web application to use a unified access token (UAT) or connected app, you must configure the JWT so that it includes a registered claim for the scope (`"scp"`). For example, for embedded views, you set the value as `tableau:views:embed`. | Embedding Element | Scope (`scp`) | | --- | --- | | TableauViz | `tableau:views:embed` | | TableauAuthoringViz | `tableau:views:embed_authoring`, `tableau:views:embed` | | TableauPulse | `tableau:insights:embed` | | AskData | `tableau:ask_data:embed` \* | | Metrics | `tableau:metrics:embed` \* | \* Note: In October 2023, Tableau retired the ability to embed metrics in Tableau Cloud and Tableau Server version 2023.3. Ask Data will be retired in Tableau Cloud in February 2024 and in Tableau Server version 2024.2. You can specify more than one value for the scope. For example, for embedded web authoring you also need to include the scope for viewing (`tableau:views:embed_authoring` and `tableau:views:embed`). The scope respects the permissions a user already has configured in Tableau, which allows the user to interact with the view the way they can on Tableau directly. You then explicitly pass the JWT that is generated by the EAS or by your web server to the ``, ``, or `` web component. You include the JWT by using the `token` attribute. For example, you could programmatically build the JWT based on the connected app secrets and then add it to the `` web component as the `token` attribute, or if you’re using JavaScript assign the JWT to the `TableauViz.token` property. ``` ``` For sample code showing how you can construct the JWT, see the [connected-apps-jwt-samples](https://github.com/tableau/connected-apps-jwt-samples) repository on GitHub. This repository contains samples in popular programming languages for generating a JWT. * * * ## About Tableau site settings for authentication Several Tableau site settings interact with or affect authentication for embedded content. This section describes key settings related to connected apps, user attributes, on-demand access, and dynamic group membership through assertions. ### General embedding When you embed a view that has been configured to use a Tableau connected app for authentication, the domain allowlist of the connected app isn’t affected by the [Tableau Site settings for embedding](/current/api/embedding_api/en-us/docs/embedding_api_site.html). For more information about how the site settings relate to connected apps, see the [Tableau site settings for embedding and connected apps](/current/api/embedding_api/en-us/docs/embedding_api_site.html#the-tableau-site-settings-for-embedding-and-connected-apps). ### User attributes The Tableau Cloud or Tableau Server site setting, **Control User Access in Authentication Workflows** enables user attribute functions used in embedded content to accept the passing of user attributes from a JSON Web Token (JWT). To enable this setting, do the following: Sign in to Tableau Cloud as a site administrator or Tableau Server as an administrator, select **Settings** > **Authentication**, and then select the **Enable capture of user attributes in authentication workflows** checkbox. Alternatively, you can use the [Update Site](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_site.htm#update_site) endpoint using the Tableau REST API to programmatically enable the _attribute-capture-enabled_ setting. ### On-demand access (Tableau Cloud only) On-demand access isn’t enabled through a Tableau Cloud site setting. Instead, to enable the on-demand access capability for a group, when creating or editing a group, you must select the **Allow on-demand access** checkbox. For more information about creating groups, see [Create a Group and Add Users to It](https://help.tableau.com/current/online/en-us/to_add_users_groups.htm). You can also enable this capability using the Tableau REST API. For more information, see the [Create Group](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_users_and_groups.htm#create_group) and [Update Group](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_users_and_groups.htm#update_group) methods in the Tableau REST API Help. ### Dynamic group membership through assertions The Tableau Cloud site or Tableau Server setting, **Assertions for Group Membership**, enables you to dynamically control group members through assertions. Two custom group membership claims must be included in the JWT assertion to specify group membership. To enable this setting, do the following: Sign in to Tableau Cloud as a site administrator or Tableau Server as an administrator, go to the **Settings** page (for a multi-site Tableau Server, go to the Settings page for all sites). Under the **Assertions for Group Membership** heading, select the **Allow group assertions to enable group membership through SAML or JWT assertions** checkbox. * * * ## Error handling for connected apps Starting with Tableau 2023.2 and the Embedding API v3 library version 3.6, there’s a new authentication flow and an event type you can use to help catch and identify errors that occur when you’re using a connected app or an external authorization server (EAS) for authentication. This event is triggered when an error happens during the initialization of the web component, which includes views (authoring and viewing) and Ask Data web components. The errors include authentication errors, connectivity errors, etc. ### Embedding multiple view or Ask Data lenses If you’re embedding multiple views or Ask Data lenses in a web application using connected apps for authentication, be sure to use the same JWT for all embedded components. Using different tokens for each embedded component could lead to unexpected behavior, sometimes loading correctly and sometimes prompting users to sign in. Note: Ask Data will be retired in Tableau Cloud in February 2024 and in Tableau Server version 2024.2. ### Compatibility This authentication flow for connected apps, including the new error handling capability and related bug fixes, is only available if you’re using version 3.6 (or later) of the Embedding API library and Tableau 2023.2 (or later). Generally, you should always use the latest version of the library from the Tableau instance that hosts the view you’re embedding. If for some reason you need to use the authentication flow for connected apps that was available in previous versions of Tableau and the Embedding API, the 3.6 version of the library provides an attribute that enables that behavior. **Note:** Using the older flow doesn’t provide the error handling capability available with the 3.6 library and Tableau 2023.2. For more information, see [Use the iframe-auth attribute to enable previous authorization flow](#use-the-iframe-auth-attribute-to-enable-previous-authorization-flow). ### Add an event listener for load and initialization errors You can set up an event listener for a view loading error using this new event type, `TableauEventType.VizLoadError`, or the web component attribute, `onVizLoadError`. In your callback function for the event handler, you can now take action depending upon the connected app error codes. For the list of error codes, see [Troubleshoot Connected Apps](https://help.tableau.com/current/online/en-us/connected_apps_troubleshoot.htm). For example, in a `` web component, you could add the event listener for the `onVizLoadError` and specify the callback function to handle the event (in this case, `handleLoadError`). You define your `handleLoadError()` function in your JavaScript code. ``` ``` To add the same event listener in JavaScript, you first access the `TableauViz` object from the DOM, and then call `addEventListener` with the event type (`TableauEventType.VizLoadError`). ``` const tableauViz = document.getElementById('tableauViz'); tableauViz.addEventListener(TableauEventType.VizLoadError, handleLoadError); ``` In your event handler, you can capture the error code from the event payload and then use the status and error codes for debugging, or take action based on the error code returned. ``` function handleLoadError (e) { const message = JSON.parse(e.detail.message); console.log(message); // do something based on the error code in e.detail } ``` Another option is to use information about the error to determine whether to use the previous authentication flow, or whether to bypass the connected app authentication path completely and revert to the Tableau login prompt. The following example shows how you could create an event handler that switches to the previous flow when an `unknown-auth-error` occurs by setting the `iframeAuth` property. If a different load error occurs, the event handler removes the `token` attribute, so that the user sees the Tableau login prompt. ``` // Error handling logic tableauViz.addEventListener(TableauEventType.VizLoadError, (e) => { if (e.detail.errorCode == "unknown-auth-error") { e.target.iframeAuth = true; } else { e.target.removeAttribute("token"); // prompt user to login } }); ``` ### Use the iframe-auth attribute to enable previous authorization flow Starting with the 3.6 library and Tableau 2023.2, the authentication flow for connected apps is handled through the Embedding API. With previous versions of the library and with prior versions of Tableau (that supported connected apps), the authentication flow was performed inside the iframe. If you can’t use the new authentication flow, you can revert to the previous flow by setting the `iframeAuth` property on the view or Ask Data object, or the `iframe-auth` attribute on the component. Using the older flow doesn’t provide the error handling capability available with the 3.6 library and Tableau 2023.2, so you won’t be able to use the new `VizLoadError` event. To use the older authentication flow with the 3.6 library and Tableau 2023.2, add the `iframe-auth` attribute in the web component (or set the `iframeAuth` property on the Viz object). ``` ``` * * * ### Securely sign users out of embedded Tableau content In most cases, with connected apps (direct trust) and embedded views, when a user logs out of the webpage/application there really isn’t an issue with another user accessing the embedded content because users aren’t typically using a shared environment. However, if users access an embedded view in a shared environment (shared device/shared browser), you might need to securely sign them out between sessions. The problem is that when one user is done interacting with the embedded content, another user could still access the embedded content even if the first user logs out. The reason is because Tableau sets an `HttpOnly` session cookie when you first sign in. If the browser stays open, as in a shared environment, the session remains active until it times out and expires, or until the browser closes. To make sure that the current user is signed out, and to clear the session cookie, call the [Tableau REST API Sign Out](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_authentication.htm#sign_out) endpoint. Starting with the Tableau REST API version 3.27, the sign-out endpoint removes the cookie and ends the session. For example, to fix the issue, add JavaScript code to your application that calls the REST sign-out endpoint. The following example shows one way to sign out the user and to end the session. In the example, `viz` is the `TableauViz` object for the embedded view. The example signs the user out and also forces the `iframe` to reload, which clears the view for the next user. ``` // assumes the viz object has been declared for the Tableau view // Available in API_VERSION 3.27 or later fetch("https://{YOUR_TABLEAU_CLOUD_BASE_URL}/api/{API_VERSION}/auth/signout", { credentials: "include", method: "POST", headers: { "Content-Type": "application/json;charset=UTF-8", }, body: JSON.stringify({}) }) .then((response) => { if (response.ok) { console.log("logout is successful!"); } }) .then(() => { console.log("reload the iframe to clear the view"); const iframe = viz.shadowRoot?.querySelector('iframe'); requestAnimationFrame(() => { iframe.src = iframe.src; // defers the reload to after the current paint cycle }); }) .catch((error) => console.error("Error:", error)); ``` * * * ## More information - For the list of connected app error codes, see the following: - Direct trust - [Troubleshoot Connected Apps (Tableau Cloud)](https://help.tableau.com/current/online/en-us/connected_apps_troubleshoot.htm) or [Troubleshoot Connected Apps (Tableau Server)](https://help.tableau.com/current/server/en-us/connected_apps_troubleshoot.htm) - OAuth 2.0 trust - [Troubleshoot (Tableau Cloud)](https://help.tableau.com/current/online/en-us/connected_apps_eas.htm#troubleshoot) or [Troubleshoot (Tableau Server)](https://help.tableau.com/current/server/en-us/connected_apps_eas.htm#troubleshoot) - For general information about connected apps, see the following: - Tableau Cloud - [Configure Tableau Connected Apps](https://help.tableau.com/current/online/en-us/connected_apps.htm) - Tableau Server, [Configure Tableau Connected Apps (Windows)](https://help.tableau.com/current/server/en-us/connected_apps_eas.htm) - For information about setting up a connected app on Tableau Cloud or Tableau using the Tableau REST API, see [Connected App Methods](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_connected_app.htm). - For information about configuring a unified access token (using the Tableau Cloud Manager REST API), see [Unified Access Tokens](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html). - For sample code showing how you can construct the JWT, see the [connected-apps-jwt-samples](https://github.com/tableau/connected-apps-jwt-samples) repository on GitHub. - For information custom domains, see [Introducing Tableau Cloud Custom Domains](https://www.tableau.com/blog/introducing-tableau-cloud-custom-domains) and [Use a Custom Domain with Tableau Cloud](https://help.tableau.com/current/online/en-us/custom_domain.htm). #### On This Page [Skip to main content](#main-content) # Authentication Methods Using the authentication methods of the Tableau REST API you can: - Sign in a user to Tableau Server or Tableau Cloud - Authenticate with a [personal access token](https://help.tableau.com/current/server/en-us/security_personal_access_tokens.htm) (PAT) for improved security with granular monitoring and revocation - If you're any Tableau Cloud user, you can list and revoke PATs - If you're a Tableau Cloud site admin, you can list and revoke users' PATs - Authenticate with username and password for quick manual sign in for all users and user impersonation for administrators - Authorize access using a Tableau connected app and a JSON Web Token (JWT) - Authorize access using a unified access token and a JSON Web Token (JWT) - Impersonate a user if you are a Tableau Server administrator, using username and password or PAT - Sign out a user from a Tableau server - Switch the from the current site you are signed into, to another on the server without authenticating again This functionality relates to the UI elements and concepts described at: [Sign in to Tableau Server or Online](https://help.tableau.com/current/pro/desktop/en-us/sign_in_server.htm). The [Tableau Server Client library](https://tableau.github.io/server-client-python/), a Python wrapper for the REST API, offers the following related items: [Auth Methods](https://tableau.github.io/server-client-python/docs/api-ref#authentication); and [Sign In and Out](https://tableau.github.io/server-client-python/docs/sign-in-out). ## Use Postman Our Postman collection of requests enables you to construct, send, and examine HTTP requests to the Tableau Server or Tableau Cloud API without writing initial code. Postman is a free online app used by many developers for prototyping API calls, investigating issues, and generating request code in a variety of languages. [Postman: Authenticate](https://www.postman.com/salesforce-developers/salesforce-developers/folder/2b4ttqa/authenticate) ## List Personal Access Tokens List all personal access tokens (PATs). If you're a site admin, list PATs of a user when you are the site admin on all sites that the PAT owner is a member of. This method is not available for Tableau Server. **Version:** Available in API 3.21 (Tableau Cloud October 2023) and later._[Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)_ **License:** No additional license required. **Permissions:** Any Tableau Cloud user. If you're a Tableau Cloud site admin, you can list the PATs of a user when you are the site admin on all sites that the PAT owner is a member of. _[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)_ **JWT Access Scope:** Not available. #### URI GET /api/api-version/sites/site-luid/users/user-luid/personal-access-tokens #### URI Parameter Values
api-versionThe version of the API to use, such as 3.29. For more information, see REST API and Resource Versions.
site-luidThe LUID for the site.
user-luidThe LUID of the user. The user LUID is returned after you successfully authenticate to the Tableau REST API.
#### Request Body None #### cURL Request Example `curl "http://myco/api/3.29/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/users/d5704762-603a-42b2-a9a7-f9cd2b2c4253/personal-access-tokens" -X GET -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd"` #### Response Code 200 #### Response Body Copy ```                                  ``` Copy ``` {  "personalAccessTokens": [    {      "tokenName": "user_pat1",      "tokenGuid": "011b6267-a067-473a-9d16-b34cc58f90df",      "lastUsedAt": "2023-06-13T16:55:46Z",      "expiresAt": "2024-06-12T16:55:46Z"    },    {      "tokenName": "user_pat4",      "tokenGuid": "0fb30637-b638-4ce2-bbac-ac6611104ed9",      "lastUsedAt": "2023-06-13T16:55:51Z",      "expiresAt": "2024-06-12T16:55:51Z"    },    {      "tokenName": "user_pat5",      "tokenGuid": "db8c0b5d-5946-4f7c-a966-af334a3d10a5",      "lastUsedAt": "2023-06-13T16:55:56Z",      "expiresAt": "2024-06-12T16:55:56Z"    }  ]} ``` #### Errors
HTTP statuserror CodeConditionDetails
400400000Bad RequestThe content of the request body is missing or incomplete, or contains malformed XML.
401401002Unauthorized AccessThe authentication token provided in the request header was invalid or has expired.
403403004ForbiddenYou can only list PATs that are yours.
403403010Cross-site access is forbiddenYou're a site admin and can't list PATs when you're not the site admin for all sites the PAT owner is a member of.
For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Revoke Administrator Personal Access Tokens Revokes all [personal access tokens](https://help.tableau.com/current/server/en-us/security_personal_access_tokens.htm) (PATs) created by server administrators. This method is not available for Tableau Cloud. #### URI DELETE /api/api-version/auth/serverAdminAccessTokens #### Parameter Values
api-versionThe version of the API to use, such as 3.29. For more information, see REST API and Resource Versions.
#### Request Body None #### Permissions Only Tableau Server users with server administrator permissions can use this method. #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:server_admin_tokens:delete ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 204 #### Response Body None #### Version Version 3.11 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors
HTTP statuserror CodeConditionDetails
403403004Revoke server admin tokens forbidden,The user does not have the server administrator permissions required to call this method.
404404000Server not foundThe Tableau Server in the URI doesn't correspond to an existing server.
405405000Invalid request methodRequest type was not DELETE.
For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Revoke Personal Access Token Revoke a personal access token (PAT). If you're a site admin, you can revoke a users PAT owhen you are the site admin on all sites that the PAT owner is a member of. This method is not available for Tableau Server. **Version:** Available in API 3.21 (Tableau Cloud October 2023) and later._[Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)_ **License:** No additional license required. **Permissions:** Any Tableau Cloud user. If you're a Tableau Cloud site admin, you can revoke the PAT of a user when you are the site admin on all sites that the PAT owner is a member of. _[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)_ **JWT Access Scope:** Not available. #### URI DELETE /api/api-version/sites/site-luid/users/user-luid/personal-access-tokens/pat-name #### URI Parameter Values
api-versionThe version of the API to use, such as 3.29. For more information, see REST API and Resource Versions.
site-luidThe LUID for the site.
user-luidThe LUID of the user. The user LUID is returned after you successfully authenticate to the Tableau REST API.
pat-nameThe name of the PAT you want to revoke.
#### Request Body None #### cURL Request Example `curl "http://myco/api/3.29/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/users/d5704762-603a-42b2-a9a7-f9cd2b2c4253/personal-access-tokens/my_pat" -X DELETE -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd"` #### Response Code 204 #### Response Body None #### Errors
HTTP status error Code Condition Details
401 401002 Unauthorized Access The credentials token provided in the request header was invalid or has expired.
403 403004 Forbidden You can only revoke PATs that are yours.
403 403010 Cross-site access is forbidden You're a site admin and can't revoke a PAT when you're not the site admin for all sites the PAT owner is a member of.
404 404051 Personal access token not found The PAT couldn't be revoked because it does not exist.
405 405000 Not supported This error can occur for the following reasons:
  • The URI contains an incorrect PAT name or the PAT name is missing
  • The request type is not DELETE
For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Sign In Signs you in as a user on the specified site on Tableau Server or Tableau Cloud. This call returns a credentials token that you use in subsequent calls to Tableau Server or Tableau Cloud. For more information about authentication, see [Signing In and Signing Out (Authentication)](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_auth.htm). **Notes:** - [SAML single sign on](https://help.tableau.com/current/server/en-us/saml_requ.htm) (SSO) authentication does not validate REST API requests. For a scenario where you want to integrate Tableau authentication into a SSO environment you will need to incorporate a REST sign in request, and then use the credentials token from its response in the header of subsequent requests. - The credentials token is valid for REST API calls and Tableau Metadata API (GraphQL) queries. You cannot use the credentials token as authentication for other operations with Tableau Server. In addition, the credentials token is good only for operations in the site that you're signed in to. You cannot sign in to one site and then use the credentials token you get back to send requests to a different site. If you do, the server returns an HTTP 403 (Forbidden) error. - (Tableau Cloud only) If multi-factor authentication (MFA) is enabled with Tableau authentication, PATs are required. You must use a PAT, instead of user name and password, to make a REST API sign in request to Tableau Cloud. Alternatively, you can use a unified access token (UAT) to sign in to Tableau Cloud. **Tableau Server** Typically, a credentials token is valid for 240 minutes. With administrator permissions on Tableau Server, you can change this timeout by using the [tsm configuration set](https://help.tableau.com/current/server/en-us/cli_configuration-set_tsm.htm) command and setting the wgserver.session.idle\_limit option. In addition, if you are a Tableau Server administrator, you can use your username and password to sign in and impersonate a specific user. You might use impersonation in order to double check or troubleshoot the impact of permissions settings for that user. **Tableau Cloud** A credentials token is valid for 120 minutes on Tableau Cloud. #### URI POST /api/api-version/auth/signin **Note:** For Tableau Cloud, the server address in the URI must contain the pod name, such as prod-ca-a or us-east-1. For example, the URI to sign in to a site in the 10ay pod would be:https://prod-ca-a.online.tableau.com/api/api-version/auth/signin. For more information, see [About the pod name](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_auth.htm#pod). #### Parameter Values
api-versionThe version of the API to use, such as 3.29. For more information, see REST API and Resource Versions.
#### Request Body ### PAT Signing in with a user's personal access token (PAT):  - For Tableau Server, see [personal access token](https://help.tableau.com/current/server/en-us/security_personal_access_tokens.htm). - For Tableau Cloud, see [personal access token](https://help.tableau.com/current/online/en-us/security_personal_access_tokens.htm). ``` ``` ### User name and password Signing in with a user's user name and password: ``` ``` ### Impersonating user using username and password Signing in with server administrator's username and password to impersonate a user (Tableau Server only): ``` ``` ### Impersonating user using PAT Signing in with server administrator's [personal access token](https://help.tableau.com/current/server/en-us/security_personal_access_tokens.htm) (PAT) to impersonate a user (Tableau Server only): ``` ``` ### Connected apps JWT Signing in with a JSON Web Token (JWT), from a [connected app](https://help.tableau.com/current/online/en-us/connected_apps.htm) (added in Tableau Cloud June 2022 (API 3.16); Tableau Server 2022.3 (API 3.17)): ``` ``` When a JWT sign-in is used, the JWT must be configured with the scopes of the REST API methods the connected app can access. You can find the scope for a JWT-supported method in a method's properties block or references details under the **Access scope** section. These sections show the scope declaration to use in the JWT that calls that method. **Note:** Beginning in API 3.20 (June 2023) for Tableau Cloud and API 3.21 (Tableau 2023.3) for Tableau Server, the Sign In (and Sign Out) method is supported by JWT authorization using connected apps but does not require a scope to use. **About connected app errors** If you encounter issues with signing in with a JWT, the response body is appended with an additional error code that you can reference in [Troubleshoot scopes](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm#signin) (Tableau Cloud Help) or [Troubleshoot scopes](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm#signin) (Tableau Server Help). For example, in the following response body, you can reference “10084” to help troubleshoot issues with signing in to Tableau Cloud or Tableau Server using a JWT for REST API authorization. "summary": "Signin Error", "detail": "Error signing in to Tableau Cloud (10084)" ### Unified access tokens JWT Signing in with a JSON Web Token (JWT) using a unified access token (added in Tableau Cloud December 2025 (API 3.27)): XML ``` ``` JSON ``` { "credentials": { "jwt": "json-web-token", "isUat": is-uat, "site": { "contentUrl": "" } } } ``` When JWT sign-in is used, the JWT must be configured with the scopes for the REST API capabilities that should be available to the unified access token (UAT). You can find the scope for a JWT-supported method in a method's properties block. The properties block shows the scope declaration to use in the JWT that calls that method. If a scope is not listed in the method's properties block, access to that method can't be limited by a JWT. For more information about UATs, see [Unified Access Tokens](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html) in the Tableau Cloud Manager REST API Help. #### Attribute Values
personal-access-token-name

The name of the personal access token when signing in with a personal access token. The token name is available on a user’s account page on Tableau server or online.
personal-access-token-secret

The secret value of the personal access token when signing in with a personal access token. The value of the secret is available only in the dialog that appears when a user creates a personal access token as described in the Tableau Help.
username The name of the user when signing in with username and password. The name and password in the <credentials> element can represent any user in the specified site. If the user is not an administrator, they might have limited permissions to perform subsequent operations.

Note: If the server is configured to use Active Directory authentication, and if the user name is not unique across domains, you must include the domain as part of the user name (for example, domain_name\Adam).

password The password when signing in with username and password.
json-web-token A JSON Web Token (JWT) associated with a Tableau connected app or unified access token (Tableau Cloud only).

Tableau connected apps JWT: If using Tableau connected apps, the JWT uses a shared secret provided by the Tableau connected app and signed by your external application. Depending on the method used to create the connected app, a JWT can be generated by the connected app as part of the external app's call to sign in to Tableau. The JWT must include access scopes that determine which REST methods the external app can call.

Unified access tokens: Starting in December 2025, if using unified access tokens (UATs), the JWT uses a shared secret as part of the UAT configuration. Added in API 3.27, Tableau Cloud only.
is-uat Enables JWT authorization using a unified access token (UAT) when set to true. Added in API 3.27, Tableau Cloud only.
content-url

The permanent name of the site to sign in to. The content URL appears in the URL path of Tableau content in your browser address bar after the Tableau Server URL.

mySite is the content URL in the following example:

http://<server or cloud URL>/#/site/mySite/explore

For Tableau Server, to specify the default site, omit contentUrl from the site element, or make the contentUrl value an empty string (contentUrl="").

For Tableau Cloud, a sign-in request must have a site element containing a contentUrl with the value of an existing site. If these are missing, the sign-in request will fail.
user-to-impersonate The LUID of a user to sign in as. For impersonation when a system administrator signs in with user name and password.
#### Permissions Any Tableau user can sign in through the REST API. A user that does not have administrator permissions will have limited permissions to perform subsequent operations. Only server administrators can sign in with username and password in order to impersonate other Tableau Server users. #### Response Code 200 #### Response Body ``` ``` An `estimatedTimeToExpiration` value is returned when you sign in using a PAT. The value represents the approximate time until the PAT will expire and need to be refreshed. The estimated time is based on regular usage of the token for authenticating calls, but actual time may be shorter if the token is unused for an extended length of time. The `estimatedTimeToExpiration` value uses the format `DAYS:HH:MM`, where: - The first segment represents **days** - The second segment represents **hours** - The third segment represents **minutes** For example, a value of `2:12:30` indicates 2 days, 12 hours, and 30 minutes until expiration. This format does _not_ represent hours:minutes:seconds. For more information, see the following: - Tableau Cloud - [About PAT expiration](https://help.tableau.com/current/online/en-us/security_personal_access_tokens.htm#about-pat-expiration) - Tableau Server - [Change personal access tokens expiry](https://help.tableau.com/current/server/en-us/security_personal_access_tokens.htm#change-personal-access-tokens-expiry) #### Version Version 1.0 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors
HTTP statuserror CodeConditionDetails
400400000Bad requestThe content of the request body is missing or incomplete, or contains both username/password and a personal access token, or contains malformed XML.
401401001Login errorThe credentials (name or password, or personal access token name or secret) are invalid for the specified site, or the site contentURL is invalid.
401401001Login errorLogin is blocked because several requests with invalid credentials were made.
401401001Login errorThe Administrator requires the user to update their password.
401401001Login errorThe password has expired.
401401009Login errorThe request body is missing or empty.
405405000Invalid request methodRequest type was not POST.

If you are signing in to a Tableau Cloud site, this error may be caused by leaving the pod name out of the server address in the URI.

The error can also be caused by attempting to make a request to a SSL-protected server using HTTP, rather than HTTPS.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). #### Example `curl "https://MY-SERVER/api/3.29/auth/signin" -X POST -d @signin.xml` **Content of signin.xml:** ``` ``` **Example response:** ``` ``` ## Sign Out Signs you out of the current session. This call invalidates the authentication token that is created by a call to [Sign In](#sign_in). **Notes:** - Beginning in API 3.20 (June 2023) for Tableau Cloud and API 3.21 (Tableau 2023.3) for Tableau Server, the Sign Out (and Sign In) method is supported by JWT authorization but does not require a scope to use. For more information, see [JWT](#jwt). #### URI POST /api/api-version/auth/signout #### Parameter Values
api-versionThe version of the API to use, such as 3.29. For more information, see REST API and Resource Versions.
#### Request Body None #### Permissions Any user can call this method. #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:*:* ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 204 #### Response Body None #### Version Version 1.0 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors
HTTP statuserror CodeConditionDetails
405405000Invalid request methodRequest type was not POST.
For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). #### Examples `curl "http://MY-SERVER/api/3.29/auth/signout" -X POST -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd"` ## Switch Site Switches you onto another site without having to provide a user name and password again. This method allows an authenticated user to switch sites that they have access to. When you call this method, you must provide the current authorization token as the value of the X-Tableau-Auth header. Using the current authentication token, the method signs you in as a user on the site specified in the request payload. The method returns a new authentication token and invalidates the old one. You have the permissions of the user associated with the authorization token. By default, the token is good for 240 minutes. (You can specify a different timeout value for the token by calling the `tsm configuration set` command to change the wgserver.session.idle\_limit setting.) **Note** This method is not available on Tableau Cloud. #### URI POST /api/api-version/auth/switchSite #### Parameter Values
api-versionThe version of the API to use, such as 3.29. For more information, see REST API and Resource Versions.
#### Request Body ``` ``` #### Attribute Values
content-url

The permanent name of the site to sign in to. The content URL appears in the URL path of Tableau content in your browser address bar after the Tableau Server URL.

mySite is the content URL in the following example:

http://<server or cloud URL>/#/site/mySite/explore

For Tableau Server, to specify the default site, omit contentUrl from the site element, or make the contentUrl value an empty string (contentUrl="").

For Tableau Cloud, a sign-in request must have a site element containing a contentUrl with the value of an existing site. If these are missing, the sign-in request will fail.
#### Permissions Tableau Server users who are not server administrators can switch sites, provided that they have access to the destination site. #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:sites:switch ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body ``` ``` #### Version Version 2.6 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors
HTTP statuserror CodeConditionDetails
400400000Bad requestThe content of the request body is missing or incomplete, or contains malformed XML.
401401000Unauthorized accessNo authentication credentials were provided.
401401002Unauthorized accessInvalid authentication credentials were provided.
401401003Switch site errorThere was a problem switching sites. The site might be unavailable or is not found.
403403070Cannot switch to the same siteThe site specified as the destination site is also the current site.
405405000Invalid request methodRequest type was not POST.
For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). #### Example `curl "https://MY-SERVER/api/3.29/auth/switchSite" -X POST -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd"-d @switch_site.xml` **Content of switch\_site.xml:** ``` ``` **Example response:** ``` ``` [Skip to main content](#main-content) # Signing In and Signing Out (Authentication) The Tableau REST API requires that you send a credentials token with each request. The credentials token lets Tableau Server or Tableau Cloud verify you as a valid, signed in user. To get a credentials token, you call [Sign In](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_authentication.htm#sign_in) and pass credentials of a valid user, either a Personal Access Token (PAT), a user name and password, along with the content URL (subpath) of the site you are signing in to. A [subset of Tableau REST methods](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm#scopes-available-for-the-tableau-rest-api-tableau-online-only) support authenticated sessions using a JSON Web Token (JWT), typically used in conjunction with a Tableau [connected app](https://help.tableau.com/current/online/en-us/connected_apps.htm) or [unified access token](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html) (Tableau Cloud only). **Notes:** - The REST API does not support single-sign (SSO). To sign in, you must specify the name and password of a user who has been created on Tableau Server or Tableau Cloud. REST API calls will have the permissions of the user they sign in as. We strongly recommend PAT signin because it is more secure. For information about the requirements for using SAML, see [SAML Requirements](https://help.tableau.com/current/server/en-us/saml_requ.htm) in Tableau Server Help and in Tableau Cloud Help. - (Tableau Cloud only) If multi-factor authentication (MFA) is enabled with Tableau authentication, personal access tokens (PATs) are required. You must use a PAT, instead of user name and password, to make a REST API sign in request to Tableau Cloud. Alternatively, you can use unified access tokens (UATs). ## Sign In URI The following example shows the URI for a Sign In using a POST request: ``` POST http://my-server/api/3.29/auth/signin ``` **Server path parameter** The `my-server` value in the sign in URI is the base URL for your Tableau Server. For Tableau Cloud, the server address in the URI must contain the pod name, such as `10az`, `10ay`, or `us-east-1`. For example, the URI to sign in to a site in the 10ay pod would be: ``` https://10ay.online.tableau.com/api/3.29/auth/signin ``` ### Choose How to Sign In To help you choose the right sign-in workflow, the table below compares the four ways to authenticate to the Tableau REST API: personal access tokens (PATs), Tableau connected apps, unified access tokens (UATs), and standard credentials (username and password).
Scenario or use casePersonal access tokens (PATs)Connected apps JWTUnified access tokens (UATs) JWTUsername and password
Access    
Enables Tableau REST API accessTableau Cloud, Tableau ServerTableau Cloud, Tableau ServerTableau CloudTableau Server, limited in Tableau Cloud
Permissions    
Restricts setup to server administrators Tableau Server  
Restricts setup to site administrators Tableau Cloud  
Restricts setup to cloud administrators  Tableau Cloud 
Permits setup to all usersTableau Cloud, Tableau Server  Tableau Server, limited in Tableau Cloud
Supports centralized setup  Tableau Cloud 
Security and session management    
Allows single token revocation  Tableau Cloud 
Allows concurrent user sessions Tableau Cloud, Tableau ServerTableau Cloud 
Supports user impersonationTableau Server  Tableau Server
Supports access scopes Tableau Cloud, Tableau ServerTableau Cloud 
## Make a Sign In Request with a Personal Access Token A personal access token (PAT) validates that a user is allowed to sign in to a site. A sign in using a PAT returns the same information as a username and password sign in (i.e., a credentials token, site LUID, and user LUID), but without the security risk of exposing hard-coded usernames and passwords, or an interactive login experience. PATs are long-lived, and can be revoked without disabling the Tableau user they are attached to. A user can have multiple PATs, which allows for granular monitoring and revocation of access rights. For example, an admin might group their scripts into functional areas (like permissions, subscriptions, and data source refreshes) and use a different PAT for each area. For more information, see one of the following topics:  - For Tableau Cloud, see [Personal Access Token](https://help.tableau.com/current/online/en-us/security_personal_access_tokens.htm) in the Tableau Cloud Help. - For Tableau Server, see [Personal Access Token](https://help.tableau.com/current/server/en-us/security_personal_access_tokens.htm) in the Tableau Server Help. When you [create a Personal Access Token](https://help.tableau.com/current/pro/desktop/en-us/useracct.htm#create-and-revoke-personal-access-tokens), Tableau Cloud or Tableau Server displays a dialog that shows the PAT name and secret. There is no way to retrieve a secret after that Personal Access Token dialog is closed. Copy the secret value to use in your sign in request body. ### Personal access token expiration PATs expire if they are not used for 15 consecutive days. If they are used more frequently than every 15 days, the following can occur: - On Tableau Cloud, PATs expiration depends on the site setting, which is configurable by a site admin. - On Tableau Server, PATs expire after one year by default. After PATs have expired they can’t be used for authentication and are removed from your My Account Settings page in Tableau Cloud or Tableau Server. ### Request body The XML request body (message payload) using a PAT looks like the following example. The header of the request should contain either the key value pair `Content-Type` : `text/xml`, or `Content-Type` : `application/xml`. ``` ``` The same request body using JSON looks like the following. Its header should contain `Content-Type` : `application/json`. ``` { "credentials": { "personalAccessTokenName": "MY_TOKEN_NAME", "personalAccessTokenSecret": "qlE1g9MMh9vbrjjg==:rZTHhPpP2tUW1kfn4tjg8", "site": { "contentUrl": "MarketingTeam" } } } ``` ## Make a Sign In request with a JWT A JSON Web Token (JWT) is an industry standard authorization method that allows an app to generate credentials for an authorized user. JWTs are commonly used in scenarios where authentication provided by one service enables authorization of another service. For example, a user signs into an external app using their Google credentials, then the external app creates a JWT to authorize a user for Tableau credentials. JWTs are enabled through Tableau connected apps or unified access tokens (Tableau Cloud only). #### Tableau connected apps For more information about connected apps, see one of the following: - Tableau Cloud - [Use Tableau Connected Apps for Application Integration](https://help.tableau.com/current/online/en-us/connected_apps.htm) - Tableau Sever - [Use Tableau Connected Apps for Application Integration](https://help.tableau.com/current/server/en-us/connected_apps.htm) #### Unified access tokens For more information about UATs, see [Unified Access Tokens](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html) in the Tableau Cloud Manager REST API Help. ### Access scopes To ensure minimum access to administrative tasks and content, the JWT should contain access scopes that determine which methods are accessible to the connected app or UAT. Both connected apps and UATs share the same access scopes. You can find the required scope for a JWT-supported method in its properties block or section in the Tableau REST API Help or TCM REST API Help. If a scope is not listed in the method, access to that method can’t be controlled by a JWT. For more information about access scopes for connected apps, see one of the following: - Tableau Cloud - [Access scopes for connected apps](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) - Tableau Server - [Access scopes for connected apps](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) For more information about UAT scopes, see [About least privileged and access scopes](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#about-least-privileged-access-and-access-scopes-). ### Sign in with connected apps JWT One method you can use to to authorize access to the REST API using a JWT is using Tableau connected apps. For a connected apps workflow, two things must be true. First, a Tableau [connected app](https://help.tableau.com/current/online/en-us/connected_apps.htm) must be created by a Tableau Server administrator or Tableau Cloud site admin. Depending on the type of connected app, a JWT can be generated by the connected app as part of the external app's call to sign in to Tableau. Second, the JWT also must contain JWT-supported [access scopes](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) that determine which methods the connected app can call. #### Request body The XML request body (message payload) for a sign in request using a JWT looks like the following example. The header of the request should contain either the key value pair `Content-Type` : `text/xml`, or `Content-Type` : `application/xml`. ``` ``` The same request body using JSON looks like the following. Its header should contain `Content-Type` : `application/json`. ``` { "credentials": { "jwt": "eyJpc3MiOiI1NmUwZGZhYi0zNDA3LTRlNWMtYWY5Ni04YzI1ZmY0NWI3ODMiLCJhbGciOiJIUzI1NiIsImtpZCI6ImJlNzFkNDc0LWMxOTctNDljNS04ZWIzLTM5YWU4MWVjNDNhYyJ9.eyJhdWQiOiJ0YWJsZWF1Iiwic3ViIjoidGVzdDEyMyIsInNjcCI6WyJ0YWJsZWF1OmNvbnRlbnQ6cmVhZCJdLCJpc3MiOiI1NmUwZGZhYi0zNDA3LTRlNWMtYWY5Ni04YzI1ZmY0NWI3ODMiLCJleHAiOjE2NDc2MjM1NzUsImp0aSI6ImY0MzdkNDFmLWM1MmMtNGE5Mi1hYTA1LWFjYTYyMGViZTgzMSJ9.pntsSpHmrxTT5XmiJi1Ls2qQdu4qMRQ5vgRuN7gtS_U", "site": { "contentUrl": "MarketingTeam" } } } ``` ### Sign in with unified access tokens JWT **(Tableau Cloud only)** Another method to authorize access to the REST API using a JWT is through unified access tokens (UAT). UATs are configurations that must be generated through [Tableau Cloud Manager REST API](https://help.tableau.com/current/api/cloud-manager/en-us/reference/index.html) and be associated with the JWT token that is used to sign in to the Tableau REST API. To ensure minimum access to administrative tasks and content, the JWT must contain access scopes that determine which methods are accessible to the UAT. #### Request body The XML request body (message payload) for a sign in request using a JWT looks like the following example. The header of the request should contain either the key value pair `Content-Type : text/xml`, or `Content-Type : application/xml`. ``` isUat= "true" ``` The same request body using JSON looks like the following. Its header should contain `Content-Type : application/json`. ``` { "credentials": { "jwt": "eyJpc3MiOiI1NmUwZGZhYi0zNDA3LTRlNWMtYWY5Ni04YzI1ZmY0NWI3ODMiLCJhbGciOiJIUzI1NiIsImtpZCI6ImJlNzFkNDc0LWMxOTctNDljNS04ZWIzLTM5YWU4MWVjNDNhYyJ9.eyJhdWQiOiJ0YWJsZWF1Iiwic3ViIjoidGVzdDEyMyIsInNjcCI6WyJ0YWJsZWF1OmNvbnRlbnQ6cmVhZCJdLCJpc3MiOiI1NmUwZGZhYi0zNDA3LTRlNWMtYWY5Ni04YzI1ZmY0NWI3ODMiLCJleHAiOjE2NDc2MjM1NzUsImp0aSI6ImY0MzdkNDFmLWM1MmMtNGE5Mi1hYTA1LWFjYTYyMGViZTgzMSJ9.pntsSpHmrxTT5XmiJi1Ls2qQdu4qMRQ5vgRuN7gtS_U", "isUat": true "site": { "contentUrl": "MarketingTeam" } } } ``` ## Make a Sign In Request with Username and Password The XML request body (message payload) for a sign in request using a username and password looks like the following example. The header of the request should contain either the key value pair `Content-Type` : `text/xml`, or `Content-Type` : `application/xml`. ``` ``` The same request body using JSON looks like the following. Its header should contain `Content-Type` : `application/json`. ``` { "credentials": { "name": "admin", "password": "p@ssword", "site": { "contentUrl": "MarketingTeam" } } } ``` ## About the pod name **(Tableau Cloud only)** The server address in the URI must contain the pod name, such as "prod-ca-a". For example, the URI to sign in to a site on the "prod-ca-a" pod would be: `https://prod-ca-a.online.tableau.com/api/api-version/auth/signin` To find the pod name, do the following: 1. Sign in to [Tableau Cloud](https://online.tableau.com). 2. Navigate to your browser's address bar. The pod name is in the first portion of the URL after you've successfully signed in. For more information about signing in to Tableau Cloud, see [Sign In to Tableau Cloud](https://help.tableau.com/current/online/en-us/to_signin.htm) in the Tableau Cloud Help. ## About the site attribute The `site` element of a sign in request lets you specify the site to sign in to by setting the value of the `contentUrl` attribute. The content URL is the subpath of a site's full URL. In the server environment, it is referred to as the Site ID. When you sign in to Tableau Server or Tableau Cloud manually, the `contentUrl` is the the value that appears after `/site/` in the Browser address bar. For example, in the following URLs, the content URL is `MarketingTeam`: - Tableau Server - `http://MyServer/#/site/**MarketingTeam**/projects` - Tableau Cloud - `https://10ay.online.tableau.com/#/site/**MarketingTeam**/workbooks` **Notes:** - For Tableau Server, to specify the default site, omit `contentUrl` from the `site` element, or make the `contentUrl` value an empty string (`contentUrl=""`). - For Tableau Cloud, a sign in request must have a `site` element containing a `contentUrl` with the value of an existing site. If these are missing, the Sign In request will fail. ## Response for a successful Sign In operation If the Sign In call is successful, the body of the response contains an credentials token, the site ID of the site you're signed in to, and the user ID of the user you're signed in as. The following example shows the response in XML (when Content-Type header is set to `text/xml` or `application/xml` or when the Accept header is set to `application/xml`). ``` ``` In JSON, the response would look like the following (when Content-Type or the Accept header is set to `application/json`), ``` { "credentials": { "site": { "id": "9a8b7c6d5-e4f3-a2b1-c0d9-e8f7a6b5c4d", "contentUrl": "" }, "user": { "id": "9f9e9d9c-8b8a-8f8e-7d7c-7b7a6f6d6e6d" }, "token": "HvZMqFFfQQmOM4L-AZNIQA|5fI6T54OPK1Gn1p4w0RtHv6EkojWRTwq|a946d998-2ead-4894-bb50-1054a91dcab3" } } ``` The `id` attribute is the LUID, or locally unique identifier, for the site. In the preceding example, the site LUID is `9a8b7c6d5-e4f3-a2b1-c0d9-e8f7a6b5c4d`. Many REST API methods require the site LUID to specify the site in their URI. For more information, see [Identifying Resources Using Locally Unique Identifiers (LUIDs)](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_luid.htm). ## Using the Credentials Token In Subsequent Calls When you get the response, you parse the credentials token out of the response and store it in your application. By default, the credentials token is good for 240 minutes. (You can specify a different timeout value for the token by calling the [tsm configuration set](https://help.tableau.com/current/server/en-us/cli_configuration-set_tsm.htm) command to change the wgserver.session.idle\_limit setting.) If your application needs to be able to make additional calls after the credentials token has expired, you can call Sign In again and get a new credentials token. You include the credentials token as the value of the X-Tableau-Auth header for all other REST API calls. For example: X-Tableau-Auth: HvZMqFFfQQmOM4L-AZNIQA|5fI6T54OPK1Gn1p4w0RtHv6EkojWRTwq|a946d998-2ead-4894-bb50-1054a91dcab3 **Note:** The credentials token is valid for REST API calls, VizQL Data Service calls, and Tableau Metadata API (GraphQL) queries. You cannot use the credentials token as authentication for other operations with Tableau Server or Tableau Cloud. In addition, the credentials token is good only for operations in the site that you're signed in to. You cannot sign in to one site and then use the token you get back to send requests to a different site. If you do, the server returns an HTTP 403 (Forbidden) error. When you are finished with a session, you call Sign Out. This invalidates the credentials token, which makes sure that no one else can use the credentials token to make calls to the REST API. ## Impersonating a User **(Tableau Server only)** If you are a system administrator on Tableau Server, you can sign in using your username and password credentials for that role, and then impersonate any user on the system. This might be useful if sign-in is being managed by a process that runs as a specific user (the administrator) but needs to be able to access Tableau Server using different user identities. While you are signed in impersonating a user, you will have that user’s permissions. If the user is not an administrator, their permissions will limit your ability to make some REST calls. To sign in using impersonation, you include a user element in the request body and specify the Tableau Server user ID (not name) of the user to impersonate, as in the following XML request: ``` ``` Or in JSON: ``` { "credentials": { "name": "admin", "password": "p@ssword", "site": { "contentUrl": "Marketing" }, "user": { "id": "9f9e9d9c8-b8a8-f8e7-d7c7-b7a6f6d6e6d" } } } ``` You can get a user ID by using one of the following methods: - [Add User to Site](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#add_user_to_site) - [Get Users on Site](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#get_users_on_site) - [Get Users in Group](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#get_users_in_group) ## Python Example for Sign In and Sign Out (XML) The following example in Python shows how to use the REST API to sign in to Tableau Server and get back an credentials token. Note the following about this example: - The code illustrates a [Sign In](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#sign_in) request and a [Sign Out](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#sign_out) request. - By default, your sign in will use a personal access token for authentication credentials. You must set the `use-pat-flag` to `False` to use username and password as credentials. - You must substitute the name of your own server for the `MY-SERVER` placeholder. - You must substitute the API version number of your own server for the `version` placeholder. To find your server's API version number, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). - You must substitute your own credential values in either the `TOKEN_NAME` and `TOKEN_SECRET`, or `USERNAME` and `PASSWORD` placeholders. - The code makes HTTP requests using the urllib2 library that is built into Python. Use HTTPS requests when working with Tableau Cloud or a Tableau Server that is configured to use SSL. - The code creates and parses the XML block in the response body using the built-in `ElementTree` method. For details, see the [ElementTree XML API](https://docs.python.org/2/library/xml.etree.elementtree.html) documentation on the Python website. For additional examples, see [REST API Samples](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_samples.htm). ``` # This example shows how to use the Tableau Server REST API # to sign in to a server, get back an credentials token and # site ID, and then sign out. # The example runs in Python 2.7 and Python 3.3 try: # Python 3 from urllib.request import urlopen, Request except ImportError: # Python 2 from urllib2 import urlopen, Request import xml.etree.ElementTree as ET # For parsing XML responses # NOTE! Substitute your own values for the following variables: use_pat_flag = True # True = use personal access token for sign in, False = use username and password for sign in. server_name = "YOUR_SERVER" # Name or IP address of your installation of Tableau Server version = "x.x" # API version of your server site_url_id = "SITE_SUBPATH" # Site (subpath) to sign in to. An empty string is used to specify the default site. # For username and password sign in user_name = "USERNAME" # User name to sign in as (e.g. admin) password = "PASSWORD" # For Personal Access Token sign in personal_access_token_name = "TOKEN_NAME" # Name of the personal access token. personal_access_token_secret = "TOKEN_VALUE" # Value of the token. signin_url = "https://{server}/api/{version}/auth/signin".format(server=server_name, version=version) if use_pat_flag: # The following code constructs the body for the request. The resulting element will # look similar to the following example: # # # # # # # # request_xml = ET.Element('tsRequest') credentials = ET.SubElement(request_xml, 'credentials', personalAccessTokenName=personal_access_token_name, personalAccessTokenSecret=personal_access_token_secret) site_element = ET.SubElement(credentials, 'site', contentUrl="") else: # The following code constructs the body for the request. The resulting element will # look similar to the following example: # # # # # # # # request_xml = ET.Element('tsRequest') credentials = ET.SubElement(request_xml, 'credentials', name=user_name, password=password) site_element = ET.SubElement(credentials, 'site', contentUrl="") request_data = ET.tostring(request_xml) # Send the request to the server req = Request(signin_url, data=request_data, method="POST") req = urlopen(req) # Get the response server_response = req.read() # Parse the response XML. The response body will look similar # to the following example: # # # # # # # # response_xml = ET.fromstring(server_response) # Get the credentials token from the element token = response_xml.find('.//t:credentials', namespaces={'t': "http://tableau.com/api"}).attrib['token'] # Get the site ID from the element site_id = response_xml.find('.//t:site', namespaces={'t': "http://tableau.com/api"}).attrib['id'] print('Sign in successful!') print('\tToken: {token}'.format(token=token)) print('\tSite ID: {site_id}'.format(site_id=site_id)) # Set the authentication header using the credentials token returned by the Sign In method. headers = {'X-tableau-auth': token} # ... Make other calls here ... # Sign out signout_url = "https://{server}/api/{version}/auth/signout".format(server=server_name, version=version) req = Request(signout_url, headers=headers, data=b'') req = urlopen(req) print('Sign out successful!') ``` ## Python Example for Sign In and Sign Out (JSON) The following example in Python shows how to use the REST API to sign in to Tableau Server and get back an credentials token. The example supports JSON request and response payloads. Support for JSON was introduced in REST API 2.5. Note the following about this example: - The code illustrates a [Sign In](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#sign_in) request and a [Sign Out](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#sign_out) request. - By default, your sign in will use a personal access token for authentication credentials. You must set the `use-pat-flag` to `False` to use username and password as credentials. - You must substitute the name of your own server for the `MY-SERVER` placeholder. - You must substitute the API version number of your own server for the `version` placeholder. To find your server's API version number, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). - You must substitute your own credential values in either the `TOKEN_NAME` and `TOKEN_SECRET`, or `USERNAME` and `PASSWORD` placeholders. - The code makes HTTP requests using the Requests library. Use HTTPS requests when working with Tableau Cloud or a Tableau Server that is configured to use SSL. - The code creates and parses the JSON block in the response body using the Requests and JSON libraries. For details, see the documentation on the Python website. For additional examples, see [REST API Samples](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_samples.htm). ``` # This example shows how to use the Tableau Server REST API # to sign in to a server, get back a credentials token and # site ID, and then sign out. # The example runs in Python 2.7 and Python 3.3 code import requests, json # NOTE! Substitute your own values for the following variables use_pat_flag = True # True = use personal access token for sign in, false = use username and password for sign in. server_name = "YOUR_SERVER" # Name or IP address of your installation of Tableau Server version = "x.x" # API version of your server site_url_id = "SITE_SUBPATH" # Site (subpath) to sign in to. An empty string is used to specify the default site. # For username and password sign in user_name = "USERNAME" # User name to sign in as (e.g. admin) password = "{PASSWORD}" # For Personal Access Token sign in personal_access_token_name = "TOKEN_NAME" # Name of the personal access token. personal_access_token_secret = "TOKEN_VALUE" # Value of the token. signin_url = "https://{server}/api/{version}/auth/signin".format(server=server_name, version=version) if use_pat_flag: # The following code constructs the body for the request. # The resulting element will look similar to the following example: # # { # "credentials": { # "personalAccessTokenName": "TOKEN_NAME", # "personalAccessTokenSecret": "TOKEN_VALUE", # "site": { # "contentUrl": "" # } # } # } # payload = { "credentials": { "personalAccessTokenName": personal_access_token_name, "personalAccessTokenSecret": personal_access_token_secret, "site": {"contentUrl": site_url_id }}} headers = { 'accept': 'application/json', 'content-type': 'application/json' } else: # The following code constructs the body for the request. The resulting element will# look similar to the following example: # # # { # "credentials": { # "name": "USERNAME", # "password": "PASSWORD", # "site": { # "contentUrl": "" # } # } # } # payload = { "credentials": { "name": user_name, "password": password, "site": {"contentUrl": site_url_id }}} headers = { 'accept': 'application/json', 'content-type': 'application/json' } # Send the request to the server req = requests.post(signin_url, json=payload, headers=headers, verify=False) req.raise_for_status() # Get the response response = json.loads(req.content) # Parse the response JSON. The response body will look similar # to the following example: # # { # "credentials": { # "site": { # "id": "xxxxxxxxxx-xxxx-xxxx-xxxxxxxxxx", # "contentUrl": "" # }, # "user": { # "id": "xxxxxxxxxx-xxxx-xxxx-xxxxxxxxxx" # }, # "token": "CREDENTIALS_TOKEN" # } # } # # Get the credentials token from the credentials element token = response["credentials"]["token"] # Get the site ID from the element site_id = response["credentials"]["site"]["id"] print('Sign in successful!') print('\tToken: {token}'.format(token=token)) print('\tSite ID: {site_id}'.format(site_id=site_id)) # Set the authentication header using the token returned by the Sign In method. headers['X-tableau-auth']=token # ... Make other calls here ... # Sign out signout_url = "https://{server}/api/{version}/auth/signout".format(server=server_name, version=version) req = requests.post(signout_url, data=b'', headers=headers, verify=False) req.raise_for_status() print('Sign out successful!') ``` - [@tableau/taco-toolkit](https://help.tableau.com/current/api/webdataconnector/en-us/reference/index.html) - [app](https://help.tableau.com/current/api/webdataconnector/en-us/reference/modules/app.html) - [AuthHeader](https://help.tableau.com/current/api/webdataconnector/en-us/reference/types/app.AuthHeader.html) # Type alias AuthHeader AuthHeader: {     Authorization?: string; } Represents an authentication header for making authorized HTTP requests. #### Type declaration - ##### `Optional` Authorization?: string #### Example ```ts const authHeader: AuthHeader = { Authorization: 'Bearer ',}// Usage in an HTTP requestconst requestOptions: RequestOptions = { headers: authHeader, // other request options...} ``` ### Settings #### Member Visibility - Inherited #### Theme OSLightDark Generated using [TypeDoc](https://typedoc.org/) - AuthoringViz # Interface AuthoringViz The interface for the top level Authoring Viz object. interface AuthoringViz {     [debug](#debug)?: boolean;     [height](#height)?: string | number;     [hideCloseButton](#hideclosebutton)?: boolean;     [hideEditInDesktopButton](#hideeditindesktopbutton)?: boolean;     [iframeAttributeClass](#iframeattributeclass)?: string;     [iframeAttributeLoading](#iframeattributeloading)?: string;     [iframeAttributeStyle](#iframeattributestyle)?: string;     [iframeAuth](#iframeauth)?: boolean;     [onEditInDesktopButtonClicked](#oneditindesktopbuttonclicked)?: string;     [onFirstInteractive](#onfirstinteractive)?: string;     [onFirstVizSizeKnown](#onfirstvizsizeknown)?: string;     [onWorkbookPublished](#onworkbookpublished)?: string;     [onWorkbookPublishedAs](#onworkbookpublishedas)?: string;     [onWorkbookReadyToClose](#onworkbookreadytoclose)?: string;     [src](#src)?: null | string;     [suppressDefaultEditBehavior](#suppressdefaulteditbehavior)?: boolean;     [token](#token)?: string;     [touchOptimize](#touchoptimize)?: boolean;     [width](#width)?: string | number;     [getCurrentSrcAsync](#getcurrentsrcasync-1)(): Promise;     [getVizQLDataServiceSessionInfo](#getvizqldataservicesessioninfo-1)(): [VizQLDataServiceSessionInfo](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/VizQLDataServiceSessionInfo.html);     [isAnalyticsAssistantAvailableAsync](#isanalyticsassistantavailableasync-1)(): Promise;     [launchAnalyticsAssistantAsync](#launchanalyticsassistantasync-1)(): Promise;     [resize](#resize-1)(): void;     [setAuthToken](#setauthtoken-1)(token: string): void; } #### Hierarchy ([View Summary](https://help.tableau.com/current/api/embedding_api/en-us/reference/hierarchy.html#AuthoringViz)) - [VizAuthoringSettings](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/VizAuthoringSettings.html) - [WebComponentLocalSettings](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/WebComponentLocalSettings.html) - AuthoringViz - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/VizInterfaces.ts:119 ##### Index ### Methods [getCurrentSrcAsync](#getcurrentsrcasync) [getVizQLDataServiceSessionInfo](#getvizqldataservicesessioninfo) [isAnalyticsAssistantAvailableAsync](#isanalyticsassistantavailableasync) [launchAnalyticsAssistantAsync](#launchanalyticsassistantasync) [resize](#resize) [setAuthToken](#setauthtoken) ### Properties [debug?](#debug) [height?](#height) [hideCloseButton?](#hideclosebutton) [hideEditInDesktopButton?](#hideeditindesktopbutton) [iframeAttributeClass?](#iframeattributeclass) [iframeAttributeLoading?](#iframeattributeloading) [iframeAttributeStyle?](#iframeattributestyle) [iframeAuth?](#iframeauth) [onEditInDesktopButtonClicked?](#oneditindesktopbuttonclicked) [onFirstInteractive?](#onfirstinteractive) [onFirstVizSizeKnown?](#onfirstvizsizeknown) [onWorkbookPublished?](#onworkbookpublished) [onWorkbookPublishedAs?](#onworkbookpublishedas) [onWorkbookReadyToClose?](#onworkbookreadytoclose) [src?](#src) [suppressDefaultEditBehavior?](#suppressdefaulteditbehavior) [token?](#token) [touchOptimize?](#touchoptimize) [width?](#width) ## Methods ### getCurrentSrcAsync[](#getcurrentsrcasync) - getCurrentSrcAsync(): Promise[](#getcurrentsrcasync-1) Gets the visualization's current URL. #### Returns Promise - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/VizInterfaces.ts:123 ### getVizQLDataServiceSessionInfo[](#getvizqldataservicesessioninfo) - getVizQLDataServiceSessionInfo(): [VizQLDataServiceSessionInfo](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/VizQLDataServiceSessionInfo.html)[](#getvizqldataservicesessioninfo-1) Gets the server session information for use with VizQL Data Service. The server session information contains the VizQL Server Session ID (X-Session-Id) and the Global Session Header (Global-Session-Header). #### Returns [VizQLDataServiceSessionInfo](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/VizQLDataServiceSessionInfo.html) - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/VizInterfaces.ts:165 ### isAnalyticsAssistantAvailableAsync[](#isanalyticsassistantavailableasync) - isAnalyticsAssistantAvailableAsync(): Promise[](#isanalyticsassistantavailableasync-1) Indicates whether the Analytics Assistant side pane is available. #### Returns Promise - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/VizInterfaces.ts:159 ### launchAnalyticsAssistantAsync[](#launchanalyticsassistantasync) - launchAnalyticsAssistantAsync(): Promise[](#launchanalyticsassistantasync-1) Use this method to launch the Analytics Assistant side pane. You can use the `isAnalyticsAssistantAvailableAsync()` method to check if the Analytics Assistant is available for use. ``` const isAnalyticsAssistantAvailable = await viz.isAnalyticsAssistantAvailableAsync();if (isAnalyticsAssistantAvailable) { await viz.launchAnalyticsAssistantAsync();} ``` #### Returns Promise - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/VizInterfaces.ts:154 ### resize[](#resize) - resize(): void[](#resize-1) Use this method to readjust the dimensions of the embedded viz in response to things like a window resize, device orientation change, or parent container resize. ``` window.addEventListener('resize', () => viz.resize());new ResizeObserver(() => viz.resize()).observe(viz.parentElement); ``` #### Returns void - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/VizInterfaces.ts:141 ### setAuthToken[](#setauthtoken) - setAuthToken(token: string): void[](#setauthtoken-1) Provide an auth token for salesforce native mode #### Parameters - token: string #### Returns void - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/VizInterfaces.ts:129 ## Properties ### `Optional`debug[](#debug) debug?: boolean Indicates whether the non-minified version of JavaScript is loaded. If specified (or set to true), the non-minified version is used for both the local component and the Tableau Server visualization (if enabled). If not specified (or set to false), the minified version of the JavaScript files are loaded. ``` ``` Inherited from [VizAuthoringSettings](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/VizAuthoringSettings.html).[debug](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/VizAuthoringSettings.html#debug) - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/WebComponentInterfaces.ts:50 ### `Optional`height[](#height) height?: string | number Represents height in pixels Can be any valid CSS size specifier. If not specified, defaults to the published height of the view. Inherited from [WebComponentLocalSettings](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/WebComponentLocalSettings.html).[height](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/WebComponentLocalSettings.html#height) - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/WebComponentInterfaces.ts:20 ### `Optional`hideCloseButton[](#hideclosebutton) hideCloseButton?: boolean Indicates whether the Close button is hidden or visible. If not set, defaults to false, meaning that the Close button is visible. ``` ``` Inherited from [VizAuthoringSettings](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/VizAuthoringSettings.html).[hideCloseButton](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/VizAuthoringSettings.html#hideclosebutton) - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/VizInterfaces.ts:693 ### `Optional`hideEditInDesktopButton[](#hideeditindesktopbutton) hideEditInDesktopButton?: boolean Indicates whether the Edit in Desktop button is hidden or visible. If not specified, defaults to false, meaning that the Edit in Desktop button is visible. ``` ``` Inherited from [VizAuthoringSettings](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/VizAuthoringSettings.html).[hideEditInDesktopButton](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/VizAuthoringSettings.html#hideeditindesktopbutton) - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/VizInterfaces.ts:457 ### `Optional`iframeAttributeClass[](#iframeattributeclass) iframeAttributeClass?: string The value of the 'class' attribute of the embedded iframe providing access to any custom selectors defined in the `` child tag. ``` .red-border { border: 1px solid red; } ``` Inherited from [VizAuthoringSettings](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/VizAuthoringSettings.html).[iframeAttributeClass](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/VizAuthoringSettings.html#iframeattributeclass) - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/WebComponentInterfaces.ts:101 ### `Optional`iframeAttributeLoading[](#iframeattributeloading) iframeAttributeLoading?: string The value of the 'loading' attribute of the embedded iframe. See: [https://developer.mozilla.org/en-US/docs/Web/HTML/Element/iframe#loading](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/iframe#loading) ``` ``` Inherited from [VizAuthoringSettings](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/VizAuthoringSettings.html).[iframeAttributeLoading](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/VizAuthoringSettings.html#iframeattributeloading) - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/WebComponentInterfaces.ts:74 ### `Optional`iframeAttributeStyle[](#iframeattributestyle) iframeAttributeStyle?: string The value of the 'style' attribute of the embedded iframe. ``` ``` Inherited from [VizAuthoringSettings](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/VizAuthoringSettings.html).[iframeAttributeStyle](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/VizAuthoringSettings.html#iframeattributestyle) - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/WebComponentInterfaces.ts:85 ### `Optional`iframeAuth[](#iframeauth) iframeAuth?: boolean Indicates whether to use the old auth mechanism for authentication which happens inside the iframe. If specified, VizLoadErrorEvents triggered due to auth failures will not be thrown. ``` ``` Inherited from [VizAuthoringSettings](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/VizAuthoringSettings.html).[iframeAuth](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/VizAuthoringSettings.html#iframeauth) - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/WebComponentInterfaces.ts:62 ### `Optional`onEditInDesktopButtonClicked[](#oneditindesktopbuttonclicked) onEditInDesktopButtonClicked?: string An event raised when the user clicks on the Edit In Desktop Button. You can use this event type with TableauViz objects. ``` ``` Inherited from [VizAuthoringSettings](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/VizAuthoringSettings.html).[onEditInDesktopButtonClicked](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/VizAuthoringSettings.html#oneditindesktopbuttonclicked) - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/VizInterfaces.ts:477 ### `Optional`onFirstInteractive[](#onfirstinteractive) onFirstInteractive?: string An event raised when the Viz object first becomes interactive. This is only raised once. ``` ``` Inherited from [VizAuthoringSettings](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/VizAuthoringSettings.html).[onFirstInteractive](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/VizAuthoringSettings.html#onfirstinteractive) - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/VizInterfaces.ts:496 ### `Optional`onFirstVizSizeKnown[](#onfirstvizsizeknown) onFirstVizSizeKnown?: string An event raised when the size of the viz is known. You can use this event to perform tasks such as resizing the elements surrounding the Viz object once the object's size has been established. ``` ``` Inherited from [VizAuthoringSettings](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/VizAuthoringSettings.html).[onFirstVizSizeKnown](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/VizAuthoringSettings.html#onfirstvizsizeknown) - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/VizInterfaces.ts:487 ### `Optional`onWorkbookPublished[](#onworkbookpublished) onWorkbookPublished?: string An event raised when the workbook has been published. This notification is sent when using embedded web authoring functionality. ``` ``` Inherited from [VizAuthoringSettings](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/VizAuthoringSettings.html).[onWorkbookPublished](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/VizAuthoringSettings.html#onworkbookpublished) - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/VizInterfaces.ts:701 ### `Optional`onWorkbookPublishedAs[](#onworkbookpublishedas) onWorkbookPublishedAs?: string An event raised when "publish as" is successful. This notification is sent when using embedded web authoring functionality. ``` ``` Inherited from [VizAuthoringSettings](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/VizAuthoringSettings.html).[onWorkbookPublishedAs](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/VizAuthoringSettings.html#onworkbookpublishedas) - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/VizInterfaces.ts:709 ### `Optional`onWorkbookReadyToClose[](#onworkbookreadytoclose) onWorkbookReadyToClose?: string An event raised when the workbook is ready to close. This notification is sent when using embedded web authoring functionality. ``` ``` Inherited from [VizAuthoringSettings](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/VizAuthoringSettings.html).[onWorkbookReadyToClose](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/VizAuthoringSettings.html#onworkbookreadytoclose) - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/VizInterfaces.ts:717 ### `Optional`src[](#src) src?: null | string The viz src Inherited from [WebComponentLocalSettings](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/WebComponentLocalSettings.html).[src](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/WebComponentLocalSettings.html#src) - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/WebComponentInterfaces.ts:8 ### `Optional`suppressDefaultEditBehavior[](#suppressdefaulteditbehavior) suppressDefaultEditBehavior?: boolean Indicates whether the default edit behavior is suppressed. If not specified, defaults to false, meaning that the default edit behavior is not suppressed. ``` ``` Inherited from [VizAuthoringSettings](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/VizAuthoringSettings.html).[suppressDefaultEditBehavior](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/VizAuthoringSettings.html#suppressdefaulteditbehavior) - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/VizInterfaces.ts:468 ### `Optional`token[](#token) token?: string The token used for authorization ``` ``` Inherited from [VizAuthoringSettings](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/VizAuthoringSettings.html).[token](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/VizAuthoringSettings.html#token) - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/WebComponentInterfaces.ts:37 ### `Optional`touchOptimize[](#touchoptimize) touchOptimize?: boolean Indicates whether to touch optimize viz controls. ``` ``` Inherited from [VizAuthoringSettings](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/VizAuthoringSettings.html).[touchOptimize](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/VizAuthoringSettings.html#touchoptimize) - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/VizInterfaces.ts:446 ### `Optional`width[](#width) width?: string | number Represents width in pixels Can be any valid CSS size specifier. If not specified, defaults to the published width of the view. Inherited from [WebComponentLocalSettings](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/WebComponentLocalSettings.html).[width](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/WebComponentLocalSettings.html#width) - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/WebComponentInterfaces.ts:14 ### Settings Member Visibility - Protected - Inherited - External ThemeOSLightDark ### On This Page Methods [getCurrentSrcAsync](#getcurrentsrcasync)[getVizQLDataServiceSessionInfo](#getvizqldataservicesessioninfo)[isAnalyticsAssistantAvailableAsync](#isanalyticsassistantavailableasync)[launchAnalyticsAssistantAsync](#launchanalyticsassistantasync)[resize](#resize)[setAuthToken](#setauthtoken) Properties [debug](#debug)[height](#height)[hideCloseButton](#hideclosebutton)[hideEditInDesktopButton](#hideeditindesktopbutton)[iframeAttributeClass](#iframeattributeclass)[iframeAttributeLoading](#iframeattributeloading)[iframeAttributeStyle](#iframeattributestyle)[iframeAuth](#iframeauth)[onEditInDesktopButtonClicked](#oneditindesktopbuttonclicked)[onFirstInteractive](#onfirstinteractive)[onFirstVizSizeKnown](#onfirstvizsizeknown)[onWorkbookPublished](#onworkbookpublished)[onWorkbookPublishedAs](#onworkbookpublishedas)[onWorkbookReadyToClose](#onworkbookreadytoclose)[src](#src)[suppressDefaultEditBehavior](#suppressdefaulteditbehavior)[token](#token)[touchOptimize](#touchoptimize)[width](#width) - [@tableau/taco-toolkit](https://help.tableau.com/current/api/webdataconnector/en-us/reference/index.html) - [app](https://help.tableau.com/current/api/webdataconnector/en-us/reference/modules/app.html) - [AuthTokens](https://help.tableau.com/current/api/webdataconnector/en-us/reference/types/app.AuthTokens.html) # Type alias AuthTokens AuthTokens: {     accessToken: string;     headers: {         \[key: string\]: string;     }; } Represents authentication tokens containing an access token and additional headers. #### Type declaration - ##### accessToken: string - ##### headers: {     \[key: string\]: string; } - ##### \[key: string\]: string #### Example ```ts const authTokens: AuthTokens = { accessToken: 'your_access_token', headers: { 'Custom-Header': 'value', // other headers... },}// Usage in an HTTP requestconst requestOptions: RequestOptions = { headers: { ...authTokens.headers, Authorization: `Bearer ${authTokens.accessToken}` }, // other request options...} ``` ### Settings #### Member Visibility - Inherited #### Theme OSLightDark Generated using [TypeDoc](https://typedoc.org/) # Bash Example ## Generating the JWT A JSON Web Token (JWT) is a standard and secure way to transmit information between parties using JSON. General information about JWTs can be found at [jwt.io](https://jwt.io/). `generate_api_token.sh` ``` #!/bin/bash # Check if the API key is provided as an argument if [ -z "$1" ]; then echo "Usage: $0 API_KEY" exit 1 fi # Define the API key and header/payload API_KEY="$1" HEADER='{"alg":"HS256","typ":"JWT"}' ISSUER="example.com" SUBJECT="Example JWT" ISSUED_AT=$(date +%s) # Construct the payload PAYLOAD="{\"iss\":\"$ISSUER\",\"sub\":\"$SUBJECT\",\"iat\":$ISSUED_AT}" # Base64 encode the header and payload base64_url_encode() { echo -n "$1" | openssl base64 -e | tr -d '=' | tr '/+' '_-' | tr -d '\n' } HEADER_BASE64=$(base64_url_encode "$HEADER") PAYLOAD_BASE64=$(base64_url_encode "$PAYLOAD") # Create the signature SIGNATURE=$(echo -n "$HEADER_BASE64.$PAYLOAD_BASE64" | openssl dgst -sha256 -hmac "$API_KEY" -binary | openssl base64 -e | tr -d '=' | tr '/+' '_-' | tr -d '\n') # Combine the header, payload, and signature to form the JWT JWT="$HEADER_BASE64.$PAYLOAD_BASE64.$SIGNATURE" # Output the JWT echo "JWT: $JWT" ``` ## Sending the request The code below requires bash script above. This code requires the API key, the data provider string, a region, and a base64 URL encoded TDS specified as arguments. The script uses these elements to build a JWT and submit a request to the API gateway. Note that the base64 URL encoded TDS string in this example has been replaced with `` because the encoded TDS is too long to display comfortably here. `send_upload_request.sh` ``` #!/bin/bash # Echo usage if the three required arguments aren't provided if [ -z "$4" ]; then echo "Usage: $0 SERVER_URL DATA_PROVIDER REGION API_KEY" exit 1 fi # Get variables from arguments server_url="$1" data_provider="$2" region="$3" api_key="$4" # Generate JWT output=$(./generate_api_token.sh "$api_key") # Extract the JWT, and hash from the output jwt=$(echo "$output" | grep "JWT" | awk '{ print $2 }') # The payload is a JSON object with name "tdsContent" and value of the base64 URLencoded TDS payload='{ "tdsContent": "" }' # Send the POST request using curl curl -i \ -H "x-salesforce-region: $region" \ -H "Content-Type: application/json" \ -H "Authorization: C2C:$jwt" \ -d "$payload" \ $server_url/v1/upload-tds-content/$data_provider ``` [Skip to main content](#main-content) # Basic Embed **Important changes for the Tableau JavaScript API** As of February 2024, the Tableau JavaScript API is deprecated. Use the Embedding API v3 instead for embedding interactive views into web pages and applications. For guidance on embedding Tableau views, see the [Tableau Embedding API v3 Help](https://help.tableau.com/current/api/embedding_api/en-us/index.html). Embed a visualization in a `div` element. * * * ``` Basic Embed
``` # Basic Embedding The easiest way to embed Tableau views into web applications is to use the embed code that is generated when you click the **Share** button on a published view. You simply copy the code and place it in your HTML page. Starting with Tableau 2021.4, the Embedding API v3 makes it almost as easy by giving you the option of simply adding a web component to your web page. Starting in Tableau 2022.3, Tableau Server, Tableau Cloud, and Tableau Public use the Embedding API v3 web component for the **Embed Code** option (available from **Share** button on the toolbar). The good news is that embedding views using the Embedding API v3 code is now even easier. You can use the Embedding API v3 in Tableau 2021.4 and later. For the Embedding API v3, there are two ways to initializing the API and embed the visualization in your web application: - Use the web component (``) in your HTML code. - Use JavaScript to create the `TableauViz` object. You can also take a hybrid approach and combine these two ways. This topic will show you how you can use these options. For information about editing embedded views, see [Embed Web Authoring](/current/api/embedding_api/en-us/docs/embedding_api_web_authoring.html). * * * ## Use the `tableau-viz` web component for basic embedding The Tableau Embedding API v3 makes embedding a view in your web page or application easy to do, without a lot of JavaScript coding. You just link to the Embedding API library and then add a web component to your HTML code, much like you would any other HTML element. ### Link to the Embedding API library Starting with Tableau 2021.4, the Embedding API v3 is available on Tableau Server, Tableau Cloud, and Tableau Public. In most cases, you should use the version of the Embedding API library that is hosted on the Tableau instance that is serving the view you’re embedding. If you use the file from one of these locations, you can link to the file `tableau.embedding.3.latest.min.js`, which will always point to the latest release of the library. The library is a JavaScript ES6 module. To use the library in your web application, you need to set the `type` attribute to `module` in the ` ``` The library is also hosted on the Tableau CDN, `https://embedding.tableauusercontent.com/`. If you use the library from the CDN, you need to link to a specific release of the file. For example, to use version 3.1.0 of the library, you would include the following in your HTML code: ``` ``` The file, `tableau.embedding.3.latest.min.js`, is only available on Tableau Server, Tableau Cloud, and Tableau Public. For more information about the library file, see [Access the Embedding API](/current/api/embedding_api/en-us/docs/embedding_api_get.html). ### Add the `tableau-viz` component to your HTML page After you link to the library, you can use Tableau Embedding API. Using a `` web component is the simplest way to embed a view into a page and to initialize the Embedding API. You can use the component to configure how you want to initialize the display of the view, by adding attributes, see [Configure Embedding Objects and Components](/current/api/embedding_api/en-us/docs/embedding_api_configure.html). The basic structure of the `` web component is as follows: ``` ``` The `src` attribute specifies the URL of the view on Tableau Server. The best way to get the URL is to click the **Share** button on the Tableau toolbar and then use the **Copy Link**. The `id` attribute identifies the instance of the web component. You will need this `id` if you want to access the view programmatically after the initial loading. For more information, see [Interact with the View](/current/api/embedding_api/en-us/docs/embedding_api_interact.html). For security in your embedded application, Tableau requires that you use the Hypertext Transfer Protocol Secure (HTTPS) when you specify the URL. HTTPS helps protects privacy by encyrypting communication. **Note:** Starting in Tableau 2022.3, Tableau Server, Tableau Cloud, and Tableau Public will use the Embedding API v3 web component for the **Embed Code** option (available from the **Share** button on the toolbar). The `` component replaces the [JavaScript API v1 code previously used.](https://help.tableau.com/current/pro/desktop/en-us/embed_code.htm) If you have web pages that use **Embed Code**, you should update them to use the new initialization method. Be sure to include a link to the Embedding API v3 library. For information about how you can configure the `` component, see [Configure Embedding Objects and Components](/current/api/embedding_api/en-us/docs/embedding_api_configure.html). * * * ## Use JavaScript to initialize the API and embed the view In some instances, you might prefer to configure and initialize the embedded view using JavaScript and the `TableauViz` object, rather than using the `` web component. The first step is to create an `
` to contain the embedded view in your HTML code. In this respect, this is similar to what you do to embed a view using the JavaScript API v2. You also need to give the `
` an identifier (say, `tableauViz`) so that you can specify that element when you append the embedded view. This is important because the view is not rendered until you add it to the DOM. ### HTML code ```
``` Also, if you put your JavaScript code in a separate `.js` file, you’ll need to import the file in your HTML page with the `type` set as `module`. ``` ``` ### JavaScript code for embedding a TableauViz object In your JavaScript code, you need to import the `TableauViz` object from the Embedding API v3 library. You can then create a new instance of the object and configure the object with the path to the view and other properties and methods supported by the object (see [Configure Embedding Objects and Components](/current/api/embedding_api/en-us/docs/embedding_api_configure.html). To simplify your code and improve load times, import just the classes you need, for example `TableauViz` to create the JavaScript object and `TableauEventType` to set an event listener. ``` import { TableauViz, TableauEventType, } from 'https://my-server/javascripts/api/tableau.embedding.3.latest.min.js'; ``` For example, the following code shows how you might embed a view. In this instance, the toolbar is hidden. The example shows how you could add an event listener. In this case, the code adds a `MarkSelectionChanged` event, which is triggered whenever the marks selected in the view change. Elsewhere in your code, you would need to add a `handleMarkSelection()` method to handle the event. It’s important to note that creating the object (`new TableauViz()` does not render the view. To do that, you must add it to the DOM (that is, add it to `document` using `appendChild()`, for example). ``` import { TableauViz, TableauEventType, } from 'https://my-server/javascripts/api/tableau.embedding.3.latest.min.js'; const viz = new TableauViz(); viz.src = 'https://my-server/views/my-workbook/my-view'; viz.toolbar = 'hidden'; viz.addEventListener(TableauEventType.MarkSelectionChanged, handleMarkSelection); document.getElementById('tableauViz').appendChild(viz); /* Methods */ function handleMarkSelection() { alert('Mark(s) selected!'); // code to handle the mark selection goes here } ``` * * * **Important:** If you put your JavaScript code in a separate `.js` file, you’ll need to import the file in your HTML page with the `type` set as `module`. If you import the file as text, the Embedding API library fails to load. ``` ``` * * * For information about how you can configure the `TableauViz` object see [Configure Embedding Objects and Components](/current/api/embedding_api/en-us/docs/embedding_api_configure.html). * * * ## Combine JavaScript and the `tableau-viz` web component to embed the view Some people might prefer a hybrid approach, combining the advantage of using a semantic HTML element with the flexibility and efficiency of JavaScript. In this case, you add a `` web component to your HTML page. But instead of specifying all of the attributes, the URL, toolbar options, etc., you just specify the `` element and provide it with a unique `id`. In your HTML code, include the link to the Embedding API library and then add the web component. ``` ... ... ``` In your JavaScript code, create the `viz` object from the HTML element, and then use the `viz` object to configure the embedded view. ``` const viz = document.getElementById("tableauViz"); viz.src = url; ``` This is similar to the process you take when you [Interact With the View](/current/api/embedding_api/en-us/docs/embedding_api_interact.html) created using the web component. * * * ## Example of basic embedding using the `tableau-viz` web component Here’s the code that shows basic embedding: ``` ``` Here’s what it looks like when you use the code to embed the viz on a web page: * * * ## What’s Next? If you want to add interaction with the Tableau viz, so that users can filter or change the view based upon HTML controls you add to your web page, . For information about the attributes and properties you can set on the embedded web component or JavaScript object, see [Configure Embedding Objects and Components](/current/api/embedding_api/en-us/docs/embedding_api_configure.html). #### On This Page - [@tableau/taco-toolkit](https://help.tableau.com/current/api/webdataconnector/en-us/reference/index.html) - [handlers](https://help.tableau.com/current/api/webdataconnector/en-us/reference/modules/handlers.html) - [BasicHandlerInput](https://help.tableau.com/current/api/webdataconnector/en-us/reference/interfaces/handlers.BasicHandlerInput.html) # Interface BasicHandlerInput The object type sent by the connector app to handlers. The object is used to perform data extraction. #### Type Parameters - #### Data #### Hierarchy - BasicHandlerInput - [FileBasedHandlerInput](https://help.tableau.com/current/api/webdataconnector/en-us/reference/interfaces/handlers.FileBasedHandlerInput.html) ##### Index ### Properties [auth?](https://help.tableau.com/current/api/webdataconnector/en-us/reference/interfaces/handlers.BasicHandlerInput.html#auth) [data](https://help.tableau.com/current/api/webdataconnector/en-us/reference/interfaces/handlers.BasicHandlerInput.html#data) [fetcher](https://help.tableau.com/current/api/webdataconnector/en-us/reference/interfaces/handlers.BasicHandlerInput.html#fetcher) [parser](https://help.tableau.com/current/api/webdataconnector/en-us/reference/interfaces/handlers.BasicHandlerInput.html#parser) ## Properties ### `Optional` auth[](#auth) auth?: string File name of connector authenticator ### data[](#data) data: Data Arbitrary data sent to the connector fetcher ### fetcher[](#fetcher) fetcher: string File name of connector fetcher ### parser[](#parser) parser: string File name of connector parser ### Settings #### Member Visibility - Inherited #### Theme OSLightDark ### On This Page - [auth](#auth) - [data](#data) - [fetcher](#fetcher) - [parser](#parser) Generated using [TypeDoc](https://typedoc.org/) # Best Practices 🕐 _2 min read_ Before your migration to Tableau Cloud, we recommend that you follow the steps in this topic to ensure best practices in both the migration itself and in using Tableau Cloud long term. - Use the [Tableau Cloud Migration Technical Readiness Assessment Accelerator](https://exchange.tableau.com/products/921) to determine if you’re a good fit for a Cloud migration. - [Remove Stale Content](https://help.tableau.com/current/server/en-us/adminview-stale-content.htm) (delete if older than N days w/o access) before migration. - Centralize on [Published Data Sources](https://help.tableau.com/current/pro/desktop/en-us/publish_datasources_about.htm). - Set Permissions at the Group and Project level and [lock Project Permissions](https://help.tableau.com/current/server/en-us/permissions_projects.htm) - Move local files to a Cloud-accessible location to avoid using Bridge resources for local files. - Extract all .csv/.excel files. Tableau Cloud doesn’t support live connections to local files. Bridge is required to connect to those local files. - Review and understand your environment using [Admin Insights](https://help.tableau.com/current/online/en-us/adminview_insights.htm). - Review Tableau cloud storage limitations. Certain Tableau content types have storage capacity limitations on Tableau Cloud. For more information about these limitations, see [Tableau Cloud Site Capacity](https://help.tableau.com/current/online/en-us/to_site_capacity.htm). - Allocate enough free space for a successful migration. Encrypted extracts require three times their size on Tableau Server for encryption and decryption processes. _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 - ") [Skip to main content](#main-content) # Bridge Methods Using the Bridge methods of the Tableau REST API you can: - **Bridge clients:** List Bridge clients for a site or get details for a specific Bridge client; delete a Bridge client; move a Bridge client between pools or to unassigned status. - **Bridge pools:** List, create, update, and delete Bridge pools. [Bridge pools](https://help.tableau.com/current/online/en-us/to_enable_bridge_live_connections.htm) are logical groupings of Bridge clients for load distribution and management. - **Bridge domains:** Add domains to pools, block domains, update domain names or pool assignment, get domain mapping, and delete domain mappings. - **Bridge routing rules:** Create, get, update, and delete Bridge routing rules; add or remove project scoping on an allow rule. Routing rules route a domain's Bridge queries to a specific pool (optionally scoped to projects) or block a domain from being routed. These methods are available for Tableau Cloud. Bridge clients enable secure data connections between Tableau Cloud and on-premises data sources. For more information, see [Use Bridge to Keep Data Fresh](https://help.tableau.com/current/online/en-us/qs_refresh_local_data.htm). ## Add Domain to Pool Associates a domain with a specific Bridge pool, allowing Bridge clients from that domain to use the pool. Each domain can only be assigned to one pool at a time. Root domains and subdomains are supported. Domain assignments are site-specific. Adding a domain already in the pool returns an error. This method is not available for Tableau Server. **Version**: Available in API 3.28 (Tableau Cloud March 2026) and later. Not available for Tableau Server. **License**: No additional license required. **Permissions**: Tableau Cloud site admin. **Access Scope**: `tableau:bridge_rest_api:create` For more information, see [Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm), [Permissions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm), [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), and access scopes for [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows,](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### URI POST /api/api-version/sites/site-luid/bridge-domain-maps #### URI Parameter Values
api-versionThe version of the API to use. For more information, see REST API and Resource Versions.
site-luidThe LUID for the site.
#### Request Body ``` ``` ``` { "bridgeDomain": { "existingDomainName": "example.com", "newPoolLuid": "ebae40a5-d7e4-4214-b3d5-b0715c627b71" } } ``` #### Attribute Values
existingDomainNameThe domain to add to the pool. Root domains and subdomains are supported.
newPoolLuidThe UUID of the Bridge pool to add the domain to. Must be a user-created pool (not a reserved system pool).
#### Response Code 200 #### Response Body None #### Errors
HTTP statuserror CodeConditionDetails
400409004Invalid domain name, invalid pool ID, domain already exists, or pool not foundDomain must conform to valid format; pool ID must be valid UUID and exist; domain must not already be in this pool.
401401000 / 401002Missing or invalid authenticationNo authentication token provided, or token is expired or invalid.
403403000Insufficient permissionsUser does not have Site Administrator role.
429429000Rate limit exceededToo many requests sent in a given time period.
500503904Unexpected server errorAn unexpected error occurred while adding the domain.
For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Add Projects to Routing Rule Adds one or more project filtering conditions to an existing allow rule, narrowing the rule so it applies only to the listed projects. This method applies to allow rules only; adding projects to a block rule is rejected. Each project ID must be a valid UUID and reference a project that exists on the site, and a project already associated with the rule cannot be added again. This method is not available for Tableau Server. **Version**: Available in API 3.30 (Tableau Cloud October 2026) and later. Not available for Tableau Server. **License**: No additional license required. **Permissions**: Tableau Cloud site admin. **Access Scope**: `tableau:bridge_rest_api:update` For more information, see [Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm), [Permissions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm), [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), and access scopes for [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows,](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### URI POST /api/api-version/sites/site-luid/bridge-routing-rules/routing-rule-id/projects #### URI Parameter Values
api-versionThe version of the API to use. For more information, see REST API and Resource Versions.
site-luidThe LUID for the site.
routing-rule-idThe unique identifier (UUID) of the allow rule to add projects to.
#### Request Body ``` ``` ``` { "routingRuleProjects": { "mode": "add", "project": [ { "id": "11111111-2222-3333-4444-555555555555" }, { "id": "66666666-7777-8888-9999-000000000000" } ] } } ``` #### Attribute Values
modeRequired. The operation mode; must be add for this method.
projectRequired. One or more project IDs to add. Each entry requires an id.
#### Response Code 200 #### Response Body Returns the updated `routingRule` with the added projects reflected in `project`. ``` ``` ``` { "routingRule": { "id": "d9e8f7a6-b5c4-3210-fedc-ba9876543210", "domain": "example.com", "isBlocked": false, "poolId": "ebae40a5-d7e4-4214-b3d5-b0715c627b71", "poolName": "WindowsPool", "project": [ { "id": "11111111-2222-3333-4444-555555555555", "name": "Finance", "isDeleted": false }, { "id": "66666666-7777-8888-9999-000000000000", "name": "Sales", "isDeleted": false } ] } } ``` #### Errors
HTTP statuserror CodeConditionDetails
400503909Validation failedMissing or empty project list, invalid project or rule UUID, or projects not found on the site.
400503910Invariant violationAttempted to add projects to a block rule.
401401000 / 401002Missing or invalid authenticationNo authentication token provided, or token is expired or invalid.
403503923Permission deniedCaller is not a site administrator for the site.
404503915Routing rule not foundNo routing rule exists with the given ID on this site.
409503912Project already presentOne or more of the projects is already associated with this routing rule.
429429000Rate limit exceededToo many requests sent in a given time period.
500503921Unexpected server errorAn unexpected error occurred while adding projects.
For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Block Domain Blocks a domain from being used with any Bridge pool, preventing Bridge clients from that domain from connecting. Blocking is site-specific and takes precedence over pool assignments; blocked domains cannot be added to any pool. Existing connections from the domain may be terminated. This method is not available for Tableau Server. **Version**: Available in API 3.28 (Tableau Cloud March 2026) and later. Not available for Tableau Server. **License**: No additional license required. **Permissions**: Tableau Cloud site admin. **Access Scope**: `tableau:bridge_rest_api:update` For more information, see [Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm), [Permissions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm), [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), and access scopes for [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows,](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### URI PATCH /api/api-version/sites/site-luid/bridge-domain-maps/block-domain #### URI Parameter Values
api-versionThe version of the API to use. For more information, see REST API and Resource Versions.
site-luidThe LUID for the site.
#### Request Body ``` ``` ``` { "bridgeDomain": { "existingDomainName": "example.com", "isBlocked": true } } ``` #### Attribute Values
existingDomainNameRequired. The domain to block or unblock.
isBlockedSet to true to block the domain; set to false to unblock (remove from blocked list).
#### Response Code 200 #### Response Body None #### Errors
HTTP statuserror CodeConditionDetails
400409004Invalid domain name or missing isBlockedDomain must conform to valid format; isBlocked parameter is required.
401401000 / 401002Missing or invalid authenticationNo authentication token provided, or token is expired or invalid.
403403000Insufficient permissionsUser does not have Site Administrator role.
429429000Rate limit exceededToo many requests sent in a given time period.
500503905Unexpected server errorAn unexpected error occurred while blocking the domain.
For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Create Bridge Pool Creates a new Bridge pool with the specified name. The pool is created empty (no domain assignments or Bridge clients). The system assigns a UUID; use List Bridge Pools to get the pool ID after creation, then add domains and assign clients. This method is not available for Tableau Server. **Version**: Available in API 3.28 (Tableau Cloud March 2026) and later. Not available for Tableau Server. **License**: No additional license required. **Permissions**: Tableau Cloud site admin. **Access Scope**: `tableau:bridge_rest_api:create` For more information, see [Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm), [Permissions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm), [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), and access scopes for [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows,](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### URI POST /api/api-version/sites/site-luid/bridge-pools #### URI Parameter Values
api-versionThe version of the API to use. For more information, see REST API and Resource Versions.
site-luidThe LUID for the site.
#### Request Body ``` ``` ``` { "edgePool": { "pool": { "name": "Production Pool" } } } ``` #### Attribute Values
nameRequired. Display name for the pool, 1–80 characters. Must be unique within the site.
#### Response Code 201 Created #### Response Body None. The pool is created with a system-generated UUID; use List Bridge Pools to get the pool ID. #### Errors
HTTP statuserror CodeConditionDetails
400409004 / 400929Missing, empty, invalid, or duplicate pool namePool name required, 1–80 characters; must be unique on the site.
401401000 / 401002Missing or invalid authenticationNo authentication token provided, or token is expired or invalid.
403403000Insufficient permissionsUser does not have Site Administrator role.
429429000Rate limit exceededToo many requests sent in a given time period.
500503900Unexpected server errorAn unexpected error occurred while creating the pool.
For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Create Routing Rule Creates a Bridge routing rule for a site. A routing rule controls how Bridge queries for a domain are routed. An allow rule (`isBlocked=false`) routes the domain to a designated pool, optionally scoped to specific projects; a block rule (`isBlocked=true`) prevents the domain from being routed through Bridge. All routing-rule methods require Tableau Cloud site admin privileges and Bridge feature enablement for the site. This method is not available for Tableau Server. **Version**: Available in API 3.30 (Tableau Cloud October 2026) and later. Not available for Tableau Server. **License**: No additional license required. **Permissions**: Tableau Cloud site admin. **Access Scope**: `tableau:bridge_rest_api:create` For more information, see [Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm), [Permissions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm), [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), and access scopes for [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows,](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### URI POST /api/api-version/sites/site-luid/bridge-routing-rules #### URI Parameter Values
api-versionThe version of the API to use. For more information, see REST API and Resource Versions.
site-luidThe LUID for the site.
#### Request Body ``` ``` ``` { "routingRule": { "domain": "example.com", "isBlocked": false, "poolId": "ebae40a5-d7e4-4214-b3d5-b0715c627b71", "project": [ { "id": "11111111-2222-3333-4444-555555555555" }, { "id": "66666666-7777-8888-9999-000000000000" } ] } } ``` #### Attribute Values
domainRequired. The domain the rule matches, for example example.com. Both root domains and subdomains are supported.
isBlockedRequired. true creates a block rule; false creates an allow rule. The request is rejected if this attribute is omitted.
poolIdRequired for allow rules (isBlocked=false). The UUID of the target Bridge pool. Must be omitted for block rules.
projectOptional. One or more project IDs that scope an allow rule to specific projects. Each entry requires an id. Must be omitted for block rules.
#### Response Code 201 Created #### Response Body Returns the created routing rule. The request accepts only the project `id`; the response returns `id`, `name`, and `isDeleted` for each project, populated by the server. Unset fields are omitted from the response. ``` ``` ``` { "routingRule": { "id": "d9e8f7a6-b5c4-3210-fedc-ba9876543210", "domain": "example.com", "isBlocked": false, "poolId": "ebae40a5-d7e4-4214-b3d5-b0715c627b71", "poolName": "WindowsPool", "project": [ { "id": "11111111-2222-3333-4444-555555555555", "name": "Finance", "isDeleted": false } ] } } ``` #### Errors
HTTP statuserror CodeConditionDetails
400503909Validation failedMissing routingRule, missing isBlocked, blank or invalid domain, blank or invalid poolId, poolId missing for an allow rule, invalid UUID, or invalid, empty, or not-found projects.
400503910Invariant violationpoolId or project supplied for a block rule.
401401000 / 401002Missing or invalid authenticationNo authentication token provided, or token is expired or invalid.
403503923Permission deniedCaller is not a site administrator for the site.
409503911Duplicate routing ruleA routing rule already exists for this domain and project scope.
409503931Domain already blockedThe domain is already blocked by an existing block rule.
409503932Domain-only rule existsA domain-only (unscoped) allow rule already exists for this domain; at most one is allowed.
409503933Blocked domain has allow rulesThe domain being blocked still has allow rules; remove them before blocking the domain.
429429000Rate limit exceededToo many requests sent in a given time period.
500503916Unexpected server errorAn unexpected error occurred while creating the rule.
For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Delete Bridge Client Permanently removes a Bridge client from the site. This operation is irreversible; the Bridge client cannot be recovered through the API. Pool assignments are revoked and the client must be re-registered to reconnect. Data sources and scheduled refreshes using this client will be affected; consider moving to unassigned status for temporary deactivation instead of deleting. This method is not available for Tableau Server. **Version**: Available in API 3.28 (Tableau Cloud March 2026) and later. Not available for Tableau Server. **License**: No additional license required. **Permissions**: Tableau Cloud site admin. **Access Scope**: `tableau:bridge_rest_api:delete` For more information, see [Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm), [Permissions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm), [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), and access scopes for [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows,](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### URI DELETE /api/api-version/sites/site-luid/bridge-clients/bridge-client-id #### URI Parameter Values
api-versionThe version of the API to use. For more information, see REST API and Resource Versions.
site-luidThe LUID for the site.
bridge-client-idThe unique identifier for the Bridge client to delete.
#### Request Body None #### Response Code 204 No Content #### Response Body None #### Errors
HTTP statuserror CodeConditionDetails
401401000 / 401002Missing or invalid authenticationNo authentication token provided, or token is expired or invalid.
403403000Insufficient permissionsUser does not have Site Administrator role.
404503001Bridge client not foundBridge client with the specified ID does not exist on this site.
429429000Rate limit exceededToo many requests sent in a given time period.
500503003Unexpected server errorAn unexpected error occurred while deleting the Bridge client.
For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Delete Bridge Pool Permanently deletes a Bridge pool and all its associated domain mappings. The pool must have no Bridge clients assigned (move clients first). Cannot delete reserved system pools. The operation is irreversible; domain mappings are removed and the pool ID becomes invalid. This method is not available for Tableau Server. **Version**: Available in API 3.28 (Tableau Cloud March 2026) and later. Not available for Tableau Server. **License**: No additional license required. **Permissions**: Tableau Cloud site admin. **Access Scope**: `tableau:bridge_rest_api:delete` For more information, see [Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm), [Permissions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm), [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), and access scopes for [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows,](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### URI DELETE /api/api-version/sites/site-luid/bridge-pools/pool-id #### URI Parameter Values
api-versionThe version of the API to use. For more information, see REST API and Resource Versions.
site-luidThe LUID for the site.
pool-idThe unique identifier (UUID) of the pool to delete.
#### Request Body None #### Response Code 204 No Content #### Response Body None #### Errors
HTTP statuserror CodeConditionDetails
400409004Invalid pool ID or pool not foundPool ID must be valid UUID and exist on the site.
400503902System poolCannot delete reserved system pools.
401401000 / 401002Missing or invalid authenticationNo authentication token provided, or token is expired or invalid.
403403000Insufficient permissionsUser does not have Site Administrator role.
429429000Rate limit exceededToo many requests sent in a given time period.
500503902Unexpected server errorAn unexpected error occurred while deleting the pool.
For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Delete Domain Removes a domain mapping from the system. The domain is no longer associated with any pool and can be re-added later if needed. For blocked domains, deletion unblocks the domain. Deletion is immediate; existing connections may be terminated and Bridge clients from that domain lose access until the domain is re-added to a pool. This method is not available for Tableau Server. **Version**: Available in API 3.28 (Tableau Cloud March 2026) and later. Not available for Tableau Server. **License**: No additional license required. **Permissions**: Tableau Cloud site admin. **Access Scope**: `tableau:bridge_rest_api:delete` For more information, see [Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm), [Permissions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm), [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), and access scopes for [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows,](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### URI PATCH /api/api-version/sites/site-luid/bridge-domain-maps/remove-domain #### URI Parameter Values
api-versionThe version of the API to use. For more information, see REST API and Resource Versions.
site-luidThe LUID for the site.
#### Request Body ``` ``` ``` { "bridgeDomain": { "existingDomainName": "example.com" } } ``` #### Attribute Values
existingDomainNameRequired. The domain name to remove from the system.
#### Response Code 200 #### Response Body None #### Errors
HTTP statuserror CodeConditionDetails
400409004Invalid domain name or domain not foundDomain must conform to valid format and must exist in the system.
401401000 / 401002Missing or invalid authenticationNo authentication token provided, or token is expired or invalid.
403403000Insufficient permissionsUser does not have Site Administrator role.
429429000Rate limit exceededToo many requests sent in a given time period.
500503907Unexpected server errorAn unexpected error occurred while deleting the domain.
For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Delete Routing Rule Permanently deletes a Bridge routing rule identified by its ID. This method applies to both allow rules and block rules. Deletion is immediate; the domain is no longer routed (or blocked) by the removed rule. If no rule matches the ID, a 404 error is returned. This method is not available for Tableau Server. **Version**: Available in API 3.30 (Tableau Cloud October 2026) and later. Not available for Tableau Server. **License**: No additional license required. **Permissions**: Tableau Cloud site admin. **Access Scope**: `tableau:bridge_rest_api:delete` For more information, see [Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm), [Permissions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm), [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), and access scopes for [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows,](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### URI DELETE /api/api-version/sites/site-luid/bridge-routing-rules/routing-rule-id #### URI Parameter Values
api-versionThe version of the API to use. For more information, see REST API and Resource Versions.
site-luidThe LUID for the site.
routing-rule-idThe unique identifier (UUID) of the routing rule to delete.
#### Request Body None #### Response Code 204 No Content #### Response Body None #### Errors
HTTP statuserror CodeConditionDetails
400503909Validation failedThe routing-rule-id is not a valid UUID.
401401000 / 401002Missing or invalid authenticationNo authentication token provided, or token is expired or invalid.
403503923Permission deniedCaller is not a site administrator for the site.
404503915Routing rule not foundNo routing rule exists with the given ID on this site.
429429000Rate limit exceededToo many requests sent in a given time period.
500503920Unexpected server errorAn unexpected error occurred while deleting the rule.
For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Get Bridge Client Retrieves detailed information about a single Bridge client. Lookup is site-scoped. The response includes connection status, pool assignment (poolId, assignedToDefaultPool, unassigned), version, and ownership; lastStatusConnectedTime indicates when the client last connected (empty if never connected). This method is not available for Tableau Server. **Version**: Available in API 3.28 (Tableau Cloud March 2026) and later. Not available for Tableau Server. **License**: No additional license required. **Permissions**: Tableau Cloud site admin. **Access Scope**: `tableau:bridge_rest_api:read` For more information, see [Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm), [Permissions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm), [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), and access scopes for [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows,](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### URI GET /api/api-version/sites/site-luid/bridge-clients/bridge-client-id #### URI Parameter Values
api-versionThe version of the API to use. For more information, see REST API and Resource Versions.
site-luidThe LUID for the site.
bridge-client-idThe unique identifier for the Bridge client to retrieve.
#### Request Body None #### Response Code 200 #### Response Body ``` ``` ``` { "bridgeClient": { "id": "12345", "name": "Bridge-Client-1", "status": "ONLINE", "version": "2024.1.0", "poolId": "abc-123-def-456", "assignedToDefaultPool": false, "unassigned": false, "lastStatusConnectedTime": "2024-10-30T10:30:00Z", "ownerName": "John Doe", "ownerEmail": "john.doe@example.com" } } ``` #### Errors
HTTP statuserror CodeConditionDetails
401401000 / 401002Missing or invalid authenticationNo authentication token provided, or token is expired or invalid.
403403000Insufficient permissionsUser does not have Site Administrator role.
404503001Bridge client not foundBridge client with the specified ID does not exist on this site.
429429000Rate limit exceededToo many requests sent in a given time period.
500503002Unexpected server errorAn unexpected error occurred while retrieving the Bridge client.
For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Get Domain Mapping Retrieves information about all domain mappings for the site, including pool assignment and status (ALLOWED or BLOCKED). When status is ALLOWED, poolId is the pool UUID; when BLOCKED, poolId is the string "BLOCKED". URL-encode special characters in domain names in the request. This method is not available for Tableau Server. **Version**: Available in API 3.28 (Tableau Cloud March 2026) and later. Not available for Tableau Server. **License**: No additional license required. **Permissions**: Tableau Cloud site admin. **Access Scope**: `tableau:bridge_rest_api:read` For more information, see [Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm), [Permissions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm), [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), and access scopes for [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows,](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### URI GET /api/api-version/sites/site-luid/bridge-domain-maps #### URI Parameter Values
api-versionThe version of the API to use. For more information, see REST API and Resource Versions.
site-luidThe LUID for the site.
#### Request Body None #### Response Code 200 #### Response Body ``` ``` ``` { "bridgeDomain": { "domain": [ { "name": "abc.test.com", "status": "BLOCKED", "poolId": "BLOCKED" }, { "name": "*.myco.lan", "status": "ALLOWED", "poolId": "185da21c-1598-4b2f-9137-fa632e935bf1" } ] } } ``` #### Errors
HTTP statuserror CodeConditionDetails
401401000 / 401002Missing or invalid authenticationNo authentication token provided, or token is expired or invalid.
403403000Insufficient permissionsUser does not have Site Administrator role.
429429000Rate limit exceededToo many requests sent in a given time period.
500503908Unexpected server errorAn unexpected error occurred while retrieving the domain.
For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Get Routing Rule Returns a single Bridge routing rule identified by its ID. The routing-rule-id must be a valid UUID and reference a rule that exists on the specified site; a rule from another site is not returned. If no rule matches, a 404 error is returned. This method is not available for Tableau Server. **Version**: Available in API 3.30 (Tableau Cloud October 2026) and later. Not available for Tableau Server. **License**: No additional license required. **Permissions**: Tableau Cloud site admin. **Access Scope**: `tableau:bridge_rest_api:read` For more information, see [Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm), [Permissions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm), [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), and access scopes for [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows,](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### URI GET /api/api-version/sites/site-luid/bridge-routing-rules/routing-rule-id #### URI Parameter Values
api-versionThe version of the API to use. For more information, see REST API and Resource Versions.
site-luidThe LUID for the site.
routing-rule-idThe unique identifier (UUID) of the routing rule to retrieve.
#### Request Body None #### Response Code 200 #### Response Body Returns a single `routingRule`, identical in shape to the Create Routing Rule response. ``` ``` ``` { "routingRule": { "id": "d9e8f7a6-b5c4-3210-fedc-ba9876543210", "domain": "example.com", "isBlocked": false, "poolId": "ebae40a5-d7e4-4214-b3d5-b0715c627b71", "poolName": "WindowsPool", "project": [ { "id": "11111111-2222-3333-4444-555555555555", "name": "Finance", "isDeleted": false } ] } } ``` #### Errors
HTTP statuserror CodeConditionDetails
400503909Validation failedThe routing-rule-id is not a valid UUID.
401401000 / 401002Missing or invalid authenticationNo authentication token provided, or token is expired or invalid.
403503923Permission deniedCaller is not a site administrator for the site.
404503915Routing rule not foundNo routing rule exists with the given ID on this site.
429429000Rate limit exceededToo many requests sent in a given time period.
500503919Unexpected server errorAn unexpected error occurred while retrieving the rule.
For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Get Routing Rules Returns all Bridge routing rules for the site. Both allow rules and block rules are returned in a single `routingRules` list; the `isBlocked` flag distinguishes them. A site with no routing rules returns an empty `routingRules` container. Use this method to look up a rule's `id` before updating or deleting it. This method is not available for Tableau Server. **Version**: Available in API 3.30 (Tableau Cloud October 2026) and later. Not available for Tableau Server. **License**: No additional license required. **Permissions**: Tableau Cloud site admin. **Access Scope**: `tableau:bridge_rest_api:read` For more information, see [Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm), [Permissions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm), [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), and access scopes for [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows,](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### URI GET /api/api-version/sites/site-luid/bridge-routing-rules #### URI Parameter Values
api-versionThe version of the API to use. For more information, see REST API and Resource Versions.
site-luidThe LUID for the site.
#### Request Body None #### Response Code 200 #### Response Body Returns a `routingRules` list wrapping zero or more `routingRule` elements. Each `routingRule` has the same shape as the Create Routing Rule response. ``` ``` ``` { "routingRules": { "routingRule": [ { "id": "d9e8f7a6-b5c4-3210-fedc-ba9876543210", "domain": "example.com", "isBlocked": false, "poolId": "ebae40a5-d7e4-4214-b3d5-b0715c627b71", "poolName": "WindowsPool", "project": [ { "id": "11111111-2222-3333-4444-555555555555", "name": "Finance", "isDeleted": false } ] }, { "id": "aa11bb22-cc33-dd44-ee55-ff6677889900", "domain": "blocked.example.com", "isBlocked": true } ] } } ``` #### Errors
HTTP statuserror CodeConditionDetails
401401000 / 401002Missing or invalid authenticationNo authentication token provided, or token is expired or invalid.
403503923Permission deniedCaller is not a site administrator for the site.
429429000Rate limit exceededToo many requests sent in a given time period.
500503918Unexpected server errorAn unexpected error occurred while listing the rules.
For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## List Bridge Clients Retrieves a list of all Bridge clients for a specific site, with optional filtering by pool. Only one filter (poolId, onlyDefaultPool, or onlyUnassigned) can be specified at a time. Each client is in one of three states: assigned to a named pool, assigned to the default pool, or unassigned. The response includes status, pool assignment, and ownership; filtering is mutually exclusive (multiple filters return 400). This method is not available for Tableau Server. **Version**: Available in API 3.28 (Tableau Cloud March 2026) and later. Not available for Tableau Server. **License**: No additional license required. **Permissions**: Tableau Cloud site admin. **Access Scope**: `tableau:bridge_rest_api:read` For more information, see [Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm), [Permissions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm), [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), and access scopes for [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows,](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### URI All clients: GET /api/api-version/sites/site-luid/bridge-clients Filter by pool: GET /api/api-version/sites/site-luid/bridge-clients?poolId=poolId Filter by default pool: GET /api/api-version/sites/site-luid/bridge-clients?onlyDefaultPool=boolean Filter by unassigned: GET /api/api-version/sites/site-luid/bridge-clients?onlyUnassigned=boolean Only one filter can be specified at a time. Specifying multiple filters returns 400 Bad Request. #### URI Parameter Values
api-versionThe version of the API to use, such as 3.29. For more information, see REST API and Resource Versions.
site-luidThe LUID for the site.
poolIdOptional. Filter by specific pool; returns only Bridge clients assigned to this pool. Mutually exclusive with onlyDefaultPool and onlyUnassigned.
onlyDefaultPoolOptional. If true, returns only Bridge clients in the default pool. Mutually exclusive with poolId and onlyUnassigned.
onlyUnassignedOptional. If true, returns only Bridge clients not assigned to any pool. Mutually exclusive with poolId and onlyDefaultPool.
#### Request Body None #### cURL Request Example `curl "https://myco/api/3.29/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/bridge-clients" -X GET -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd"` #### Response Code 200 #### Response Body ``` ``` ``` { "bridgeClients": { "bridgeClient": [ { "id": "12345", "name": "Bridge-Client-1", "status": "ONLINE", "version": "2024.1.0", "poolId": "abc-123-def-456", "assignedToDefaultPool": false, "unassigned": false, "lastStatusConnectedTime": "2024-10-30T10:30:00Z", "ownerName": "John Doe", "ownerEmail": "john.doe@example.com" }, { "id": "67890", "name": "Bridge-Client-2", "status": "OFFLINE", "version": "2024.1.0", "poolId": null, "assignedToDefaultPool": true, "unassigned": false, "lastStatusConnectedTime": "2024-10-29T15:45:00Z", "ownerName": "Jane Smith", "ownerEmail": "jane.smith@example.com" } ] } } ``` #### Errors
HTTP statuserror CodeConditionDetails
400BAD_REQUESTMultiple filters specifiedOnly one filter parameter can be specified at a time (poolId, onlyDefaultPool, or onlyUnassigned).
400BAD_REQUESTInvalid poolIdThe poolId specified is reserved and cannot be used as a filter.
401401000 / 401002Missing or invalid authenticationNo authentication token provided, or token is expired or invalid.
403403000Insufficient permissionsUser does not have Site Administrator role.
429429000Rate limit exceededToo many requests sent in a given time period.
500503002Unexpected server errorAn unexpected error occurred while retrieving Bridge clients.
For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## List Bridge Pools Retrieves a list of all Bridge pools for the specified site, including pool details and associated domain mappings. Each pool includes its ID, display name, and domains with status ALLOWED or BLOCKED. There is no pagination; consider caching results for 5–15 minutes for large deployments. This method is not available for Tableau Server. **Version**: Available in API 3.28 (Tableau Cloud March 2026) and later. Not available for Tableau Server. **License**: No additional license required. **Permissions**: Tableau Cloud site admin. **Access Scope**: `tableau:bridge_rest_api:read` For more information, see [Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm), [Permissions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm), [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), and access scopes for [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows,](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### URI GET /api/api-version/sites/site-luid/bridge-pools #### URI Parameter Values
api-versionThe version of the API to use. For more information, see REST API and Resource Versions.
site-luidThe LUID for the site.
#### Request Body None #### Response Code 200 #### Response Body ``` ``` ``` { "edgePool": { "poolList": [ { "pool": { "id": "abc-123-def-456", "name": "Production Pool" }, "domains": { "domain": [ { "name": "example.com", "status": "ALLOWED" }, { "name": "subdomain.example.com", "status": "ALLOWED" } ] } }, { "pool": { "id": "ghi-789-jkl-012", "name": "Development Pool" }, "domains": { "domain": [ { "name": "dev.example.com", "status": "ALLOWED" } ] } } ] } } ``` #### Errors
HTTP statuserror CodeConditionDetails
401401000 / 401002Missing or invalid authenticationNo authentication token provided, or token is expired or invalid.
403403000Insufficient permissionsUser does not have Site Administrator role.
429429000Rate limit exceededToo many requests sent in a given time period.
500503903Unexpected server errorAn unexpected error occurred while retrieving pools.
For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Move Bridge Client Moves a Bridge client between pools or to unassigned status. The operation is atomic (all-or-nothing). For moveToNamedPool the pool must exist and be a valid UUID; moveToUnassigned is useful for temporarily deactivating a client without deleting it. This method is not available for Tableau Server. **Version**: Available in API 3.28 (Tableau Cloud March 2026) and later. Not available for Tableau Server. **License**: No additional license required. **Permissions**: Tableau Cloud site admin. **Access Scope**: `tableau:bridge_rest_api:update` For more information, see [Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm), [Permissions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm), [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), and access scopes for [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows,](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### URI PATCH /api/api-version/sites/site-luid/bridge-clients/bridge-client-id #### URI Parameter Values
api-versionThe version of the API to use. For more information, see REST API and Resource Versions.
site-luidThe LUID for the site.
bridge-client-idThe unique identifier for the Bridge client to move.
#### Request Body ``` ``` ``` { "bridgeClientMoveRequest": { "moveToNamedPool": { "poolId": "abc-123-def-456" } } } ``` #### Attribute Values
poolIdRequired when using moveToNamedPool. The UUID of the Bridge pool to move the client to.
moveToDefaultPoolSet to true to move the Bridge client to the default pool. Use in place of moveToNamedPool.
moveToUnassignedSet to true to move the Bridge client to unassigned status. Use in place of moveToNamedPool.
#### Response Code 204 No Content #### Response Body None #### Errors
HTTP statuserror CodeConditionDetails
400BAD_REQUESTMultiple operations specifiedCannot specify more than one move operation in a single request.
400BAD_REQUESTNo operation / Missing poolId / Invalid poolIdRequest must contain exactly one valid move operation; poolId required for moveToNamedPool and must be a valid UUID.
401401000 / 401002Missing or invalid authenticationNo authentication token provided, or token is expired or invalid.
403403000Insufficient permissionsUser does not have Site Administrator role.
404503001Bridge client not foundBridge client with the specified ID does not exist on this site.
404503005Pool not foundThe specified poolId does not exist on this site.
429429000Rate limit exceededToo many requests sent in a given time period.
500503004Unexpected server errorAn unexpected error occurred while moving the Bridge client.
For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Remove Projects from Routing Rule Removes one or more project filtering conditions from an existing allow rule, broadening the rule so it no longer applies only to those projects. This method applies to allow rules only; removing projects from a block rule is rejected. Each project ID must be a valid UUID. This method is not available for Tableau Server. **Version**: Available in API 3.30 (Tableau Cloud October 2026) and later. Not available for Tableau Server. **License**: No additional license required. **Permissions**: Tableau Cloud site admin. **Access Scope**: `tableau:bridge_rest_api:update` For more information, see [Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm), [Permissions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm), [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), and access scopes for [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows,](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### URI DELETE /api/api-version/sites/site-luid/bridge-routing-rules/routing-rule-id/projects #### URI Parameter Values
api-versionThe version of the API to use. For more information, see REST API and Resource Versions.
site-luidThe LUID for the site.
routing-rule-idThe unique identifier (UUID) of the allow rule to remove projects from.
#### Request Body ``` ``` ``` { "routingRuleProjects": { "mode": "remove", "project": [ { "id": "11111111-2222-3333-4444-555555555555" } ] } } ``` #### Attribute Values
modeRequired. The operation mode; must be remove for this method.
projectRequired. One or more project IDs to remove. Each entry requires an id.
#### Response Code 200 #### Response Body Returns the updated `routingRule` with the removed projects no longer present in `project`. ``` ``` ``` { "routingRule": { "id": "d9e8f7a6-b5c4-3210-fedc-ba9876543210", "domain": "example.com", "isBlocked": false, "poolId": "ebae40a5-d7e4-4214-b3d5-b0715c627b71", "poolName": "WindowsPool", "project": [] } } ``` #### Errors
HTTP statuserror CodeConditionDetails
400503909Validation failedMissing or empty project list, or invalid project or rule UUID.
400503910Invariant violationAttempted to remove projects from a block rule.
401401000 / 401002Missing or invalid authenticationNo authentication token provided, or token is expired or invalid.
403503923Permission deniedCaller is not a site administrator for the site.
404503915Routing rule not foundNo routing rule exists with the given ID on this site.
429429000Rate limit exceededToo many requests sent in a given time period.
500503922Unexpected server errorAn unexpected error occurred while removing projects.
For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Update Bridge Pool Updates the display name of an existing Bridge pool. The pool ID and domain/Bridge client assignments are unchanged. This method is not available for Tableau Server. **Version**: Available in API 3.28 (Tableau Cloud March 2026) and later. Not available for Tableau Server. **License**: No additional license required. **Permissions**: Tableau Cloud site admin. **Access Scope**: `tableau:bridge_rest_api:update` For more information, see [Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm), [Permissions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm), [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), and access scopes for [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows,](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### URI PATCH /api/api-version/sites/site-luid/bridge-pools/pool-id #### URI Parameter Values
api-versionThe version of the API to use. For more information, see REST API and Resource Versions.
site-luidThe LUID for the site.
pool-idThe unique identifier (UUID) of the pool to update.
#### Request Body ``` ``` ``` { "edgePool": { "pool": { "name": "Updated Production Pool" } } } ``` #### Attribute Values
nameRequired. New display name for the pool, 1–80 characters, unique on the site (excluding the current pool).
#### Response Code 200 #### Response Body None #### Errors
HTTP statuserror CodeConditionDetails
400409004 / 400929Invalid pool ID, missing name, or duplicate namePool ID must be valid UUID; name required, 1–80 characters, unique (excluding current pool).
401401000 / 401002Missing or invalid authenticationNo authentication token provided, or token is expired or invalid.
403403000Insufficient permissionsUser does not have Site Administrator role.
429429000Rate limit exceededToo many requests sent in a given time period.
500503901Unexpected server errorAn unexpected error occurred while updating the pool.
For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Update Domain Among Pools Moves a domain from its current pool to a different pool. The operation is atomic (all-or-nothing); on failure the domain mapping is unchanged. This method is not available for Tableau Server. **Version**: Available in API 3.28 (Tableau Cloud March 2026) and later. Not available for Tableau Server. **License**: No additional license required. **Permissions**: Tableau Cloud site admin. **Access Scope**: `tableau:bridge_rest_api:update` For more information, see [Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm), [Permissions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm), [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), and access scopes for [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows,](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### URI PATCH /api/api-version/sites/site-luid/bridge-domain-maps/change-pool-assignment #### URI Parameter Values
api-versionThe version of the API to use. For more information, see REST API and Resource Versions.
site-luidThe LUID for the site.
#### Request Body ``` ``` ``` { "bridgeDomain": { "existingDomainName": "example.com", "newPoolLuid": "ebae40a5-d7e4-4214-b3d5-b0715c627b71" } } ``` #### Attribute Values
existingDomainNameRequired. The domain to move.
newPoolLuidRequired. The UUID of the target Bridge pool.
#### Response Code 200 #### Response Body None #### Errors
HTTP statuserror CodeConditionDetails
400409004Invalid domain name, invalid pool ID, domain not found, or pool not foundDomain and pool ID must be valid; domain and pool must exist on the site.
401401000 / 401002Missing or invalid authenticationNo authentication token provided, or token is expired or invalid.
403403000Insufficient permissionsUser does not have Site Administrator role.
429429000Rate limit exceededToo many requests sent in a given time period.
500503906Unexpected server errorAn unexpected error occurred while updating the domain.
For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Update Domain Name Updates an existing domain mapping by renaming the domain. The operation is atomic (all-or-nothing). This method is not available for Tableau Server. **Version**: Available in API 3.28 (Tableau Cloud March 2026) and later. Not available for Tableau Server. **License**: No additional license required. **Permissions**: Tableau Cloud site admin. **Access Scope**: `tableau:bridge_rest_api:update` For more information, see [Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm), [Permissions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm), [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), and access scopes for [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows,](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### URI PATCH /api/api-version/sites/site-luid/bridge-domain-maps/update-domain-name #### URI Parameter Values
api-versionThe version of the API to use. For more information, see REST API and Resource Versions.
site-luidThe LUID for the site.
#### Request Body ``` ``` ``` { "bridgeDomain": { "existingDomainName": "existing-domain.com", "newDomainName": "new-domain.com" } } ``` #### Attribute Values
existingDomainNameRequired. The current domain name.
newDomainNameRequired. The new domain name. Must not already exist in the system.
#### Response Code 200 #### Response Body None #### Errors
HTTP statuserror CodeConditionDetails
400409004Invalid existing/new domain name, domain not found, or new name existsDomain names must conform to valid format; existing domain must exist; new name must not already be in use.
401401000 / 401002Missing or invalid authenticationNo authentication token provided, or token is expired or invalid.
403403000Insufficient permissionsUser does not have Site Administrator role.
429429000Rate limit exceededToo many requests sent in a given time period.
500503906Unexpected server errorAn unexpected error occurred while updating the domain.
For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Update Routing Rule Partially updates an existing Bridge routing rule. You can change the rule's `domain`, `poolId`, and `isBlocked` flag. At least one attribute must be supplied; only the supplied attributes are changed. Project scoping is not changed here—use the Add Projects to Routing Rule and Remove Projects from Routing Rule methods. This method is not available for Tableau Server. **Version**: Available in API 3.30 (Tableau Cloud October 2026) and later. Not available for Tableau Server. **License**: No additional license required. **Permissions**: Tableau Cloud site admin. **Access Scope**: `tableau:bridge_rest_api:update` For more information, see [Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm), [Permissions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm), [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), and access scopes for [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows,](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### URI PATCH /api/api-version/sites/site-luid/bridge-routing-rules/routing-rule-id #### URI Parameter Values
api-versionThe version of the API to use. For more information, see REST API and Resource Versions.
site-luidThe LUID for the site.
routing-rule-idThe unique identifier (UUID) of the routing rule to update.
#### Request Body ``` ``` ``` { "routingRule": { "domain": "new.example.com", "poolId": "b2c3d4e5-6f70-8192-a3b4-c5d6e7f80910" } } ``` #### Attribute Values
domainOptional. A new domain for the rule.
isBlockedOptional. Changes the rule between a block rule (true) and an allow rule (false).
poolIdRequired when transitioning to an allow rule. The UUID of the target Bridge pool. Must be omitted when the rule is, or becomes, a block rule.
#### Response Code 200 #### Response Body Returns the updated `routingRule`, identical in shape to the Create Routing Rule response. ``` ``` ``` { "routingRule": { "id": "d9e8f7a6-b5c4-3210-fedc-ba9876543210", "domain": "new.example.com", "isBlocked": false, "poolId": "b2c3d4e5-6f70-8192-a3b4-c5d6e7f80910", "poolName": "WindowsPool", "project": [ { "id": "11111111-2222-3333-4444-555555555555", "name": "Finance", "isDeleted": false } ] } } ``` #### Errors
HTTP statuserror CodeConditionDetails
400503909Validation failedEmpty update (no attributes supplied), invalid routing-rule-id or poolId UUID, blank or invalid domain, or poolId missing when transitioning to an allow rule.
400503910Invariant violationpoolId supplied while the rule is, or becomes, a block rule.
401401000 / 401002Missing or invalid authenticationNo authentication token provided, or token is expired or invalid.
403503923Permission deniedCaller is not a site administrator for the site.
404503915Routing rule not foundNo routing rule exists with the given ID on this site.
409503911Duplicate routing ruleThe update would collide with an existing rule for the same domain and project scope.
429429000Rate limit exceededToo many requests sent in a given time period.
500503917Unexpected server errorAn unexpected error occurred while updating the rule.
For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). _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 - CategoricalDomain # Interface CategoricalDomain The domain of a categorical filter interface CategoricalDomain {     [type](#type): [FilterDomainType](https://help.tableau.com/current/api/embedding_api/en-us/reference/enums/FilterDomainType.html);     [values](#values): [DataValue](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/DataValue.html)\[\]; } - Defined in packages/api-external-contract-js/src/ExternalContract/Shared/FilterInterfaces.ts:250 ##### Index ### Properties [type](#type) [values](#values) ## Properties ### `Readonly`type[](#type) type: [FilterDomainType](https://help.tableau.com/current/api/embedding_api/en-us/reference/enums/FilterDomainType.html) #### Returns[](#returns) the domain type (relevant, all) - Defined in packages/api-external-contract-js/src/ExternalContract/Shared/FilterInterfaces.ts:254 ### `Readonly`values[](#values) values: [DataValue](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/DataValue.html)\[\] #### Returns[](#returns-1) the list of values in the domain of the filter - Defined in packages/api-external-contract-js/src/ExternalContract/Shared/FilterInterfaces.ts:258 ### Settings Member Visibility - Protected - Inherited - External ThemeOSLightDark ### On This Page Properties [type](#type)[values](#values) - CategoricalFilter # Interface CategoricalFilter A Categorical Filter interface CategoricalFilter {     [appliedValues](#appliedvalues): [DataValue](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/DataValue.html)\[\];     [fieldId](#fieldid): string;     [fieldName](#fieldname): string;     [filterType](#filtertype): [FilterType](https://help.tableau.com/current/api/embedding_api/en-us/reference/enums/FilterType.html);     [isAllSelected](#isallselected)?: boolean;     [isExcludeMode](#isexcludemode): boolean;     [worksheetName](#worksheetname): string;     [getAppliedWorksheetsAsync](#getappliedworksheetsasync-1)(): Promise;     [getDomainAsync](#getdomainasync-1)(domainType?: [FilterDomainType](https://help.tableau.com/current/api/embedding_api/en-us/reference/enums/FilterDomainType.html)): Promise<[CategoricalDomain](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/CategoricalDomain.html)\>;     [getFieldAsync](#getfieldasync-1)(): Promise<[Field](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/Field.html)\>;     [setAppliedWorksheetsAsync](#setappliedworksheetsasync-1)(applyToWorksheets: string\[\]): Promise; } #### Hierarchy ([View Summary](https://help.tableau.com/current/api/embedding_api/en-us/reference/hierarchy.html#CategoricalFilter)) - [Filter](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/Filter.html) - CategoricalFilter - Defined in packages/api-external-contract-js/src/ExternalContract/Shared/FilterInterfaces.ts:65 ##### Index ### Methods [getAppliedWorksheetsAsync](#getappliedworksheetsasync) [getDomainAsync](#getdomainasync) [getFieldAsync](#getfieldasync) [setAppliedWorksheetsAsync](#setappliedworksheetsasync) ### Properties [appliedValues](#appliedvalues) [fieldId](#fieldid) [fieldName](#fieldname) [filterType](#filtertype) [isAllSelected?](#isallselected) [isExcludeMode](#isexcludemode) [worksheetName](#worksheetname) ## Methods ### getAppliedWorksheetsAsync[](#getappliedworksheetsasync) - getAppliedWorksheetsAsync(): Promise[](#getappliedworksheetsasync-1) #### Returns Promise the list of worksheet names that have the filter applied. Inherited from [Filter](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/Filter.html).[getAppliedWorksheetsAsync](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/Filter.html#getappliedworksheetsasync) - Defined in packages/api-external-contract-js/src/ExternalContract/Shared/FilterInterfaces.ts:49 ### getDomainAsync[](#getdomainasync) - getDomainAsync(domainType?: [FilterDomainType](https://help.tableau.com/current/api/embedding_api/en-us/reference/enums/FilterDomainType.html)): Promise<[CategoricalDomain](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/CategoricalDomain.html)\>[](#getdomainasync-1) #### Parameters - `Optional`domainType: [FilterDomainType](https://help.tableau.com/current/api/embedding_api/en-us/reference/enums/FilterDomainType.html) #### Returns Promise<[CategoricalDomain](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/CategoricalDomain.html)\> a promise containing the categorical domain for the filter. Note if a filter contains multiple fields (such as a filter action with multiple fields), the values array in the returned CategoricalDomain ([CategoricalDomain.values](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/CategoricalDomain.html#values)) will be empty. If there are multiple fields in the filter, the results need to be represented by a table, which is not currently supported. - Defined in packages/api-external-contract-js/src/ExternalContract/Shared/FilterInterfaces.ts:91 ### getFieldAsync[](#getfieldasync) - getFieldAsync(): Promise<[Field](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/Field.html)\>[](#getfieldasync-1) #### Returns Promise<[Field](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/Field.html)\> a promise containing the field for the filter. Inherited from [Filter](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/Filter.html).[getFieldAsync](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/Filter.html#getfieldasync) - Defined in packages/api-external-contract-js/src/ExternalContract/Shared/FilterInterfaces.ts:43 ### setAppliedWorksheetsAsync[](#setappliedworksheetsasync) - setAppliedWorksheetsAsync(applyToWorksheets: string\[\]): Promise[](#setappliedworksheetsasync-1) Applies the filter to the specified list of worksheets. If the worksheet(s) do not exist or do not contain the field in their data sources, an exception is thrown. #### Parameters - applyToWorksheets: string\[\] list of worksheets to apply the filter on #### Returns Promise the list of worksheet names that have the filter applied Inherited from [Filter](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/Filter.html).[setAppliedWorksheetsAsync](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/Filter.html#setappliedworksheetsasync) - Defined in packages/api-external-contract-js/src/ExternalContract/Shared/FilterInterfaces.ts:59 ## Properties ### `Readonly`appliedValues[](#appliedvalues) appliedValues: [DataValue](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/DataValue.html)\[\] #### Returns[](#returns) A list of values applied to this categorical filter. Notice that if this is a dependent filter, the current relavent values can be fetched by calling `getDomainAsync(tableau.FilterDomainType.Relevant)`. - Defined in packages/api-external-contract-js/src/ExternalContract/Shared/FilterInterfaces.ts:78 ### `Readonly`fieldId[](#fieldid) fieldId: string #### Returns[](#returns-1) The id of the field being filtered. Inherited from [Filter](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/Filter.html).[fieldId](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/Filter.html#fieldid) - Defined in packages/api-external-contract-js/src/ExternalContract/Shared/FilterInterfaces.ts:37 ### `Readonly`fieldName[](#fieldname) fieldName: string #### Returns[](#returns-2) The name of the field being filtered. Note that this is the caption as shown in the UI, and not the actual database field name. Inherited from [Filter](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/Filter.html).[fieldName](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/Filter.html#fieldname) - Defined in packages/api-external-contract-js/src/ExternalContract/Shared/FilterInterfaces.ts:31 ### `Readonly`filterType[](#filtertype) filterType: [FilterType](https://help.tableau.com/current/api/embedding_api/en-us/reference/enums/FilterType.html) #### Returns[](#returns-3) The type of the filter. Inherited from [Filter](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/Filter.html).[filterType](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/Filter.html#filtertype) - Defined in packages/api-external-contract-js/src/ExternalContract/Shared/FilterInterfaces.ts:25 ### `Optional` `Readonly`isAllSelected[](#isallselected) isAllSelected?: boolean #### Returns[](#returns-4) True if all the values are selected for this filter. When 'All' is selected, appliedValues returns an empty list. This field is available in Tableau 2019.2 or later - Defined in packages/api-external-contract-js/src/ExternalContract/Shared/FilterInterfaces.ts:72 ### `Readonly`isExcludeMode[](#isexcludemode) isExcludeMode: boolean #### Returns[](#returns-5) True if this filter is an exclude filter, false if an include filter. - Defined in packages/api-external-contract-js/src/ExternalContract/Shared/FilterInterfaces.ts:83 ### `Readonly`worksheetName[](#worksheetname) worksheetName: string #### Returns[](#returns-6) The parent worksheet. Inherited from [Filter](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/Filter.html).[worksheetName](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/Filter.html#worksheetname) - Defined in packages/api-external-contract-js/src/ExternalContract/Shared/FilterInterfaces.ts:20 ### Settings Member Visibility - Protected - Inherited - External ThemeOSLightDark ### On This Page Methods [getAppliedWorksheetsAsync](#getappliedworksheetsasync)[getDomainAsync](#getdomainasync)[getFieldAsync](#getfieldasync)[setAppliedWorksheetsAsync](#setappliedworksheetsasync) Properties [appliedValues](#appliedvalues)[fieldId](#fieldid)[fieldName](#fieldname)[filterType](#filtertype)[isAllSelected](#isallselected)[isExcludeMode](#isexcludemode)[worksheetName](#worksheetname) - CategoricalPulseFilter # Interface CategoricalPulseFilter A Pulse Categorical Filter interface CategoricalPulseFilter {     [appliedValues](#appliedvalues): [PulseFieldValueArray](https://help.tableau.com/current/api/embedding_api/en-us/reference/types/PulseFieldValueArray.html);     [fieldName](#fieldname): string;     [filterType](#filtertype): [FilterType](https://help.tableau.com/current/api/embedding_api/en-us/reference/enums/FilterType.html);     [getDomainAsync](#getdomainasync): (         searchTerm?: string,         pageSize?: number,         nextPageToken?: string,         domainType?: [FilterDomainType](https://help.tableau.com/current/api/embedding_api/en-us/reference/enums/FilterDomainType.html),     ) \=> Promise<[PulseCategoricalDomain](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/PulseCategoricalDomain.html)\>;     [isAllSelected](#isallselected)?: boolean;     [isExcludeMode](#isexcludemode): boolean;     [metricId](#metricid): string; } #### Hierarchy ([View Summary](https://help.tableau.com/current/api/embedding_api/en-us/reference/hierarchy.html#CategoricalPulseFilter)) - [PulseFilter](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/PulseFilter.html) - CategoricalPulseFilter - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/PulseInterfaces.ts:319 ##### Index ### Properties [appliedValues](#appliedvalues) [fieldName](#fieldname) [filterType](#filtertype) [getDomainAsync](#getdomainasync) [isAllSelected?](#isallselected) [isExcludeMode](#isexcludemode) [metricId](#metricid) ## Properties ### `Readonly`appliedValues[](#appliedvalues) appliedValues: [PulseFieldValueArray](https://help.tableau.com/current/api/embedding_api/en-us/reference/types/PulseFieldValueArray.html) A list of values applied to this categorical filter. Notice that if the Pulse metric has a definition filter, the current relevant values can be fetched by calling `getDomainAsync(FilterDomainType.Relevant)`. - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/PulseInterfaces.ts:325 ### fieldName[](#fieldname) fieldName: string The name of the field being filtered. Note that this is the caption as shown in the UI, and not the actual database field name. Inherited from [PulseFilter](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/PulseFilter.html).[fieldName](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/PulseFilter.html#fieldname) - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/PulseInterfaces.ts:303 ### filterType[](#filtertype) filterType: [FilterType](https://help.tableau.com/current/api/embedding_api/en-us/reference/enums/FilterType.html) The type of the filter. Inherited from [PulseFilter](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/PulseFilter.html).[filterType](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/PulseFilter.html#filtertype) - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/PulseInterfaces.ts:308 ### getDomainAsync[](#getdomainasync) getDomainAsync: (     searchTerm?: string,     pageSize?: number,     nextPageToken?: string,     domainType?: [FilterDomainType](https://help.tableau.com/current/api/embedding_api/en-us/reference/enums/FilterDomainType.html), ) \=> Promise<[PulseCategoricalDomain](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/PulseCategoricalDomain.html)\> Gets the domain of a categorical filter. #### Type declaration - - (     searchTerm?: string,     pageSize?: number,     nextPageToken?: string,     domainType?: [FilterDomainType](https://help.tableau.com/current/api/embedding_api/en-us/reference/enums/FilterDomainType.html), ): Promise<[PulseCategoricalDomain](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/PulseCategoricalDomain.html)\> - #### Parameters - `Optional`searchTerm: string The term to search for in the domain. - `Optional`pageSize: number The maximum number of values to return. Ignored when nextPageToken is not provided. - `Optional`nextPageToken: string The next page token returned by Pulse when additional values are available. - `Optional`domainType: [FilterDomainType](https://help.tableau.com/current/api/embedding_api/en-us/reference/enums/FilterDomainType.html) The domain type of the filter. #### Returns Promise<[PulseCategoricalDomain](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/PulseCategoricalDomain.html)\> A promise containing the categorical domain for the filter. - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/PulseInterfaces.ts:347 ### `Optional` `Readonly`isAllSelected[](#isallselected) isAllSelected?: boolean True if all the values are selected for this filter. When 'All' is selected, appliedValues returns an empty list. - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/PulseInterfaces.ts:336 ### `Readonly`isExcludeMode[](#isexcludemode) isExcludeMode: boolean True if this filter is an exclude filter, false if an include filter. - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/PulseInterfaces.ts:330 ### metricId[](#metricid) metricId: string The Pulse metric ID. Inherited from [PulseFilter](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/PulseFilter.html).[metricId](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/PulseFilter.html#metricid) - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/PulseInterfaces.ts:313 ### Settings Member Visibility - Protected - Inherited - External ThemeOSLightDark ### On This Page Properties [appliedValues](#appliedvalues)[fieldName](#fieldname)[filterType](#filtertype)[getDomainAsync](#getdomainasync)[isAllSelected](#isallselected)[isExcludeMode](#isexcludemode)[metricId](#metricid) - CategoricalValue # Type Alias CategoricalValue CategoricalValue: string | string\[\] Categorical values for selection. - Defined in packages/api-external-contract-js/src/ExternalContract/Shared/SelectionInterfaces.ts:66 ### Settings Member Visibility - Protected - Inherited - External ThemeOSLightDark _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 - ClassNameKey # Enumeration ClassNameKey - Defined in packages/api-external-contract-js/src/ExternalContract/Shared/Namespaces/Tableau.ts:25 ##### Index ### Enumeration Members [ColumnDividers](#columndividers) [DashboardTitle](#dashboardtitle) [Pane](#pane) [RowDividers](#rowdividers) [StoryTitle](#storytitle) [Tooltip](#tooltip) [Worksheet](#worksheet) [WorksheetTitle](#worksheettitle) ## Enumeration Members ### ColumnDividers[](#columndividers) ColumnDividers: "tableau-column-dividers" - Defined in packages/api-external-contract-js/src/ExternalContract/Shared/Namespaces/Tableau.ts:33 ### DashboardTitle[](#dashboardtitle) DashboardTitle: "tableau-dashboard-title" - Defined in packages/api-external-contract-js/src/ExternalContract/Shared/Namespaces/Tableau.ts:30 ### Pane[](#pane) Pane: "tableau-pane" - Defined in packages/api-external-contract-js/src/ExternalContract/Shared/Namespaces/Tableau.ts:31 ### RowDividers[](#rowdividers) RowDividers: "tableau-row-dividers" - Defined in packages/api-external-contract-js/src/ExternalContract/Shared/Namespaces/Tableau.ts:32 ### StoryTitle[](#storytitle) StoryTitle: "tableau-story-title" - Defined in packages/api-external-contract-js/src/ExternalContract/Shared/Namespaces/Tableau.ts:29 ### Tooltip[](#tooltip) Tooltip: "tableau-tooltip" - Defined in packages/api-external-contract-js/src/ExternalContract/Shared/Namespaces/Tableau.ts:28 ### Worksheet[](#worksheet) Worksheet: "tableau-worksheet" - Defined in packages/api-external-contract-js/src/ExternalContract/Shared/Namespaces/Tableau.ts:27 ### WorksheetTitle[](#worksheettitle) WorksheetTitle: "tableau-worksheet-title" - Defined in packages/api-external-contract-js/src/ExternalContract/Shared/Namespaces/Tableau.ts:26 ### Settings Member Visibility - Protected - Inherited - External ThemeOSLightDark ### On This Page Enumeration Members [ColumnDividers](#columndividers)[DashboardTitle](#dashboardtitle)[Pane](#pane)[RowDividers](#rowdividers)[StoryTitle](#storytitle)[Tooltip](#tooltip)[Worksheet](#worksheet)[WorksheetTitle](#worksheettitle) _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") [Skip to main content](#main-content) # Collections Methods Collections REST API endpoints enable you to retrieve and manipulate [Tableau collections](https://help.tableau.com/current/pro/desktop/en-us/collections.htm) programmatically. You can use a Tableau collection to make and share a list of resources. The list items don't need to be in the same project. Users that access a shared collection will only be able to see the items that they have permissions to. With collections REST methods, you can: - List all collections that the signed in user has access to. - Create a collection or delete a specified collection the signed in user has access to. - Get the details of a specified collection the signed in user has access to. - Create or delete specified items in a collection the signed in user has access to. - Update the properties of a batch of collections the signed in user has access to. - List all items of a collection that the signed in user has permissions to. - Transfer ownership of specified collections from one user to another. **Using Filters & Sort Options** When using GET methods for collections endpoints, you can use `filter` and `sort` parameters to: - Filter which collections or items are returned - Control the order in which items appear in the results Valid filter options are: `type` - The resource type of items in a collection, called `contentType` in responses. The value can be one or more comma separated types. - `ownerLuid` - The LUID of the owner. - `visibility` - The value can be `public` or `private`. If no value is provided, then both private and public collections visible to the user will be returned. A private collection is one that has not been shared and can only be seen by its owner, or a user with server or site administrator permissions. A public collection is one that has been shared and is visible to whoever it is shared with. - `createdTime` - The creation time in ISO 8601 format. - `updatedTime` - The last updated time in ISO 8601 format. - `modifiedTime` - The last updated time in ISO 8601 format. - `siteId` - The integer ID value of the site that the collection belongs to. - `favorite` - The boolean value of whether the item is marked as a favorite for the currently signed in user. - `luid` The LUID of the collection. - `title` - The title of the collection item. Use quotes for entry (i.e. `filter=name:eq:Superstore Workbook`). Valid sort options are: - `type` - The resource type of items in a collection, called `contentType` in responses. - `visibility` - The value can be `public` or `private`. If no value is provided, then both private and public collections visible to the user will be returned. A private collection is one that has not been shared and can only be seen by its owner, or a user with server or site administrator permissions. A public collection is one that has been shared and is visible to whoever it is shared with. - `createdTime` - The creation time. - `updatedTime` - The last updated time. - `modifiedTime` - The last updated time. - `title` - The title of the collection item. - `name` - The title of the collection. - `ownerName` - The name of the owner. - `position` - The custom order of the content in the collection. ## Add Collection Permissions Adds permissions to the specified collection for a user or group. You can specify multiple sets of permissions using one call. If a specified permission has already been granted or denied for a given user or group, the system ignores it. #### URI PUT /api/api-version/sites/site-id/collections/collection-id/permissions #### Parameter Values
api-versionThe version of the API to use, such as 3.29. For more information, see REST API and Resource Versions.
site-idThe ID of the site that contains the collection.
collection-idThe ID of the collection to set permissions for.
#### Request Body ``` ``` #### Attribute Values
user-id The ID of the user to add permissions for.
group-id The ID of the group to add permissions for.
capability-name

The capability to assign. The only valid capability for a collection is Read.

For more information, see Permissions.
capability-mode Allow to allow the capability, or Deny to deny it.
#### Permissions This method can be called by server administrators, site administrators, and collection owners. #### Required scope for JWT authorization _Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3)._ Authorize use of this method by including this scope in the JSON Web Token (JWT). For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), or [Access Scopes for Connected Apps](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) in the Tableau Cloud Help or [Access Scopes for Connected Apps](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) in the Tableau Server Help. ``` tableau:permissions:update ``` #### Response Code 200 #### Response Body ``` ``` #### Version Version 3.12 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors
HTTP status error Code Condition Details
400 400000 Bad request The content of the request body is missing or incomplete, or contains malformed XML.
403 403004 No permissions to set permissions. A user attempted to add permissions to a collection, but the caller doesn't have permission to set permissions on the collection.
404 404000 Resource not found The site ID in the URI wasn't found.
404 404002 User not found The user in the request body wasn't found.
404 404012 Group not found The group in the request body wasn't found.
404 404013 Resource not found

The capability to remove the permission for. The only valid capability name for a collection is Read. The only valid capability mode is Allow or Deny.
For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Delete Collection Permission Removes the specified collection permission for the specified group or user. #### URI DELETE /api/api-version/sites/site-id/collections/collection-id/permissions/groups/group-id/capability-name/capability-mode DELETE /api/api-version/sites/site-id/collections/collection-id/permissions/users/user-id/capability-name/capability-mode #### Parameter Values
api-version The version of the API to use, such as 3.29. For more information, see REST API and Resource Versions.
site-id The ID of the site that contains the collection.
collection-id The ID of the collection to remove the permission for.
group-id The ID of the group to remove the permission for.
user-id The ID of the user to remove the permission for.
capability-name

The capability to remove the permission for. The only valid capability for a collection is Read. The only valid capability mode is Allow or Deny.

For more information, see Permissions.
capability-mode Allow to delete an allow permission, or Deny to delete a deny permission. This value is case sensitive.
#### Request Body None #### Permissions This method can be called by server administrators, site administrators, and collection owners. #### Required scope for JWT authorization _Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3)._ Authorize use of this method by including this scope in the JSON Web Token (JWT). For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), or [Access Scopes for Connected Apps](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) in the Tableau Cloud Help or [Access Scopes for Connected Apps](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) in the Tableau Server Help. ``` tableau:permissions:delete ``` #### Response Code 204 #### Response Body None #### Version Version 3.12 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors
HTTP statuserror CodeConditionDetails
400400009Invalid capabilityThe capability in the URI is invalid for a collection. The only valid capability for a collection is Read.
403403004Permissions setting forbiddenA non-administrator user called this method but doesn't have permission to set permissions on the collection.
404404000Resource not foundThe site ID in the URI wasn't found.
404404002Resource not foundThe user ID in the URI wasn't found.
404404012Resource not foundThe group ID in the URI wasn't found.
404404013Resource not foundThe capability in the URI isn't recognized.
404404014Resource not foundThe user or group permission wasn't found on the collection. Check the permissions on the collection that you're trying to remove and try again.
404404038Resource not foundThe collection ID in the URI wasn't found.
405405000Invalid request methodRequest type was not DELETE.
For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## List Collection Permissions Returns a list of permissions for a specific collection. #### URI GET /api/api-version/sites/site-id/collections/collection-luid/permissions #### Parameter Values
api-versionThe version of the API to use, such as 3.29. For more information, see REST API and Resource Versions.
site-idThe ID of the site that contains the collection.
collection-idThe ID of the collection to get permissions for.
#### Request Body None #### Permissions This method can be called by server administrators, site administrators, and collection owners. #### Required scope for JWT authorization _Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3)._ Authorize use of this method by including this scope in the JSON Web Token (JWT). For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), or [Access Scopes for Connected Apps](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) in the Tableau Cloud Help or [Access Scopes for Connected Apps](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) in the Tableau Server Help. ``` tableau:permissions:read ``` #### Response Code 200 #### Response Body ``` ``` #### Version Version 3.12 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors
HTTP statuserror CodeConditionDetails
404404038Resource not foundThe collection ID in the URI wasn't found.
404404000Resource not foundThe site ID in the URI wasn't found.
For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Add items to a collection Adds items to a collection. **Version:** Available in API 3.28 (Cloud February 2026 / Server 2026.2) and later. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Tableau administrators can call this method for all sites they administer. Other users can call this method for collections that they own. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** tableau:collections:update. Added in API 3.28. [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) POST {server}/api/-/collections/{luid}/items/batchCreate [view details](#) ## Batch update collections Batch updates collections. **Version:** Available in API 3.28 (Cloud February 2026 / Server 2026.2) and later. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Tableau administrators can call this method for all sites they administer. Other users can call this method for collections that they own. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** tableau:collections:update. Added in API 3.28. [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) POST {server}/api/-/collections/batchUpdate [view details](#) ## Create a collection Creates a new collection. **Version:** Available in API 3.28 (Cloud February 2026 / Server 2026.2) and later. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Tableau administrators can call this method for all sites they administer. Other users can call this method for collections that they own. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** tableau:collections:create. Added in API 3.28. [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) POST {server}/api/-/collections [view details](#) ## Delete collections Deletes collections. **Version:** Available in API 3.28 (Cloud February 2026 / Server 2026.2) and later. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Tableau administrators can call this method for all sites they administer. Other users can call this method for collections that they own. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** tableau:collections:delete. Added in API 3.28. [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) DELETE {server}/api/-/collections [view details](#) ## Delete collections Deletes collections. **Version:** Available in API 3.28 (Cloud February 2026 / Server 2026.2) and later. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Tableau administrators can call this method for all sites they administer. Other users can call this method for collections that they own. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** tableau:collections:delete. Added in API 3.28. [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) DELETE {server}/api/-/collections/{luid} [view details](#) ## Get details of a collection Gets the details of a collection. **Version:** Available in API 3.28 (Cloud February 2026 / Server 2026.2) and later. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Tableau administrators can call this method for all sites they administer. Other users can call this method for collections that they own. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** tableau:collections:read. Added in API 3.28. [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) GET {server}/api/-/collections/{luid} [view details](#) ## List collections Lists collections. **Version:** Available in API 3.28 (Cloud February 2026 / Server 2026.2) and later. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Tableau administrators can call this method for all sites they administer. Other users can call this method for collections that they own. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** tableau:collections:read. Added in API 3.28. [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) GET {server}/api/-/collections [view details](#) ## List items in a collection Lists items in a collection. **Version:** Available in API 3.28 (Cloud February 2026 / Server 2026.2) and later. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Tableau administrators can call this method for all sites they administer. Other users can call this method for collections that they own. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** tableau:collections:read. Added in API 3.28. [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) GET {server}/api/-/collections/{luid}/items [view details](#) ## Remove items from a collection Removes items from a collection. **Version:** Available in API 3.28 (Cloud February 2026 / Server 2026.2) and later. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Tableau administrators can call this method for all sites they administer. Other users can call this method for collections that they own. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** tableau:collections: update. Added in API 3.28. [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) POST {server}/api/-/collections/{luid}/items/batchDelete [view details](#) ## Reorder items in a collection Reorders items in a collection. **Version:** Available in API 3.28 (Cloud February 2026 / Server 2026.2) and later. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Tableau administrators can call this method for all sites they administer. Other users can call this method for collections that they own. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** tableau:collections:update. Added in API 3.28. [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) PATCH {server}/api/-/collections/{luid}/orderItems [view details](#) _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.*") - Column # Interface Column interface Column {     [dataType](#datatype): [DataType](https://help.tableau.com/current/api/embedding_api/en-us/reference/enums/DataType.html);     [fieldId](#fieldid): string;     [fieldName](#fieldname): string;     [index](#index): number;     [isReferenced](#isreferenced): boolean; } - Defined in packages/api-external-contract-js/src/ExternalContract/Shared/DataTableInterfaces.ts:4 ##### Index ### Properties [dataType](#datatype) [fieldId](#fieldid) [fieldName](#fieldname) [index](#index) [isReferenced](#isreferenced) ## Properties ### `Readonly`dataType[](#datatype) dataType: [DataType](https://help.tableau.com/current/api/embedding_api/en-us/reference/enums/DataType.html) #### Returns[](#returns) The data type of the column. Possible values are float, integer, string, boolean, date, datetime and spatial - Defined in packages/api-external-contract-js/src/ExternalContract/Shared/DataTableInterfaces.ts:26 ### `Readonly`fieldId[](#fieldid) fieldId: string #### Returns[](#returns-1) The fieldId of the field in the column. In summary data, this includes the aggregation. The fieldId is not stable across replacing data sources. For example after replacing the data source \[Clipboard\_20210305T164000\].\[sum:Sales:qk\] could become \[federated.12usuoq1171o1b1ebdyh60fjnev1\].\[sum:Sales:qk\]. - Defined in packages/api-external-contract-js/src/ExternalContract/Shared/DataTableInterfaces.ts:20 ### `Readonly`fieldName[](#fieldname) fieldName: string #### Returns[](#returns-2) The name of the field in the column. In summary data, this includes the aggregation. The summary data field name is not stable across languages. For example, in an English version of Tableau, the field name might be SUM(Sales). In French, this would be SOMME(Sales). - Defined in packages/api-external-contract-js/src/ExternalContract/Shared/DataTableInterfaces.ts:10 ### `Readonly`index[](#index) index: number #### Returns[](#returns-3) The number of rows in the returned data. - Defined in packages/api-external-contract-js/src/ExternalContract/Shared/DataTableInterfaces.ts:36 ### `Readonly`isReferenced[](#isreferenced) isReferenced: boolean #### Returns[](#returns-4) Whether the column data is referenced in the visualization. - Defined in packages/api-external-contract-js/src/ExternalContract/Shared/DataTableInterfaces.ts:31 ### Settings Member Visibility - Protected - Inherited - External ThemeOSLightDark ### On This Page Properties [dataType](#datatype)[fieldId](#fieldid)[fieldName](#fieldname)[index](#index)[isReferenced](#isreferenced) _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") - [@tableau/taco-toolkit](https://help.tableau.com/current/api/webdataconnector/en-us/reference/index.html) - [handlers](https://help.tableau.com/current/api/webdataconnector/en-us/reference/modules/handlers.html) - [ColumnHeader](https://help.tableau.com/current/api/webdataconnector/en-us/reference/types/handlers.ColumnHeader.html) # Type alias ColumnHeader ColumnHeader: {     aggType?: [AggType](https://help.tableau.com/current/api/webdataconnector/en-us/reference/enums/app.AggType.html);     alias?: string;     columnRole?: [ColumnRole](https://help.tableau.com/current/api/webdataconnector/en-us/reference/enums/app.ColumnRole.html);     columnType?: [ColumnType](https://help.tableau.com/current/api/webdataconnector/en-us/reference/enums/app.ColumnType.html);     dataType: [DataType](https://help.tableau.com/current/api/webdataconnector/en-us/reference/enums/app.DataType.html);     description?: string;     filterable?: boolean;     foreignKey?: ColumnReference;     geoRole?: [GeographicRole](https://help.tableau.com/current/api/webdataconnector/en-us/reference/enums/app.GeographicRole.html);     hidden?: boolean;     id: string;     numberFormat?: [NumberFormat](https://help.tableau.com/current/api/webdataconnector/en-us/reference/enums/app.NumberFormat.html);     unitsFormat?: [UnitsFormat](https://help.tableau.com/current/api/webdataconnector/en-us/reference/enums/app.UnitsFormat.html); } The type for column metadata in a [DataTable](https://help.tableau.com/current/api/webdataconnector/en-us/reference/interfaces/handlers.DataTable.html). #### Type declaration - ##### `Optional` aggType?: [AggType](https://help.tableau.com/current/api/webdataconnector/en-us/reference/enums/app.AggType.html) - ##### `Optional` alias?: string - ##### `Optional` columnRole?: [ColumnRole](https://help.tableau.com/current/api/webdataconnector/en-us/reference/enums/app.ColumnRole.html) - ##### `Optional` columnType?: [ColumnType](https://help.tableau.com/current/api/webdataconnector/en-us/reference/enums/app.ColumnType.html) - ##### dataType: [DataType](https://help.tableau.com/current/api/webdataconnector/en-us/reference/enums/app.DataType.html) - ##### `Optional` description?: string - ##### `Optional` filterable?: boolean - ##### `Optional` foreignKey?: ColumnReference - ##### `Optional` geoRole?: [GeographicRole](https://help.tableau.com/current/api/webdataconnector/en-us/reference/enums/app.GeographicRole.html) - ##### `Optional` hidden?: boolean FYI: this is not in the WDC docs - ##### id: string - ##### `Optional` numberFormat?: [NumberFormat](https://help.tableau.com/current/api/webdataconnector/en-us/reference/enums/app.NumberFormat.html) - ##### `Optional` unitsFormat?: [UnitsFormat](https://help.tableau.com/current/api/webdataconnector/en-us/reference/enums/app.UnitsFormat.html) ### Settings #### Member Visibility - Inherited #### Theme OSLightDark Generated using [TypeDoc](https://typedoc.org/) _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.") - [@tableau/taco-toolkit](https://help.tableau.com/current/api/webdataconnector/en-us/reference/index.html) - [app](https://help.tableau.com/current/api/webdataconnector/en-us/reference/modules/app.html) - [ColumnRole](https://help.tableau.com/current/api/webdataconnector/en-us/reference/enums/app.ColumnRole.html) # Enumeration ColumnRole The role for a table column. ##### Index ### Enumeration Members [Dimension](https://help.tableau.com/current/api/webdataconnector/en-us/reference/enums/app.ColumnRole.html#Dimension) [Measure](https://help.tableau.com/current/api/webdataconnector/en-us/reference/enums/app.ColumnRole.html#Measure) ## Enumeration Members ### Dimension[](#Dimension) Dimension: "dimension" ### Measure[](#Measure) Measure: "measure" ### Settings #### Member Visibility - Inherited #### Theme OSLightDark ### On This Page - [Dimension](#Dimension) - [Measure](#Measure) Generated using [TypeDoc](https://typedoc.org/) _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.*") - [@tableau/taco-toolkit](https://help.tableau.com/current/api/webdataconnector/en-us/reference/index.html) - [app](https://help.tableau.com/current/api/webdataconnector/en-us/reference/modules/app.html) - [ColumnType](https://help.tableau.com/current/api/webdataconnector/en-us/reference/enums/app.ColumnType.html) # Enumeration ColumnType The type for a table column. ##### Index ### Enumeration Members [Continuous](https://help.tableau.com/current/api/webdataconnector/en-us/reference/enums/app.ColumnType.html#Continuous) [Discrete](https://help.tableau.com/current/api/webdataconnector/en-us/reference/enums/app.ColumnType.html#Discrete) ## Enumeration Members ### Continuous[](#Continuous) Continuous: "continuous" ### Discrete[](#Discrete) Discrete: "discrete" ### Settings #### Member Visibility - Inherited #### Theme OSLightDark ### On This Page - [Continuous](#Continuous) - [Discrete](#Discrete) Generated using [TypeDoc](https://typedoc.org/) - ColumnType # Enumeration ColumnType - Defined in packages/api-external-contract-js/src/ExternalContract/Shared/Namespaces/Tableau.ts:19 ##### Index ### Enumeration Members [Continuous](#continuous) [Discrete](#discrete) [Unknown](#unknown) ## Enumeration Members ### Continuous[](#continuous) Continuous: "continuous" - Defined in packages/api-external-contract-js/src/ExternalContract/Shared/Namespaces/Tableau.ts:21 ### Discrete[](#discrete) Discrete: "discrete" - Defined in packages/api-external-contract-js/src/ExternalContract/Shared/Namespaces/Tableau.ts:20 ### Unknown[](#unknown) Unknown: "unknown" - Defined in packages/api-external-contract-js/src/ExternalContract/Shared/Namespaces/Tableau.ts:22 ### Settings Member Visibility - Protected - Inherited - External ThemeOSLightDark ### On This Page Enumeration Members [Continuous](#continuous)[Discrete](#discrete)[Unknown](#unknown) _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 } } } } } ``` # Complete Post-Migration Tasks 🕐 _7 min read_ After a successful run of the Migration SDK, there are other tasks you must perform before you onboard your users. This topic lists these tasks. ## Step 1: Validate migrated content After your migration, there are five areas of validation to consider. You might not choose to invest in all five of these areas if your migration process can be manually validated quickly, or if you were covered in a proof-of-concept before migration. If you decide these areas are important for your organization, we have provided recommended processes to streamline those efforts. ### Did the right content migrate? - **Content validation for an individual migration run**: With the Migration SDK’s Manifest, you receive a full readout of the items migrated to Tableau Cloud in the latest migration. Review the assets listed in this file to confirm if the intended items were migrated. [Learn more about the Manifest](https://tableau.github.io/migration-sdk/api-csharp/Tableau.Migration.Engine.Manifest.html). - **Content validation across multiple runs**: If you would prefer to review all items on Tableau Cloud, you can use the Site Content data source in [Admin Insights](https://help.tableau.com/current/online/en-us/adminview_insights.htm). This data source allows you to build a custom workbook that shows all content on your Site. We’ve provided the following sample view. Note that Admin Insights data sources update daily or weekly depending on your Settings configurations. You’ll need to wait until the data updates to get the most up-to-date view on your Site Content. **Note**: Admin Insights data sources update daily or weekly depending on your Settings configurations. You must wait until the data updates to get the most up-to-date data on Viz Load Times. ![Sample view of Admin Insights Site Content data source](/tableau/current/en-us/api/migration_sdk/en-us/assets/migration-sdk-post-migration01.png) ### Is the content in the right place? - **Validating the location of an individual content item**: The easiest way to verify the location of an individual content item is to review the item path in the UI. Using the Quick Search bar or manual navigation, go to a content item. After you have navigated to a content item, you will see the navigation path displayed above the name of the item like the following example. ![Sample navigation path of a content item](/tableau/current/en-us/api/migration_sdk/en-us/assets/migration-sdk-post-migration02.png) In this case, the “Executive Overview Workbook” item is in the “Sales Leadership” Project, which is in the “Sales-Production” Project. - **Validating the location of multiple content items**: For a holistic understanding of where content is located across your Tableau Cloud Site, see [Content validation across multiple runs](#multiple-runs). ### Does the content have the right permissions? In many migrations there are changes to things like User Roles, Groups, and content location. All of these have an impact on Effective Permissions. Though it’s unlikely you will have the exact same Permission structure on Tableau Cloud that you had on Tableau Server, you can still verify Permissions in two ways. - **Validating an individual content item**: The simplest way to validate individual asset permissions is to navigate to the relevant content item in the UI. Select the ellipsis next to an asset’s name, then select **Permissions**. You can see a detailed view of the effective permissions on an item. From here you can drill down to single Users or Groups, see what Permissions have been applied and make any desired changes. ![Sample permission details for an asset](/tableau/current/en-us/api/migration_sdk/en-us/assets/migration-sdk-post-migration03.png) - **Validating permissions on multiple content items or validating all permissions that a User or Group has**: To get an aggregate view on effective permissions, use the **Permissions** data source in [Admin Insights](https://help.tableau.com/current/online/en-us/adminview_insights.htm). Use this data source to build out a custom workbook that helps you validate effective permissions in the way that is most relevant to your migration. The following is an example view that could be built out with this data to assess effective permissions. ![Sample view showing effective permissions data](/tableau/current/en-us/api/migration_sdk/en-us/assets/migration-sdk-post-migration04.png) **Note**: Admin Insights data sources update daily or weekly depending on your Settings configurations. You must wait until the data updates to get the most up-to-date data on Viz Load Times. You must wait until the data updates to get the most up-to-date view on your permissions. You will also not be able to make changes to permissions from this data source. To make a permissions change, navigate to the content item and make the change there. ### Is the data within the dashboard the same? Tableau Cloud does not support automated data validation testing in order to manage load on the multi-tenant environment. To confirm assets are working as intended, we recommend that you review a sample set of assets manually to validate content has migrated as expected. The following is the recommended approach to do so. 1. Open a view on Tableau Cloud. 2. Open the same view on Tableau Server. 3. Compare the values manually across the two views. If a view relies on a data source with Row Level Security, you must add that Row Level Security to the data source on Tableau Cloud for the data to match. See the [End-User Migration Checklist](https://help.tableau.com/current/guides/migration/en-us/cloud_migration_part7.htm) for more detail. Partners like [Wiiisdom](https://wiiisdom.com/wiiisdom-ops/tableau/) have also developed solutions that assist in data validation. For a full list of experienced migration partners, see [Experienced Tableau Cloud Migration Partners](https://www.tableau.com/solutions/tableau-migration#partners). ### Are my dashboards performing well? Tableau Cloud does not support automated performance validation testing in order to manage load on the multi-tenant environment. To understand performance benchmarks, you can use the Viz Load Times data source in [Admin Insights](https://help.tableau.com/current/online/en-us/adminview_insights.htm). Use this data source to build a custom workbook so that you can understand metrics for the content on your Tableau Cloud site. These metrics could be Average Load Time, Medium Load Time, and P95 Load Time. **Note**: Admin Insights data sources update daily or weekly depending on your Settings configurations. You must wait until the data updates to get the most up-to-date data on Viz Load Times. ## Step 2: Recreate or manually migrate all items that aren’t programmatically migrated to Tableau Cloud. Credentials embedded in a data source connection, content stored in Personal Spaces, Favorites, and User settings must be migrated by end users after they’re onboarded. For more information, see [Data not supported by the Migration SDK](https://help.tableau.com/current/api/migration_sdk/en-us/docs/planning.html#data-not-supported-by-the-migration-sdk). ## Step 3: Onboard end users If you choose to supply adjusted usernames to Tableau Cloud to avoid the site invite email notification, adjust usernames back to the correct email address at this point. Refer to the steps in the [End-User Migration Checklist](https://help.tableau.com/current/guides/migration/en-us/cloud_migration_part7.htm) to help your users migrate any remaining items. [Skip to main content](#main-content) # Concepts **Important changes for the Tableau JavaScript API** As of February 2024, the Tableau JavaScript API is deprecated. Use the Embedding API v3 instead for embedding interactive views into web pages and applications. For guidance on embedding Tableau views, see the [Tableau Embedding API v3 Help](https://help.tableau.com/current/api/embedding_api/en-us/index.html). This section provides background information about how to use the Tableau JavaScript API and how it works. ## Other articles in this section # Concepts 🕐 _2 min read_ This topic details the terms and concepts you must understand before you plan your migration from Tableau Server to Tableau Cloud. ## Content Types Content types are the various types of content that reside on Tableau Server or Tableau Cloud. For details about which content types the Migration SDK supports, see [Supported Content Types](https://help.tableau.com/current/api/migration_sdk/en-us/docs/supported_content_types.html). For unsupported content types, see [Data not supported by the Migration SDK](/current/api/migration_sdk/en-us/docs/planning.html#data-not-supported-by-the-migration-sdk). ## Migration Plan A migration plan describes how a migration should be done and what customizations must be done inflight. See [IMigrationPlan](https://tableau.github.io/migration-sdk/api-csharp/Tableau.Migration.IMigrationPlan.html) in the API Reference documentation for a list of properties and their descriptions. ## Migration Plan Builder This is the best way to build a migration plan. Calling the `Build()` method on the `IMigrationPlanBuilder` gives you a MigrationPlan. For more information, see [IMigrationPlanBuilder](https://tableau.github.io/migration-sdk/api-csharp/Tableau.Migration.IMigrationPlanBuilder.html) in the API Reference documentation for details. ## Migration Result This is the result generated after the migration has finished. It has two properties: - Migration Status: This is simply the status of the migration. See [MigrationCompletionStatus](https://tableau.github.io/migration-sdk/api-csharp/Tableau.Migration.MigrationCompletionStatus.html) enumeration in the API Reference documentation for various status items supported. - Migration Manifest: The migration manifest describes the various Tableau data items found to migrate and their migration results. See [IMigrationManifest](https://tableau.github.io/migration-sdk/api-csharp/Tableau.Migration.IMigrationManifest.html) in the API Reference documentation for details. ## Configuration Configuration can be done using the `MigrationSdkOptions`. For information about configuration items and their defaults, see [MigrationSdkOptions](https://tableau.github.io/migration-sdk/api-csharp/Tableau.Migration.Config.MigrationSdkOptions.html) in the API Reference documentation. [Skip to main content](#main-content) # Concepts This section provides background information about how to use the Tableau Server REST API and how it works. ## Other articles in this section # Configuration 🕐 _4 min read_ ## Assign API access capability To query a data source with VizQL Data Service (VDS), you must first assign the **API Access** capability in the **Permission** dialog. For information about setting up this data source capability in the Tableau user interface, see the Permission Capabilities and Templates topic in either [Tableau Cloud Help](https://help.tableau.com/current/online/en-us/permissions_capabilities.htm#capabilities) or [Tableau Server Help](https://help.tableau.com/current/server/en-us/permissions_capabilities.htm#data-sources). For information about setting up this data source capability using the REST API, see [Permissions](https://help.tableau.com/v0.0/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm). ## Workbook permissions To query a data source in a workbook with VDS, the following is required: - The workbook must be published. - The user must have **View**, **API Access**, and **Full Data Query** capabilities on the workbook. - If the workbook data source is a published datasource, the user must have **View**, **API Access**, and **Connect** capabilities on the upstream data source. For information about setting up workbook permissions, see the Permission Capabilities and Templates topic in either [Tableau Cloud Help](https://help.tableau.com/current/online/en-us/permissions_capabilities.htm#capabilities) or [Tableau Server Help](https://help.tableau.com/current/server/en-us/permissions_capabilities.htm#data-sources). ## Configure authentication VDS requires that you send an authentication token with each request. 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 Tableau REST API Sign In method, in one of three ways. ### Sign in using a personal access token (PAT) To sign in using a PAT, see [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) If you use a JWT, set the scope (scp) in the JWT to `tableau:viz_data_service:read`. The permissions of the user in the JWT determine query results. See [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 VDS. ### Sign in using username and password See [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 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) in the Tableau REST API Help. ## Find the data source LUID To run a VDS method, you must know the locally unique identifier (LUID) of the published data source you’re requesting information about. There are two options for finding the data source LUID. ### Option 1: Get the LUID using Tableau Cloud or Tableau Server 1. In the Tableau navigation menu, select **Explore**. 2. At the top of the **Explore** screen, select **All Data Sources** in the dropdown menu. 3. In the list of data sources, select the data source you want the LUID for. 4. On the data source page, select the **Details** icon (![Details icon](/tableau/current/en-us/api/vizql-data-service/en-us/assets/data_prep_info_active.svg)) next to the data source name. The LUID is at the bottom of the Data Source Details screen. ![Tableau Data Source Details screen with the data source LUID emphasized](/tableau/current/en-us/api/vizql-data-service/en-us/assets/data-source-details01.jpg) ### Option 2: Get the LUID using the Tableau REST API Use the [Query Data Sources](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_data_sources.htm#query_data_sources) method to return a list of data sources on your site. This method returns the official data source name in the `contentURL` attribute. The associated `id` of the `contentURL` is your data source LUID. ## Find the workbook session ID and workbook data source ID A workbook data source is any data source that exists a inside a Tableau workbook. A workbook data source could include an embedded data source, or the published data source that the workbook is connected to. If the workbook is connected to a published data source, and the user makes edits to that published data source inside the workbook, those edits are available as part of the workbook data source. To call a VDS method in an interactive session with a workbook on Tableau Server or Tableau Online, you must know the workbook session ID and the ID of the data source you’re requesting information about. ### Get the session ID and data source ID using the Tableau Embedding API If you are embedding a Tableau Viz and also running queries using the VizQL Data Services API, you can programmatically get the session ID using the [Tableau Embedding API](https://help.tableau.com/current/api/embedding_api/en-us/index.html) method, `getVizQLDataServiceSessionInfo()`. For example, the following code snippet shows a method that takes a Tableau `viz` object and extracts the session ID (`vizqlServerSessionId`) and the global session header (`globalSessionHeader`). The global session header is needed if you are using Tableau Cloud. These values correspond to the `X-Session-Id` and the `Global-Session-Header` headers that you need to send when you query workbook data sources. ``` let vizqlServerSessionId = ''; let globalSessionHeader = ''; const getVizQLDataServiceSessionInfo = (viz) => { vizqlServerSessionId = viz.getVizQLDataServiceSessionInfo().vizqlServerSessionId; console.log('vizQLServerSessionId:' + viz.getVizQLDataServiceSessionInfo().vizqlServerSessionId); globalSessionHeader = viz.getVizQLDataServiceSessionInfo().globalSessionHeader; console.log('globalSessionHeader:' + viz.getVizQLDataServiceSessionInfo().globalSessionHeader); }; ``` You can get the workbook data source IDs associated with the worksheet(s) in the viz. This example code snippet shows a method that gets the data source ID for a specific worksheet in a workbook. This workbook data source value is captured in the `datasourceInternalName` variable. This is the value that you use in a VDS call for `workbookDatasourceId`. ``` let datasourceInternalName = ''; const getDataSourceInternalName = async (viz) => { console.log(`Logging datasourceInternalName for worksheet for ${viz.workbook.name}...`); try { const salesSheet = viz.workbook.activeSheet.worksheets.find(sheet => sheet.name === 'Sale Map'); const dataSources = await salesSheet.getDataSourcesAsync(); datasourceInternalName = dataSources[0].id; console.log(`datasourceInternalName is:${datasourceInternalName}`); } catch (error) { console.log('Error fetching datasource:', error); } }; ``` After you’ve found the session ID, the global session header (Tableau Cloud only), and the workbook data source ID, you can call VDS. The following example shows how you include the session ID (`X-Session-Id`) and global session header (`Global-Session-Header`) in a JavaScript Fetch() API to query the workbook data source. The values `vizqlServerSessionId`, `globalSessionHeader`, and `datasourceInternalName` were obtained in the preceding Embedding API examples. ``` // set the VDS_BASE_PATH that corresponds to your Tableau instance const VDS_QUERY_DATASOURCE = '/query-datasource'; async function callVizQLDataService() { try { const res = await fetch(VDS_QUERY_DATASOURCE, { method: 'POST', credentials: 'include', headers: { 'Content-Type': 'application/json', 'X-Session-Id': vizqlServerSessionId, 'Global-Session-Header': globalSessionHeader }, body: JSON.stringify({ datasource: { workbookDatasourceId: datasourceInternalName, }, query: { fields: [ { fieldCaption: "Category" }, { fieldCaption: "Sales", function: "SUM" } ] } }), }); } catch (err) { console.error("Request failed."); } } ``` * * * The following shows a complete listing of a web page that embeds a Tableau viz and extracts the session and workbook data source ID. ``` Simple getSessionInfo ``` # Configure Embedding Objects and Components The Embedding API v3 provides a rich set of properties that you can apply to the embedding view or embedded web authoring view. These properties can control the device layout and dimensions of the view, or whether the buttons and the toolbar are hidden or visible. You can set properties during initialization, or later interactively, by accessing the JavaScript `TableauViz` or `TableauAuthoringViz` object. * * * ## How to configure the `TableauViz` and `TableauAuthoringViz` objects and components To configure the embedded viz, you can use a set of HTML attributes on the `` and `` web components, or as JavaScript (JS) properties on the corresponding `TableauViz` and `TableauAuthoringViz` JavaScript objects. For HTML attributes that accept a value, such as `width`, `height`, and `device`, the syntax is `=""`. For Boolean properties, such as `hide-tabs`, `hide-close-button`, or `disable-url-actions`, you can either include the flag to effectively set it to true, or omit it to effectively set it to false. The values of Boolean properties are ignored. For example, if you were to add `hide-tabs="false"`, this flag actually sets the `hide-tabs` value to true, because the presence of the attribute sets it to true even if the value is false. Some attributes and properties apply to both embedded views and embedded authoring views. ### Example `tableau-viz` component configurations The following example shows how you can specify options to initialize the viz by setting attributes on the `` element: ```HTML ``` ### Example `tableau-authoring-viz` component configuration The following example shows how you can specify options to initialize the viz by setting attributes on the `` element: ```HTML ``` ## Table of properties and values for embedded objects and components The following table lists the properties you can add to the `` and `` web components, or as JavaScript (JS) properties on the corresponding `TableauViz` and `TableauAuthoringViz` JavaScript objects. | HTML Property | JS Property | Accepted Values | Description | Applies to | | --- | --- | --- | --- | --- | | src | Viz.src | string | Specifies the URL of the view. For security, always use HTTPS when you specify the URL. | ``, `` | | hide-tabs | Viz.hideTabs | boolean | Indicates whether the tabs are hidden or shown. | `` | | toolbar | Viz.toolbar | “top”, “bottom”, “hidden” | Indicates the position of the toolbar or if it should be hidden | `` | | height | Viz.height | (e.g. “800px”) | Can be any valid CSS size specifier. If not specified, defaults to the published height of the view. See [Size of the embedded view](#size-of-the-embedded-view). | ``, `` | | width | Viz.width | (e.g. “800px”) | Can be any valid CSS size specifier. If not specified, defaults to the published width of the view. See [Size of the embedded view](#size-of-the-embedded-view). | ``, `` | | device | Viz.device | “default”, “desktop”, “tablet”, or “phone” | Specifies a device layout for a dashboard, if it exists. If not specified, defaults to loading a layout based on the smallest dimension of the hosting `iframe` element. | `` | | instance-id-to-clone | Viz.instanceIdToClone |   | Specifies the ID of an existing instance to make a copy (clone) of. This is useful if the user wants to continue analysis of an existing visualization without losing the state of the original. If the ID doesn’t refer to an existing visualization, the cloned version is derived from the original visualization. | `` | | disable-url-actions | Viz.disableUrlActions | boolean | Indicates whether to suppress the execution of URL actions. This option doesn’t prevent the URL action event from being raised. | `` | | hide-close-button | Viz.hideCloseButton | boolean | Indicates whether the **Close** button is shown or hidden. If not specified, defaults to `false` (the button is shown). This property also includes the “File/Close” menu item. | `` | | hide-edit-button | Viz.hideEditButton | boolean | Indicates whether the **Edit** button is shown or hidden. If not specified, defaults to `false` (the button is shown). | `` | | hide-edit-in-desktop-button | Viz.hideEditInDesktopButton | boolean | Indicates whether the **Edit in Desktop** button is shown or hidden. If not specified, defaults to `false` (the button is shown). | ``, `` | | iframe attributes |   |   | See [iframe attributes](#add-iframe-attributes). | ``, ``, `` | | suppress-default-edit-behavior | Viz.suppressDefaultEditBehavior | boolean | Indicates whether the default edit behavior should be suppressed. If not specified, defaults to `false` (the default edit behavior is preserved). When set to true, this property suppresses what is normally done when the **Close** button, **Edit** button, or **Edit in Desktop** buttons are clicked. | ``, `` | | token | Viz.token | JSON Web Token | Holds the credentials and permissions. Only used for connected apps or external authorization services (EAS). See [Authentication and Embedded Views](/current/api/embedding_api/en-us/docs/embedding_api_auth.html). Not used for passwords or personal access tokens. | ``, ``, `` | > _Note:_ When adding properties to the `` or `` components, use the HTML Property name. Use the JS Property names for the `TableauViz` and `TableauAuthoringViz` objects. * * * ### Filter element for the `tableau-viz` web component In addition to the attributes shown in the table for the web components, you can also apply a `` element to the `` web component to filter the view during initialization. The `` element has two attributes: the `field` and its `value`. ``` ``` For more information about applying filters, see [Filter during initialization](/current/api/embedding_api/en-us/docs/embedding_api_filter.html#filtering-during-initialization). ### Parameter element for the `tableau-viz` web component In addition to the attributes shown in the table for the `` web component, you can also apply a `` element to the web component during initialization. The `` element has two attributes: the `name` and its `value`. ``` ``` The parameter settings take effect at startup. Also, the Embedding API v3 library supports the methods `Workbook.getParametersAsync()` and `Workbook.changeParameterValueAsync()`. For more information, see \[Use Parameters in Embedded V `and` \` web components In addition to the attributes shown in the table for the `` and `` web components, you can also apply a `` element to the web component during initialization. The `` element allows you to pass parameters to the viz that aren’t supported by the Embedding API, but are supported in Tableau. The `` has two attributes: the `name` and its `value`. The parameter settings take effect at startup. The custom parameters can be used to add URL parameters, as listed under [Embed Code Parameters for Views](https://help.tableau.com/current/pro/desktop/en-us/embed_list.htm#URL_params) for prior versions of embedding. For example, you could use custom parameters to suppress tooltips (`:tooltip`), or to hide the Share (`:showShareOptions`) or Data Details (`:dataDetails`) buttons in the toolbar. Some of these URL parameters might not work, or might not be supported in the future. ``` ``` For more information, see [About custom parameters](/current/api/embedding_api/en-us/docs/embedding_api_parameters.html#about-custom-parameters). **Note:** The attributes you place on the web component or viz object on the client are made available to the browser in order to render the embedded visualization. These attributes don't affect security. Tableau secures content by way of authentication and user permissions. If a user can't be authenticated and doesn't have the correct permissions the content is inaccessible behind a login screen. * * * ### Add `iframe` attributes The Tableau Embedding API provides some attributes that you can apply to the iframe element. You can use these attributes to customize the border that surrounds the Tableau view. You can also specify when the content of the iframe is loaded, to improve page load times and responsiveness. | HTML Property | JS Property | Accepted Values | Description | Applies to | | --- | --- | --- | --- | --- | | iframe-attribute-class | Viz.iframeAttributeClass | string | The value of the ‘class’ attribute of the embedded iframe providing access to any custom selectors defined in the `` child tag. See [`iframe-attr-class`](/current/api/embedding_api/en-us/reference/interfaces/Viz.html#iframeattributeclass). | ``, ``, `` | | iframe-attr-loading | Viz.iframeAttributeLoading | string | Specifies the loading attribute of the embedded `