Skip to content

openapi-client

Open API specification for Tableau Services APIs

The openapi_client package is automatically generated by the OpenAPI Generator project:

  • API version: latest
  • Package version: 1.0.0
  • Generator version: 7.9.0
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.7+

Installation & Usage

This python library package is generated without supporting files like setup.py or requirements files

To be able to use it, you will need these dependencies in your own package that uses this library:

  • urllib3 >= 1.25.3, < 3.0.0
  • python-dateutil >= 2.8.2
  • pydantic >= 2
  • typing-extensions >= 4.7.1

Getting Started

In your own code, to use this library to connect and interact with openapi-client, you can run the following:

import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "http://localhost"
)



# Enter a context with an instance of the API client
with openapi_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = openapi_client.AskDataLensesApi(api_client)
    x_tableau_auth = 'x_tableau_auth_example' # str |  (optional)
    tableau_nlp_lens_publicrest_v1_create_lens_request = openapi_client.TableauNlpLensPublicrestV1CreateLensRequest() # TableauNlpLensPublicrestV1CreateLensRequest |  (optional)

    try:
        # Create a lens
        api_response = api_instance.lens_service_create_lens(x_tableau_auth=x_tableau_auth, tableau_nlp_lens_publicrest_v1_create_lens_request=tableau_nlp_lens_publicrest_v1_create_lens_request)
        print("The response of AskDataLensesApi->lens_service_create_lens:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AskDataLensesApi->lens_service_create_lens: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost

Class Method HTTP request Description
AskDataLensesApi lens_service_create_lens POST /api/-/askdata/lenses Create a lens
AskDataLensesApi lens_service_delete_lens DELETE /api/-/askdata/lenses/{lens_id} Delete a lens
AskDataLensesApi lens_service_get_lens GET /api/-/askdata/lenses/{lens_id} Get ask data lens details
AskDataLensesApi lens_service_import_lens POST /api/-/askdata/lenses/import Import a lens
AskDataLensesApi lens_service_list_lenses GET /api/-/askdata/lenses Get ask data lens list
AuthConfigurationsApi authn_service_delete_auth_configuration DELETE /api/-/authn-service/auth-configurations/{id} Delete Authentication Configuration
AuthConfigurationsApi authn_service_list_auth_configurations GET /api/-/authn-service/auth-configurations/ List Authentication Configurations
AuthConfigurationsApi authn_service_register_auth_configuration POST /api/-/authn-service/auth-configurations/ Create Authentication Configuration
AuthConfigurationsApi authn_service_update_auth_configuration PUT /api/-/authn-service/auth-configurations/{id} Update Authentication Configuration
CustomDomainsApi custom_domains_service_create_site_custom_domain_settings POST /api/-/customdomains/settings/site/{site_luid} Create custom domain settings
CustomDomainsApi custom_domains_service_delete_site_custom_domain_settings DELETE /api/-/customdomains/settings/site/{site_luid} Delete custom domain settings
CustomDomainsApi custom_domains_service_get_site_custom_domain GET /api/-/customdomains/site/{site_luid} Get Custom Domain Name
CustomDomainsApi custom_domains_service_get_site_custom_domain_settings GET /api/-/customdomains/settings/site/{site_luid} Get custom domain settings
CustomDomainsApi custom_domains_service_update_site_custom_domain_settings PUT /api/-/customdomains/settings/site/{site_luid} Update custom domain settings
DefinitionPermissionsApi permission_service_add_definition_permissions POST /api/-/pulse/definitions/{definition_id}/permissions:add Add definition permission records to the definition specified by the id.
DefinitionPermissionsApi permission_service_delete_definition_permissions POST /api/-/pulse/definitions/{definition_id}/permissions:delete Delete definition permission records from the definition specified by the id.
DefinitionPermissionsApi permission_service_get_definition_permissions GET /api/-/pulse/definitions/{definition_id}/permissions Get definition permission records for the definition specified by the id.
DefinitionPermissionsApi permission_service_has_effective_permissions GET /api/-/pulse/definitions/{definition_id}/permissions:hasEffectivePermissions Based on the site role and other rules get the effective permissions of the current user
EventStreamApi event_service_publish POST /api/-/eventservice/events Publish a Pulse event.
EventStreamApi event_service_publish_ui_event POST /api/-/eventservice/publishUIEvent Publish a UI event.
IdentityPoolApi authn_service_delete_identity_pool DELETE /api/-/authn-service/identity-pools/{uuid} Delete Identity Pool
IdentityPoolApi authn_service_find_identity_pool_by_uuid GET /api/-/authn-service/identity-pools/{uuid} Get Identity Pool
IdentityPoolApi authn_service_list_identity_pools GET /api/-/authn-service/identity-pools/ List Identity Pools
IdentityPoolApi authn_service_register_identity_pool POST /api/-/authn-service/identity-pools/ Create Identity Pool
IdentityPoolApi authn_service_update_identity_pool PUT /api/-/authn-service/identity-pools/{uuid} Update Identity Pool
IdentityStoreApi authn_service_delete_identity_store_tag DELETE /api/-/authn-service/identity-stores/{id} Delete Identity Store
IdentityStoreApi authn_service_list_identity_stores_tag GET /api/-/authn-service/identity-stores/ List Identity Stores
IdentityStoreApi authn_service_register_identity_store_tag POST /api/-/authn-service/identity-stores/ Configure Identity Store
MetricDefinitionsApi metric_query_service_batch_get_definitions GET /api/-/pulse/definitions:batchGet Gets a batch of definition and metrics available on a server.
MetricDefinitionsApi metric_query_service_batch_get_definitions_by_post POST /api/-/pulse/definitions:batchGet Gets a batch of definition and metrics available on a server.
MetricDefinitionsApi metric_query_service_batch_get_metrics GET /api/-/pulse/metrics:batchGet Gets a batch of metrics available on a server.
MetricDefinitionsApi metric_query_service_create_definition POST /api/-/pulse/definitions Creates a metric definition.
MetricDefinitionsApi metric_query_service_create_metric POST /api/-/pulse/metrics Creates a metric.
MetricDefinitionsApi metric_query_service_delete_definition DELETE /api/-/pulse/definitions/{definition_id} Deletes a metric definition.
MetricDefinitionsApi metric_query_service_delete_metric DELETE /api/-/pulse/metrics/{metric_id} Deletes a metric.
MetricDefinitionsApi metric_query_service_get_definition GET /api/-/pulse/definitions/{definition_id} Gets a metric definition based on the specified id.
MetricDefinitionsApi metric_query_service_get_metric GET /api/-/pulse/metrics/{metric_id} Gets the metric by ID.
MetricDefinitionsApi metric_query_service_get_or_create_metric POST /api/-/pulse/metrics:getOrCreate Creates a metric and returns boolean indicating whether the new metric was created or not.
MetricDefinitionsApi metric_query_service_list_definitions GET /api/-/pulse/definitions Lists the definitions available on a server.
MetricDefinitionsApi metric_query_service_list_metrics GET /api/-/pulse/definitions/{definition_id}/metrics Lists the metrics available on a server.
MetricDefinitionsApi metric_query_service_update_definition PATCH /api/-/pulse/definitions/{definition_id} Updates a metric definition.
MetricDefinitionsApi metric_query_service_update_metric PATCH /api/-/pulse/metrics/{metric_id} Updates a metric.
MetricDefinitionsApi pulse_subscription_service_list_followed_metrics_groups GET /api/-/pulse/metrics:followedMetricsGroups List followed metrics groups
MetricInsightsApi pulse_insights_service_generate_insight_bundle_ban POST /api/-/pulse/insights/ban Generates a BAN insight bundle.
MetricInsightsApi pulse_insights_service_generate_insight_bundle_detail POST /api/-/pulse/insights/detail Generates a detail insight bundle.
MetricInsightsApi pulse_insights_service_generate_insight_bundle_springboard POST /api/-/pulse/insights/springboard Generates a springboard insight bundle.
MetricQueryApi metric_query_service_get_entitlements GET /api/-/pulse/entitlements Get site entitlements
SettingsApi analytics_extensions_service_add_analytics_extensions_connection POST /api/-/settings/site/extensions/analytics/connections Add analytics extension connection to site
SettingsApi analytics_extensions_service_delete_analytics_extensions_connection DELETE /api/-/settings/site/extensions/analytics/connections/{connection_luid} Delete analytics extension connection from site
SettingsApi analytics_extensions_service_delete_connection_from_workbook DELETE /api/-/settings/site/extensions/analytics/workbooks/{workbook_luid}/selected_connection Remove current analytics extension connection for workbook
SettingsApi analytics_extensions_service_get_analytics_extensions_connection GET /api/-/settings/site/extensions/analytics/connections/{connection_luid} Get analytics extension details
SettingsApi analytics_extensions_service_get_analytics_extensions_connections GET /api/-/settings/site/extensions/analytics/connections List analytics extension connections on site
SettingsApi analytics_extensions_service_get_analytics_extensions_server_settings GET /api/-/settings/server/extensions/analytics Get enabled state of analytics extensions on server
SettingsApi analytics_extensions_service_get_analytics_extensions_site_settings GET /api/-/settings/site/extensions/analytics Get enabled state of analytics extensions on site
SettingsApi analytics_extensions_service_get_connection_options_for_workbook GET /api/-/settings/site/extensions/analytics/workbooks/{workbook_luid}/connections List analytics extension connections of workbook
SettingsApi analytics_extensions_service_get_selected_connection_for_workbook GET /api/-/settings/site/extensions/analytics/workbooks/{workbook_luid}/selected_connection Get current analytics extension for workbook
SettingsApi analytics_extensions_service_update_analytics_extensions_connection PUT /api/-/settings/site/extensions/analytics/connections/{connection_luid} Update analytics extension connection of site
SettingsApi analytics_extensions_service_update_analytics_extensions_server_settings PUT /api/-/settings/server/extensions/analytics Enable/disable analytics extensions on server
SettingsApi analytics_extensions_service_update_analytics_extensions_site_settings PUT /api/-/settings/site/extensions/analytics Update enabled state of analytics extensions on site
SettingsApi analytics_extensions_service_update_workbook_with_connection PUT /api/-/settings/site/extensions/analytics/workbooks/{workbook_luid}/selected_connection Update analytics extension for workbook
SubscriptionsApi pulse_subscription_service_batch_create_subscriptions POST /api/-/pulse/subscriptions:batchCreate Creates multiple subscriptions.
SubscriptionsApi pulse_subscription_service_batch_get_metric_follower_counts GET /api/-/pulse/subscriptions:batchGetMetricFollowerCounts Gets the total number of unique followers per metric
SubscriptionsApi pulse_subscription_service_batch_get_subscriptions GET /api/-/pulse/subscriptions:batchGet Gets a batch of subscriptions available on a server.
SubscriptionsApi pulse_subscription_service_create_subscription POST /api/-/pulse/subscriptions Creates a subscription.
SubscriptionsApi pulse_subscription_service_delete_subscription DELETE /api/-/pulse/subscriptions/{id} Deletes a subscription.
SubscriptionsApi pulse_subscription_service_get_subscription GET /api/-/pulse/subscriptions/{id} Gets a subscription based on the specified id.
SubscriptionsApi pulse_subscription_service_get_user_digest_preferences GET /api/-/pulse/user/digestpreferences Get user digest preferences
SubscriptionsApi pulse_subscription_service_get_user_preferences GET /api/-/pulse/user/preferences Get user preferences
SubscriptionsApi pulse_subscription_service_list_subscriptions GET /api/-/pulse/subscriptions Lists the subscriptions available on a server.
SubscriptionsApi pulse_subscription_service_update_subscription PATCH /api/-/pulse/subscriptions/{id} Updates a subscription.
SubscriptionsApi pulse_subscription_service_update_user_digest_preferences PATCH /api/-/pulse/user/digestpreferences Update user digest preferences
SubscriptionsApi pulse_subscription_service_update_user_preferences PATCH /api/-/pulse/user/preferences Update user preferences
UsageStatisticsApi usage_stats_service_batch_get_usage POST /api/-/content/usage-stats Get batch usage statistics
UsageStatisticsApi usage_stats_service_get_usage_stats GET /api/-/content/usage-stats/{type}/{luid} Get usage statistics for content item

Documentation For Models

Documentation For Authorization

Endpoints do not require authorization.

Author