Skip to main content

OpenAPI definition

Project description

gooddata-api-client

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

This Python package is automatically generated by the OpenAPI Generator project:

  • API version: v0
  • Package version: 1.3.1.dev4
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python >=3.6

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import gooddata_api_client

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import gooddata_api_client

Getting Started

Please follow the installation procedure and then run the following:

import time
import gooddata_api_client
from pprint import pprint
from gooddata_api_client.api import api_tokens_api
from gooddata_api_client.model.json_api_api_token_in_document import JsonApiApiTokenInDocument
from gooddata_api_client.model.json_api_api_token_out_document import JsonApiApiTokenOutDocument
from gooddata_api_client.model.json_api_api_token_out_list import JsonApiApiTokenOutList
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = gooddata_api_client.Configuration(
    host = "http://localhost"
)



# Enter a context with an instance of the API client
with gooddata_api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = api_tokens_api.APITokensApi(api_client)
    user_id = "userId_example" # str | 
    json_api_api_token_in_document = JsonApiApiTokenInDocument(
        data=JsonApiApiTokenIn(
            id="id1",
            type="apiToken",
        ),
    ) # JsonApiApiTokenInDocument | 

    try:
        api_response = api_instance.create_entity_api_tokens(user_id, json_api_api_token_in_document)
        pprint(api_response)
    except gooddata_api_client.ApiException as e:
        print("Exception when calling APITokensApi->create_entity_api_tokens: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost

Class Method HTTP request Description
APITokensApi create_entity_api_tokens POST /api/v1/entities/users/{userId}/apiTokens
APITokensApi delete_entity_api_tokens DELETE /api/v1/entities/users/{userId}/apiTokens/{id}
APITokensApi get_all_entities_api_tokens GET /api/v1/entities/users/{userId}/apiTokens List all api tokens for a user
APITokensApi get_entity_api_tokens GET /api/v1/entities/users/{userId}/apiTokens/{id}
APITokensApi update_entity_api_tokens PUT /api/v1/entities/users/{userId}/apiTokens/{id}
AnalyticsModelApi get_analytics_model GET /api/v1/layout/workspaces/{workspaceId}/analyticsModel Get analytics model
AnalyticsModelApi set_analytics_model PUT /api/v1/layout/workspaces/{workspaceId}/analyticsModel Set analytics model
AppearanceApi create_entity_color_palettes POST /api/v1/entities/colorPalettes
AppearanceApi create_entity_themes POST /api/v1/entities/themes
AppearanceApi delete_entity_color_palettes DELETE /api/v1/entities/colorPalettes/{id}
AppearanceApi delete_entity_themes DELETE /api/v1/entities/themes/{id}
AppearanceApi get_all_entities_color_palettes GET /api/v1/entities/colorPalettes
AppearanceApi get_all_entities_themes GET /api/v1/entities/themes
AppearanceApi get_entity_color_palettes GET /api/v1/entities/colorPalettes/{id}
AppearanceApi get_entity_themes GET /api/v1/entities/themes/{id}
AppearanceApi patch_entity_color_palettes PATCH /api/v1/entities/colorPalettes/{id}
AppearanceApi patch_entity_themes PATCH /api/v1/entities/themes/{id}
AppearanceApi update_entity_color_palettes PUT /api/v1/entities/colorPalettes/{id}
AppearanceApi update_entity_themes PUT /api/v1/entities/themes/{id}
AttributesApi get_all_entities_attributes GET /api/v1/entities/workspaces/{workspaceId}/attributes
AttributesApi get_entity_attributes GET /api/v1/entities/workspaces/{workspaceId}/attributes/{objectId}
AvailableDriversApi get_data_source_drivers GET /api/v1/options/availableDrivers Get all available data source drivers
CSPDirectivesApi create_entity_csp_directives POST /api/v1/entities/cspDirectives
CSPDirectivesApi delete_entity_csp_directives DELETE /api/v1/entities/cspDirectives/{id}
CSPDirectivesApi get_all_entities_csp_directives GET /api/v1/entities/cspDirectives
CSPDirectivesApi get_entity_csp_directives GET /api/v1/entities/cspDirectives/{id}
CSPDirectivesApi patch_entity_csp_directives PATCH /api/v1/entities/cspDirectives/{id}
CSPDirectivesApi update_entity_csp_directives PUT /api/v1/entities/cspDirectives/{id}
ComputationApi compute_label_elements_post POST /api/v1/actions/workspaces/{workspaceId}/execution/collectLabelElements Listing of label values. The resulting data are limited by the static platform limit to the maximum of 10000 rows.
ComputationApi compute_report POST /api/v1/actions/workspaces/{workspaceId}/execution/afm/execute Executes analytical request and returns link to the result
ComputationApi compute_valid_objects POST /api/v1/actions/workspaces/{workspaceId}/execution/afm/computeValidObjects Valid objects
ComputationApi create_tabular_export POST /api/v1/actions/workspaces/{workspaceId}/export/tabular Create tabular export request
ComputationApi explain_afm POST /api/v1/actions/workspaces/{workspaceId}/execution/afm/explain AFM explain resource.
ComputationApi get_tabular_export GET /api/v1/actions/workspaces/{workspaceId}/export/tabular/{exportId} Retrieve exported files
ComputationApi retrieve_execution_metadata GET /api/v1/actions/workspaces/{workspaceId}/execution/afm/execute/result/{resultId}/metadata Get a single execution result's metadata.
ComputationApi retrieve_result GET /api/v1/actions/workspaces/{workspaceId}/execution/afm/execute/result/{resultId} Get a single execution result
ContextFiltersApi create_entity_filter_contexts POST /api/v1/entities/workspaces/{workspaceId}/filterContexts
ContextFiltersApi delete_entity_filter_contexts DELETE /api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId}
ContextFiltersApi get_all_entities_filter_contexts GET /api/v1/entities/workspaces/{workspaceId}/filterContexts
ContextFiltersApi get_entity_filter_contexts GET /api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId}
ContextFiltersApi patch_entity_filter_contexts PATCH /api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId}
ContextFiltersApi update_entity_filter_contexts PUT /api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId}
CookieSecurityConfigurationApi get_entity_cookie_security_configurations GET /api/v1/entities/admin/cookieSecurityConfigurations/{id}
CookieSecurityConfigurationApi patch_entity_cookie_security_configurations PATCH /api/v1/entities/admin/cookieSecurityConfigurations/{id}
CookieSecurityConfigurationApi update_entity_cookie_security_configurations PUT /api/v1/entities/admin/cookieSecurityConfigurations/{id}
DashboardsApi create_entity_analytical_dashboards POST /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards
DashboardsApi delete_entity_analytical_dashboards DELETE /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId}
DashboardsApi get_all_entities_analytical_dashboards GET /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards
DashboardsApi get_entity_analytical_dashboards GET /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId}
DashboardsApi patch_entity_analytical_dashboards PATCH /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId}
DashboardsApi update_entity_analytical_dashboards PUT /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId}
DataFiltersApi create_entity_user_data_filters POST /api/v1/entities/workspaces/{workspaceId}/userDataFilters
DataFiltersApi create_entity_workspace_data_filters POST /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters
DataFiltersApi delete_entity_user_data_filters DELETE /api/v1/entities/workspaces/{workspaceId}/userDataFilters/{objectId}
DataFiltersApi delete_entity_workspace_data_filters DELETE /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/{objectId}
DataFiltersApi get_all_entities_user_data_filters GET /api/v1/entities/workspaces/{workspaceId}/userDataFilters
DataFiltersApi get_all_entities_workspace_data_filter_settings GET /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings
DataFiltersApi get_all_entities_workspace_data_filters GET /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters
DataFiltersApi get_entity_user_data_filters GET /api/v1/entities/workspaces/{workspaceId}/userDataFilters/{objectId}
DataFiltersApi get_entity_workspace_data_filter_settings GET /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/{objectId}
DataFiltersApi get_entity_workspace_data_filters GET /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/{objectId}
DataFiltersApi get_workspace_data_filters_layout GET /api/v1/layout/workspaceDataFilters Get workspace data filters for all workspaces
DataFiltersApi patch_entity_user_data_filters PATCH /api/v1/entities/workspaces/{workspaceId}/userDataFilters/{objectId}
DataFiltersApi patch_entity_workspace_data_filters PATCH /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/{objectId}
DataFiltersApi set_workspace_data_filters_layout PUT /api/v1/layout/workspaceDataFilters Set all workspace data filters
DataFiltersApi update_entity_user_data_filters PUT /api/v1/entities/workspaces/{workspaceId}/userDataFilters/{objectId}
DataFiltersApi update_entity_workspace_data_filters PUT /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/{objectId}
DataSourceDeclarativeAPIsApi get_data_sources_layout GET /api/v1/layout/dataSources Get all data sources
DataSourceDeclarativeAPIsApi put_data_sources_layout PUT /api/v1/layout/dataSources Put all data sources
DataSourceEntityAPIsApi create_entity_data_sources POST /api/v1/entities/dataSources
DataSourceEntityAPIsApi delete_entity_data_sources DELETE /api/v1/entities/dataSources/{id}
DataSourceEntityAPIsApi get_all_entities_data_source_identifiers GET /api/v1/entities/dataSourceIdentifiers
DataSourceEntityAPIsApi get_all_entities_data_source_tables GET /api/v1/entities/dataSources/{dataSourceId}/dataSourceTables
DataSourceEntityAPIsApi get_all_entities_data_sources GET /api/v1/entities/dataSources
DataSourceEntityAPIsApi get_entity_data_source_identifiers GET /api/v1/entities/dataSourceIdentifiers/{id}
DataSourceEntityAPIsApi get_entity_data_source_tables GET /api/v1/entities/dataSources/{dataSourceId}/dataSourceTables/{id}
DataSourceEntityAPIsApi get_entity_data_sources GET /api/v1/entities/dataSources/{id}
DataSourceEntityAPIsApi patch_entity_data_sources PATCH /api/v1/entities/dataSources/{id}
DataSourceEntityAPIsApi update_entity_data_sources PUT /api/v1/entities/dataSources/{id}
DatasetsApi get_all_entities_datasets GET /api/v1/entities/workspaces/{workspaceId}/datasets
DatasetsApi get_entity_datasets GET /api/v1/entities/workspaces/{workspaceId}/datasets/{objectId}
DependencyGraphApi get_dependent_entities_graph GET /api/v1/actions/workspaces/{workspaceId}/dependentEntitiesGraph Computes the dependent entities graph
DependencyGraphApi get_dependent_entities_graph_from_entry_points POST /api/v1/actions/workspaces/{workspaceId}/dependentEntitiesGraph Computes the dependent entities graph from given entry points
EntitlementApi get_all_entities_entitlements GET /api/v1/entities/entitlements
EntitlementApi get_entity_entitlements GET /api/v1/entities/entitlements/{id}
EntitlementApi resolve_all_entitlements GET /api/v1/actions/resolveEntitlements Values for all public entitlements.
EntitlementApi resolve_requested_entitlements POST /api/v1/actions/resolveEntitlements Values for requested public entitlements.
FactsApi get_all_entities_facts GET /api/v1/entities/workspaces/{workspaceId}/facts
FactsApi get_entity_facts GET /api/v1/entities/workspaces/{workspaceId}/facts/{objectId}
GenerateLogicalDataModelApi generate_logical_model POST /api/v1/actions/dataSources/{dataSourceId}/generateLogicalModel Generate logical data model (LDM) from physical data model (PDM)
InvalidateCacheApi register_upload_notification POST /api/v1/actions/dataSources/{dataSourceId}/uploadNotification Register an upload notification
LDMDeclarativeAPIsApi get_logical_model GET /api/v1/layout/workspaces/{workspaceId}/logicalModel Get logical model
LDMDeclarativeAPIsApi set_logical_model PUT /api/v1/layout/workspaces/{workspaceId}/logicalModel Set logical model
LabelsApi get_all_entities_labels GET /api/v1/entities/workspaces/{workspaceId}/labels
LabelsApi get_entity_labels GET /api/v1/entities/workspaces/{workspaceId}/labels/{objectId}
MetricsApi create_entity_metrics POST /api/v1/entities/workspaces/{workspaceId}/metrics
MetricsApi delete_entity_metrics DELETE /api/v1/entities/workspaces/{workspaceId}/metrics/{objectId}
MetricsApi get_all_entities_metrics GET /api/v1/entities/workspaces/{workspaceId}/metrics
MetricsApi get_entity_metrics GET /api/v1/entities/workspaces/{workspaceId}/metrics/{objectId}
MetricsApi patch_entity_metrics PATCH /api/v1/entities/workspaces/{workspaceId}/metrics/{objectId}
MetricsApi update_entity_metrics PUT /api/v1/entities/workspaces/{workspaceId}/metrics/{objectId}
OptionsApi get_all_options GET /api/v1/options Links for all configuration options
OrganizationDeclarativeAPIsApi get_organization_layout GET /api/v1/layout/organization Get organization layout
OrganizationDeclarativeAPIsApi set_organization_layout PUT /api/v1/layout/organization Set organization layout
OrganizationEntityAPIsApi create_entity_organization_settings POST /api/v1/entities/organizationSettings
OrganizationEntityAPIsApi delete_entity_organization_settings DELETE /api/v1/entities/organizationSettings/{id}
OrganizationEntityAPIsApi get_all_entities_organization_settings GET /api/v1/entities/organizationSettings
OrganizationEntityAPIsApi get_entity_organization_settings GET /api/v1/entities/organizationSettings/{id}
OrganizationEntityAPIsApi get_entity_organizations GET /api/v1/entities/admin/organizations/{id}
OrganizationEntityAPIsApi get_organization GET /api/v1/entities/organization Get current organization info
OrganizationEntityAPIsApi patch_entity_organization_settings PATCH /api/v1/entities/organizationSettings/{id}
OrganizationEntityAPIsApi patch_entity_organizations PATCH /api/v1/entities/admin/organizations/{id}
OrganizationEntityAPIsApi update_entity_organization_settings PUT /api/v1/entities/organizationSettings/{id}
OrganizationEntityAPIsApi update_entity_organizations PUT /api/v1/entities/admin/organizations/{id}
PDMDeclarativeAPIsApi get_pdm_layout GET /api/v1/layout/dataSources/{dataSourceId}/physicalModel Get data source physical model layout
PDMDeclarativeAPIsApi set_pdm_layout PUT /api/v1/layout/dataSources/{dataSourceId}/physicalModel Set data source physical model layout
PermissionsApi get_workspace_permissions GET /api/v1/layout/workspaces/{workspaceId}/permissions Get permissions for the workspace
PermissionsApi set_workspace_permissions PUT /api/v1/layout/workspaces/{workspaceId}/permissions Set permissions for the workspace
PluginsApi create_entity_dashboard_plugins POST /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins
PluginsApi delete_entity_dashboard_plugins DELETE /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId}
PluginsApi get_all_entities_dashboard_plugins GET /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins
PluginsApi get_entity_dashboard_plugins GET /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId}
PluginsApi patch_entity_dashboard_plugins PATCH /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId}
PluginsApi update_entity_dashboard_plugins PUT /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId}
ReportingSettingsApi resolve_all_settings_without_workspace GET /api/v1/actions/resolveSettings Values for all settings without workspace.
ReportingSettingsApi resolve_settings_without_workspace POST /api/v1/actions/resolveSettings Values for selected settings without workspace.
ScanningApi get_data_source_schemata GET /api/v1/actions/dataSources/{dataSourceId}/scanSchemata Get a list of schema names of a database
ScanningApi scan_data_source POST /api/v1/actions/dataSources/{dataSourceId}/scan Scan a database to get a physical data model (PDM)
ScanningApi scan_sql POST /api/v1/actions/dataSources/{dataSourceId}/scanSql Collect metadata about SQL query
TestConnectionApi test_data_source POST /api/v1/actions/dataSources/{dataSourceId}/test Test data source connection by data source id
TestConnectionApi test_data_source_definition POST /api/v1/actions/dataSource/test Test connection by data source definition
UsageApi all_platform_usage GET /api/v1/actions/collectUsage Info about the platform usage.
UsageApi particular_platform_usage POST /api/v1/actions/collectUsage Info about the platform usage for particular items.
UserGroupsDeclarativeAPIsApi get_user_groups_layout GET /api/v1/layout/userGroups Get all user groups
UserGroupsDeclarativeAPIsApi get_users_user_groups_layout GET /api/v1/layout/usersAndUserGroups Get all users and user groups
UserGroupsDeclarativeAPIsApi put_user_groups_layout PUT /api/v1/layout/userGroups Put all user groups
UserGroupsDeclarativeAPIsApi put_users_user_groups_layout PUT /api/v1/layout/usersAndUserGroups Put all users and user groups
UserGroupsEntityAPIsApi create_entity_user_groups POST /api/v1/entities/userGroups
UserGroupsEntityAPIsApi delete_entity_user_groups DELETE /api/v1/entities/userGroups/{id}
UserGroupsEntityAPIsApi get_all_entities_user_groups GET /api/v1/entities/userGroups
UserGroupsEntityAPIsApi get_entity_user_groups GET /api/v1/entities/userGroups/{id}
UserGroupsEntityAPIsApi patch_entity_user_groups PATCH /api/v1/entities/userGroups/{id}
UserGroupsEntityAPIsApi update_entity_user_groups PUT /api/v1/entities/userGroups/{id}
UserDataFiltersApi get_user_data_filters GET /api/v1/layout/workspaces/{workspaceId}/userDataFilters Get user data filters
UserDataFiltersApi set_user_data_filters PUT /api/v1/layout/workspaces/{workspaceId}/userDataFilters Set user data filters
UserSettingsApi create_entity_user_settings POST /api/v1/entities/users/{userId}/userSettings
UserSettingsApi delete_entity_user_settings DELETE /api/v1/entities/users/{userId}/userSettings/{id}
UserSettingsApi get_all_entities_user_settings GET /api/v1/entities/users/{userId}/userSettings List all settings for a user
UserSettingsApi get_entity_user_settings GET /api/v1/entities/users/{userId}/userSettings/{id}
UserSettingsApi update_entity_user_settings PUT /api/v1/entities/users/{userId}/userSettings/{id}
UsersDeclarativeAPIsApi get_users_layout GET /api/v1/layout/users Get all users
UsersDeclarativeAPIsApi put_users_layout PUT /api/v1/layout/users Put all users
UsersEntityAPIsApi create_entity_users POST /api/v1/entities/users
UsersEntityAPIsApi delete_entity_users DELETE /api/v1/entities/users/{id}
UsersEntityAPIsApi get_all_entities_users GET /api/v1/entities/users
UsersEntityAPIsApi get_entity_users GET /api/v1/entities/users/{id}
UsersEntityAPIsApi patch_entity_users PATCH /api/v1/entities/users/{id}
UsersEntityAPIsApi update_entity_users PUT /api/v1/entities/users/{id}
VisualizationObjectApi create_entity_visualization_objects POST /api/v1/entities/workspaces/{workspaceId}/visualizationObjects
VisualizationObjectApi delete_entity_visualization_objects DELETE /api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId}
VisualizationObjectApi get_all_entities_visualization_objects GET /api/v1/entities/workspaces/{workspaceId}/visualizationObjects
VisualizationObjectApi get_entity_visualization_objects GET /api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId}
VisualizationObjectApi patch_entity_visualization_objects PATCH /api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId}
VisualizationObjectApi update_entity_visualization_objects PUT /api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId}
WorkspacesDeclarativeAPIsApi get_workspace_layout GET /api/v1/layout/workspaces/{workspaceId} Get workspace layout
WorkspacesDeclarativeAPIsApi get_workspaces_layout GET /api/v1/layout/workspaces Get all workspaces layout
WorkspacesDeclarativeAPIsApi put_workspace_layout PUT /api/v1/layout/workspaces/{workspaceId} Set workspace layout
WorkspacesDeclarativeAPIsApi set_workspaces_layout PUT /api/v1/layout/workspaces Set all workspaces layout
WorkspacesEntityAPIsApi create_entity_workspaces POST /api/v1/entities/workspaces
WorkspacesEntityAPIsApi delete_entity_workspaces DELETE /api/v1/entities/workspaces/{id}
WorkspacesEntityAPIsApi get_all_entities_workspaces GET /api/v1/entities/workspaces
WorkspacesEntityAPIsApi get_entity_workspaces GET /api/v1/entities/workspaces/{id}
WorkspacesEntityAPIsApi patch_entity_workspaces PATCH /api/v1/entities/workspaces/{id}
WorkspacesEntityAPIsApi update_entity_workspaces PUT /api/v1/entities/workspaces/{id}
WorkspacesSettingsApi create_entity_custom_application_settings POST /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings
WorkspacesSettingsApi create_entity_workspace_settings POST /api/v1/entities/workspaces/{workspaceId}/workspaceSettings
WorkspacesSettingsApi delete_entity_custom_application_settings DELETE /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId}
WorkspacesSettingsApi delete_entity_workspace_settings DELETE /api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId}
WorkspacesSettingsApi get_all_entities_custom_application_settings GET /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings
WorkspacesSettingsApi get_all_entities_workspace_settings GET /api/v1/entities/workspaces/{workspaceId}/workspaceSettings
WorkspacesSettingsApi get_entity_custom_application_settings GET /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId}
WorkspacesSettingsApi get_entity_workspace_settings GET /api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId}
WorkspacesSettingsApi patch_entity_custom_application_settings PATCH /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId}
WorkspacesSettingsApi patch_entity_workspace_settings PATCH /api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId}
WorkspacesSettingsApi update_entity_custom_application_settings PUT /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId}
WorkspacesSettingsApi update_entity_workspace_settings PUT /api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId}
WorkspacesSettingsApi workspace_resolve_all_settings GET /api/v1/actions/workspaces/{workspaceId}/resolveSettings Values for all settings.
WorkspacesSettingsApi workspace_resolve_settings POST /api/v1/actions/workspaces/{workspaceId}/resolveSettings Values for selected settings.
ActionsApi all_platform_usage GET /api/v1/actions/collectUsage Info about the platform usage.
ActionsApi available_assignes GET /api/v1/actions/workspaces/{workspaceId}/analyticalDashboards/{dashboardId}/availableAssignees
ActionsApi check_entity_overrides POST /api/v1/actions/workspaces/{workspaceId}/checkEntityOverrides Finds entities with given ID in hierarchy.
ActionsApi compute_label_elements_post POST /api/v1/actions/workspaces/{workspaceId}/execution/collectLabelElements Listing of label values. The resulting data are limited by the static platform limit to the maximum of 10000 rows.
ActionsApi compute_report POST /api/v1/actions/workspaces/{workspaceId}/execution/afm/execute Executes analytical request and returns link to the result
ActionsApi compute_valid_objects POST /api/v1/actions/workspaces/{workspaceId}/execution/afm/computeValidObjects Valid objects
ActionsApi create_pdf_export POST /api/v1/actions/workspaces/{workspaceId}/export/visual Create visual - pdf export request
ActionsApi create_tabular_export POST /api/v1/actions/workspaces/{workspaceId}/export/tabular Create tabular export request
ActionsApi explain_afm POST /api/v1/actions/workspaces/{workspaceId}/execution/afm/explain AFM explain resource.
ActionsApi generate_logical_model POST /api/v1/actions/dataSources/{dataSourceId}/generateLogicalModel Generate logical data model (LDM) from physical data model (PDM)
ActionsApi get_data_source_schemata GET /api/v1/actions/dataSources/{dataSourceId}/scanSchemata Get a list of schema names of a database
ActionsApi get_dependent_entities_graph GET /api/v1/actions/workspaces/{workspaceId}/dependentEntitiesGraph Computes the dependent entities graph
ActionsApi get_dependent_entities_graph_from_entry_points POST /api/v1/actions/workspaces/{workspaceId}/dependentEntitiesGraph Computes the dependent entities graph from given entry points
ActionsApi get_exported_file GET /api/v1/actions/workspaces/{workspaceId}/export/visual/{exportId} Retrieve exported files
ActionsApi get_metadata GET /api/v1/actions/workspaces/{workspaceId}/export/visual/{exportId}/metadata Retrieve metadata context
ActionsApi get_tabular_export GET /api/v1/actions/workspaces/{workspaceId}/export/tabular/{exportId} Retrieve exported files
ActionsApi inherited_entity_conflicts GET /api/v1/actions/workspaces/{workspaceId}/inheritedEntityConflicts Finds API identifier conflicts in given workspace hierarchy.
ActionsApi manage_permissions POST /api/v1/actions/workspaces/{workspaceId}/analyticalDashboards/{dashboardId}/managePermissions
ActionsApi overridden_child_entities GET /api/v1/actions/workspaces/{workspaceId}/overriddenChildEntities Finds API identifier overrides in given workspace hierarchy.
ActionsApi particular_platform_usage POST /api/v1/actions/collectUsage Info about the platform usage for particular items.
ActionsApi permissions GET /api/v1/actions/workspaces/{workspaceId}/analyticalDashboards/{dashboardId}/permissions
ActionsApi register_upload_notification POST /api/v1/actions/dataSources/{dataSourceId}/uploadNotification Register an upload notification
ActionsApi resolve_all_entitlements GET /api/v1/actions/resolveEntitlements Values for all public entitlements.
ActionsApi resolve_all_settings_without_workspace GET /api/v1/actions/resolveSettings Values for all settings without workspace.
ActionsApi resolve_requested_entitlements POST /api/v1/actions/resolveEntitlements Values for requested public entitlements.
ActionsApi resolve_settings_without_workspace POST /api/v1/actions/resolveSettings Values for selected settings without workspace.
ActionsApi retrieve_execution_metadata GET /api/v1/actions/workspaces/{workspaceId}/execution/afm/execute/result/{resultId}/metadata Get a single execution result's metadata.
ActionsApi retrieve_result GET /api/v1/actions/workspaces/{workspaceId}/execution/afm/execute/result/{resultId} Get a single execution result
ActionsApi scan_data_source POST /api/v1/actions/dataSources/{dataSourceId}/scan Scan a database to get a physical data model (PDM)
ActionsApi scan_sql POST /api/v1/actions/dataSources/{dataSourceId}/scanSql Collect metadata about SQL query
ActionsApi test_data_source POST /api/v1/actions/dataSources/{dataSourceId}/test Test data source connection by data source id
ActionsApi test_data_source_definition POST /api/v1/actions/dataSource/test Test connection by data source definition
ActionsApi workspace_resolve_all_settings GET /api/v1/actions/workspaces/{workspaceId}/resolveSettings Values for all settings.
ActionsApi workspace_resolve_settings POST /api/v1/actions/workspaces/{workspaceId}/resolveSettings Values for selected settings.
DataSourceEntitiesControllerApi get_all_entities_data_source_tables GET /api/v1/entities/dataSources/{dataSourceId}/dataSourceTables
DataSourceEntitiesControllerApi get_entity_data_source_tables GET /api/v1/entities/dataSources/{dataSourceId}/dataSourceTables/{id}
EntitiesApi create_entity_analytical_dashboards POST /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards
EntitiesApi create_entity_api_tokens POST /api/v1/entities/users/{userId}/apiTokens
EntitiesApi create_entity_color_palettes POST /api/v1/entities/colorPalettes
EntitiesApi create_entity_csp_directives POST /api/v1/entities/cspDirectives
EntitiesApi create_entity_custom_application_settings POST /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings
EntitiesApi create_entity_dashboard_plugins POST /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins
EntitiesApi create_entity_data_sources POST /api/v1/entities/dataSources
EntitiesApi create_entity_filter_contexts POST /api/v1/entities/workspaces/{workspaceId}/filterContexts
EntitiesApi create_entity_metrics POST /api/v1/entities/workspaces/{workspaceId}/metrics
EntitiesApi create_entity_organization_settings POST /api/v1/entities/organizationSettings
EntitiesApi create_entity_themes POST /api/v1/entities/themes
EntitiesApi create_entity_user_data_filters POST /api/v1/entities/workspaces/{workspaceId}/userDataFilters
EntitiesApi create_entity_user_groups POST /api/v1/entities/userGroups
EntitiesApi create_entity_user_settings POST /api/v1/entities/users/{userId}/userSettings
EntitiesApi create_entity_users POST /api/v1/entities/users
EntitiesApi create_entity_visualization_objects POST /api/v1/entities/workspaces/{workspaceId}/visualizationObjects
EntitiesApi create_entity_workspace_data_filters POST /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters
EntitiesApi create_entity_workspace_settings POST /api/v1/entities/workspaces/{workspaceId}/workspaceSettings
EntitiesApi create_entity_workspaces POST /api/v1/entities/workspaces
EntitiesApi delete_entity_analytical_dashboards DELETE /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId}
EntitiesApi delete_entity_api_tokens DELETE /api/v1/entities/users/{userId}/apiTokens/{id}
EntitiesApi delete_entity_color_palettes DELETE /api/v1/entities/colorPalettes/{id}
EntitiesApi delete_entity_csp_directives DELETE /api/v1/entities/cspDirectives/{id}
EntitiesApi delete_entity_custom_application_settings DELETE /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId}
EntitiesApi delete_entity_dashboard_plugins DELETE /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId}
EntitiesApi delete_entity_data_sources DELETE /api/v1/entities/dataSources/{id}
EntitiesApi delete_entity_filter_contexts DELETE /api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId}
EntitiesApi delete_entity_metrics DELETE /api/v1/entities/workspaces/{workspaceId}/metrics/{objectId}
EntitiesApi delete_entity_organization_settings DELETE /api/v1/entities/organizationSettings/{id}
EntitiesApi delete_entity_themes DELETE /api/v1/entities/themes/{id}
EntitiesApi delete_entity_user_data_filters DELETE /api/v1/entities/workspaces/{workspaceId}/userDataFilters/{objectId}
EntitiesApi delete_entity_user_groups DELETE /api/v1/entities/userGroups/{id}
EntitiesApi delete_entity_user_settings DELETE /api/v1/entities/users/{userId}/userSettings/{id}
EntitiesApi delete_entity_users DELETE /api/v1/entities/users/{id}
EntitiesApi delete_entity_visualization_objects DELETE /api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId}
EntitiesApi delete_entity_workspace_data_filters DELETE /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/{objectId}
EntitiesApi delete_entity_workspace_settings DELETE /api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId}
EntitiesApi delete_entity_workspaces DELETE /api/v1/entities/workspaces/{id}
EntitiesApi get_all_entities_analytical_dashboards GET /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards
EntitiesApi get_all_entities_api_tokens GET /api/v1/entities/users/{userId}/apiTokens List all api tokens for a user
EntitiesApi get_all_entities_attributes GET /api/v1/entities/workspaces/{workspaceId}/attributes
EntitiesApi get_all_entities_color_palettes GET /api/v1/entities/colorPalettes
EntitiesApi get_all_entities_csp_directives GET /api/v1/entities/cspDirectives
EntitiesApi get_all_entities_custom_application_settings GET /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings
EntitiesApi get_all_entities_dashboard_plugins GET /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins
EntitiesApi get_all_entities_data_source_identifiers GET /api/v1/entities/dataSourceIdentifiers
EntitiesApi get_all_entities_data_source_tables GET /api/v1/entities/dataSources/{dataSourceId}/dataSourceTables
EntitiesApi get_all_entities_data_sources GET /api/v1/entities/dataSources
EntitiesApi get_all_entities_datasets GET /api/v1/entities/workspaces/{workspaceId}/datasets
EntitiesApi get_all_entities_entitlements GET /api/v1/entities/entitlements
EntitiesApi get_all_entities_facts GET /api/v1/entities/workspaces/{workspaceId}/facts
EntitiesApi get_all_entities_filter_contexts GET /api/v1/entities/workspaces/{workspaceId}/filterContexts
EntitiesApi get_all_entities_labels GET /api/v1/entities/workspaces/{workspaceId}/labels
EntitiesApi get_all_entities_metrics GET /api/v1/entities/workspaces/{workspaceId}/metrics
EntitiesApi get_all_entities_organization_settings GET /api/v1/entities/organizationSettings
EntitiesApi get_all_entities_themes GET /api/v1/entities/themes
EntitiesApi get_all_entities_user_data_filters GET /api/v1/entities/workspaces/{workspaceId}/userDataFilters
EntitiesApi get_all_entities_user_groups GET /api/v1/entities/userGroups
EntitiesApi get_all_entities_user_settings GET /api/v1/entities/users/{userId}/userSettings List all settings for a user
EntitiesApi get_all_entities_users GET /api/v1/entities/users
EntitiesApi get_all_entities_visualization_objects GET /api/v1/entities/workspaces/{workspaceId}/visualizationObjects
EntitiesApi get_all_entities_workspace_data_filter_settings GET /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings
EntitiesApi get_all_entities_workspace_data_filters GET /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters
EntitiesApi get_all_entities_workspace_settings GET /api/v1/entities/workspaces/{workspaceId}/workspaceSettings
EntitiesApi get_all_entities_workspaces GET /api/v1/entities/workspaces
EntitiesApi get_all_options GET /api/v1/options Links for all configuration options
EntitiesApi get_data_source_drivers GET /api/v1/options/availableDrivers Get all available data source drivers
EntitiesApi get_entity_analytical_dashboards GET /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId}
EntitiesApi get_entity_api_tokens GET /api/v1/entities/users/{userId}/apiTokens/{id}
EntitiesApi get_entity_attributes GET /api/v1/entities/workspaces/{workspaceId}/attributes/{objectId}
EntitiesApi get_entity_color_palettes GET /api/v1/entities/colorPalettes/{id}
EntitiesApi get_entity_cookie_security_configurations GET /api/v1/entities/admin/cookieSecurityConfigurations/{id}
EntitiesApi get_entity_csp_directives GET /api/v1/entities/cspDirectives/{id}
EntitiesApi get_entity_custom_application_settings GET /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId}
EntitiesApi get_entity_dashboard_plugins GET /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId}
EntitiesApi get_entity_data_source_identifiers GET /api/v1/entities/dataSourceIdentifiers/{id}
EntitiesApi get_entity_data_source_tables GET /api/v1/entities/dataSources/{dataSourceId}/dataSourceTables/{id}
EntitiesApi get_entity_data_sources GET /api/v1/entities/dataSources/{id}
EntitiesApi get_entity_datasets GET /api/v1/entities/workspaces/{workspaceId}/datasets/{objectId}
EntitiesApi get_entity_entitlements GET /api/v1/entities/entitlements/{id}
EntitiesApi get_entity_facts GET /api/v1/entities/workspaces/{workspaceId}/facts/{objectId}
EntitiesApi get_entity_filter_contexts GET /api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId}
EntitiesApi get_entity_labels GET /api/v1/entities/workspaces/{workspaceId}/labels/{objectId}
EntitiesApi get_entity_metrics GET /api/v1/entities/workspaces/{workspaceId}/metrics/{objectId}
EntitiesApi get_entity_organization_settings GET /api/v1/entities/organizationSettings/{id}
EntitiesApi get_entity_organizations GET /api/v1/entities/admin/organizations/{id}
EntitiesApi get_entity_themes GET /api/v1/entities/themes/{id}
EntitiesApi get_entity_user_data_filters GET /api/v1/entities/workspaces/{workspaceId}/userDataFilters/{objectId}
EntitiesApi get_entity_user_groups GET /api/v1/entities/userGroups/{id}
EntitiesApi get_entity_user_settings GET /api/v1/entities/users/{userId}/userSettings/{id}
EntitiesApi get_entity_users GET /api/v1/entities/users/{id}
EntitiesApi get_entity_visualization_objects GET /api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId}
EntitiesApi get_entity_workspace_data_filter_settings GET /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/{objectId}
EntitiesApi get_entity_workspace_data_filters GET /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/{objectId}
EntitiesApi get_entity_workspace_settings GET /api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId}
EntitiesApi get_entity_workspaces GET /api/v1/entities/workspaces/{id}
EntitiesApi get_organization GET /api/v1/entities/organization Get current organization info
EntitiesApi patch_entity_analytical_dashboards PATCH /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId}
EntitiesApi patch_entity_color_palettes PATCH /api/v1/entities/colorPalettes/{id}
EntitiesApi patch_entity_cookie_security_configurations PATCH /api/v1/entities/admin/cookieSecurityConfigurations/{id}
EntitiesApi patch_entity_csp_directives PATCH /api/v1/entities/cspDirectives/{id}
EntitiesApi patch_entity_custom_application_settings PATCH /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId}
EntitiesApi patch_entity_dashboard_plugins PATCH /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId}
EntitiesApi patch_entity_data_sources PATCH /api/v1/entities/dataSources/{id}
EntitiesApi patch_entity_filter_contexts PATCH /api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId}
EntitiesApi patch_entity_metrics PATCH /api/v1/entities/workspaces/{workspaceId}/metrics/{objectId}
EntitiesApi patch_entity_organization_settings PATCH /api/v1/entities/organizationSettings/{id}
EntitiesApi patch_entity_organizations PATCH /api/v1/entities/admin/organizations/{id}
EntitiesApi patch_entity_themes PATCH /api/v1/entities/themes/{id}
EntitiesApi patch_entity_user_data_filters PATCH /api/v1/entities/workspaces/{workspaceId}/userDataFilters/{objectId}
EntitiesApi patch_entity_user_groups PATCH /api/v1/entities/userGroups/{id}
EntitiesApi patch_entity_users PATCH /api/v1/entities/users/{id}
EntitiesApi patch_entity_visualization_objects PATCH /api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId}
EntitiesApi patch_entity_workspace_data_filters PATCH /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/{objectId}
EntitiesApi patch_entity_workspace_settings PATCH /api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId}
EntitiesApi patch_entity_workspaces PATCH /api/v1/entities/workspaces/{id}
EntitiesApi update_entity_analytical_dashboards PUT /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId}
EntitiesApi update_entity_api_tokens PUT /api/v1/entities/users/{userId}/apiTokens/{id}
EntitiesApi update_entity_color_palettes PUT /api/v1/entities/colorPalettes/{id}
EntitiesApi update_entity_cookie_security_configurations PUT /api/v1/entities/admin/cookieSecurityConfigurations/{id}
EntitiesApi update_entity_csp_directives PUT /api/v1/entities/cspDirectives/{id}
EntitiesApi update_entity_custom_application_settings PUT /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId}
EntitiesApi update_entity_dashboard_plugins PUT /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId}
EntitiesApi update_entity_data_sources PUT /api/v1/entities/dataSources/{id}
EntitiesApi update_entity_filter_contexts PUT /api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId}
EntitiesApi update_entity_metrics PUT /api/v1/entities/workspaces/{workspaceId}/metrics/{objectId}
EntitiesApi update_entity_organization_settings PUT /api/v1/entities/organizationSettings/{id}
EntitiesApi update_entity_organizations PUT /api/v1/entities/admin/organizations/{id}
EntitiesApi update_entity_themes PUT /api/v1/entities/themes/{id}
EntitiesApi update_entity_user_data_filters PUT /api/v1/entities/workspaces/{workspaceId}/userDataFilters/{objectId}
EntitiesApi update_entity_user_groups PUT /api/v1/entities/userGroups/{id}
EntitiesApi update_entity_user_settings PUT /api/v1/entities/users/{userId}/userSettings/{id}
EntitiesApi update_entity_users PUT /api/v1/entities/users/{id}
EntitiesApi update_entity_visualization_objects PUT /api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId}
EntitiesApi update_entity_workspace_data_filters PUT /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/{objectId}
EntitiesApi update_entity_workspace_settings PUT /api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId}
EntitiesApi update_entity_workspaces PUT /api/v1/entities/workspaces/{id}
LayoutApi get_analytics_model GET /api/v1/layout/workspaces/{workspaceId}/analyticsModel Get analytics model
LayoutApi get_data_sources_layout GET /api/v1/layout/dataSources Get all data sources
LayoutApi get_logical_model GET /api/v1/layout/workspaces/{workspaceId}/logicalModel Get logical model
LayoutApi get_organization_layout GET /api/v1/layout/organization Get organization layout
LayoutApi get_pdm_layout GET /api/v1/layout/dataSources/{dataSourceId}/physicalModel Get data source physical model layout
LayoutApi get_user_data_filters GET /api/v1/layout/workspaces/{workspaceId}/userDataFilters Get user data filters
LayoutApi get_user_group_permissions GET /api/v1/layout/userGroups/{userGroupId}/permissions Get permissions for the user-group
LayoutApi get_user_groups_layout GET /api/v1/layout/userGroups Get all user groups
LayoutApi get_user_permissions GET /api/v1/layout/users/{userId}/permissions Get permissions for the user
LayoutApi get_users_layout GET /api/v1/layout/users Get all users
LayoutApi get_users_user_groups_layout GET /api/v1/layout/usersAndUserGroups Get all users and user groups
LayoutApi get_workspace_data_filters_layout GET /api/v1/layout/workspaceDataFilters Get workspace data filters for all workspaces
LayoutApi get_workspace_layout GET /api/v1/layout/workspaces/{workspaceId} Get workspace layout
LayoutApi get_workspace_permissions GET /api/v1/layout/workspaces/{workspaceId}/permissions Get permissions for the workspace
LayoutApi get_workspaces_layout GET /api/v1/layout/workspaces Get all workspaces layout
LayoutApi put_data_sources_layout PUT /api/v1/layout/dataSources Put all data sources
LayoutApi put_user_groups_layout PUT /api/v1/layout/userGroups Put all user groups
LayoutApi put_users_layout PUT /api/v1/layout/users Put all users
LayoutApi put_users_user_groups_layout PUT /api/v1/layout/usersAndUserGroups Put all users and user groups
LayoutApi put_workspace_layout PUT /api/v1/layout/workspaces/{workspaceId} Set workspace layout
LayoutApi set_analytics_model PUT /api/v1/layout/workspaces/{workspaceId}/analyticsModel Set analytics model
LayoutApi set_logical_model PUT /api/v1/layout/workspaces/{workspaceId}/logicalModel Set logical model
LayoutApi set_organization_layout PUT /api/v1/layout/organization Set organization layout
LayoutApi set_pdm_layout PUT /api/v1/layout/dataSources/{dataSourceId}/physicalModel Set data source physical model layout
LayoutApi set_user_data_filters PUT /api/v1/layout/workspaces/{workspaceId}/userDataFilters Set user data filters
LayoutApi set_user_group_permissions PUT /api/v1/layout/userGroups/{userGroupId}/permissions Set permissions for the user-group
LayoutApi set_user_permissions PUT /api/v1/layout/users/{userId}/permissions Set permissions for the user
LayoutApi set_workspace_data_filters_layout PUT /api/v1/layout/workspaceDataFilters Set all workspace data filters
LayoutApi set_workspace_permissions PUT /api/v1/layout/workspaces/{workspaceId}/permissions Set permissions for the workspace
LayoutApi set_workspaces_layout PUT /api/v1/layout/workspaces Set all workspaces layout
OrganizationControllerApi get_entity_cookie_security_configurations GET /api/v1/entities/admin/cookieSecurityConfigurations/{id}
OrganizationControllerApi get_entity_organizations GET /api/v1/entities/admin/organizations/{id}
OrganizationControllerApi patch_entity_cookie_security_configurations PATCH /api/v1/entities/admin/cookieSecurityConfigurations/{id}
OrganizationControllerApi patch_entity_organizations PATCH /api/v1/entities/admin/organizations/{id}
OrganizationControllerApi update_entity_cookie_security_configurations PUT /api/v1/entities/admin/cookieSecurityConfigurations/{id}
OrganizationControllerApi update_entity_organizations PUT /api/v1/entities/admin/organizations/{id}
OrganizationModelControllerApi create_entity_color_palettes POST /api/v1/entities/colorPalettes
OrganizationModelControllerApi create_entity_csp_directives POST /api/v1/entities/cspDirectives
OrganizationModelControllerApi create_entity_data_sources POST /api/v1/entities/dataSources
OrganizationModelControllerApi create_entity_organization_settings POST /api/v1/entities/organizationSettings
OrganizationModelControllerApi create_entity_themes POST /api/v1/entities/themes
OrganizationModelControllerApi create_entity_user_groups POST /api/v1/entities/userGroups
OrganizationModelControllerApi create_entity_users POST /api/v1/entities/users
OrganizationModelControllerApi create_entity_workspaces POST /api/v1/entities/workspaces
OrganizationModelControllerApi delete_entity_color_palettes DELETE /api/v1/entities/colorPalettes/{id}
OrganizationModelControllerApi delete_entity_csp_directives DELETE /api/v1/entities/cspDirectives/{id}
OrganizationModelControllerApi delete_entity_data_sources DELETE /api/v1/entities/dataSources/{id}
OrganizationModelControllerApi delete_entity_organization_settings DELETE /api/v1/entities/organizationSettings/{id}
OrganizationModelControllerApi delete_entity_themes DELETE /api/v1/entities/themes/{id}
OrganizationModelControllerApi delete_entity_user_groups DELETE /api/v1/entities/userGroups/{id}
OrganizationModelControllerApi delete_entity_users DELETE /api/v1/entities/users/{id}
OrganizationModelControllerApi delete_entity_workspaces DELETE /api/v1/entities/workspaces/{id}
OrganizationModelControllerApi get_all_entities_color_palettes GET /api/v1/entities/colorPalettes
OrganizationModelControllerApi get_all_entities_csp_directives GET /api/v1/entities/cspDirectives
OrganizationModelControllerApi get_all_entities_data_source_identifiers GET /api/v1/entities/dataSourceIdentifiers
OrganizationModelControllerApi get_all_entities_data_sources GET /api/v1/entities/dataSources
OrganizationModelControllerApi get_all_entities_entitlements GET /api/v1/entities/entitlements
OrganizationModelControllerApi get_all_entities_organization_settings GET /api/v1/entities/organizationSettings
OrganizationModelControllerApi get_all_entities_themes GET /api/v1/entities/themes
OrganizationModelControllerApi get_all_entities_user_groups GET /api/v1/entities/userGroups
OrganizationModelControllerApi get_all_entities_users GET /api/v1/entities/users
OrganizationModelControllerApi get_all_entities_workspaces GET /api/v1/entities/workspaces
OrganizationModelControllerApi get_entity_color_palettes GET /api/v1/entities/colorPalettes/{id}
OrganizationModelControllerApi get_entity_csp_directives GET /api/v1/entities/cspDirectives/{id}
OrganizationModelControllerApi get_entity_data_source_identifiers GET /api/v1/entities/dataSourceIdentifiers/{id}
OrganizationModelControllerApi get_entity_data_sources GET /api/v1/entities/dataSources/{id}
OrganizationModelControllerApi get_entity_entitlements GET /api/v1/entities/entitlements/{id}
OrganizationModelControllerApi get_entity_organization_settings GET /api/v1/entities/organizationSettings/{id}
OrganizationModelControllerApi get_entity_themes GET /api/v1/entities/themes/{id}
OrganizationModelControllerApi get_entity_user_groups GET /api/v1/entities/userGroups/{id}
OrganizationModelControllerApi get_entity_users GET /api/v1/entities/users/{id}
OrganizationModelControllerApi get_entity_workspaces GET /api/v1/entities/workspaces/{id}
OrganizationModelControllerApi patch_entity_color_palettes PATCH /api/v1/entities/colorPalettes/{id}
OrganizationModelControllerApi patch_entity_csp_directives PATCH /api/v1/entities/cspDirectives/{id}
OrganizationModelControllerApi patch_entity_data_sources PATCH /api/v1/entities/dataSources/{id}
OrganizationModelControllerApi patch_entity_organization_settings PATCH /api/v1/entities/organizationSettings/{id}
OrganizationModelControllerApi patch_entity_themes PATCH /api/v1/entities/themes/{id}
OrganizationModelControllerApi patch_entity_user_groups PATCH /api/v1/entities/userGroups/{id}
OrganizationModelControllerApi patch_entity_users PATCH /api/v1/entities/users/{id}
OrganizationModelControllerApi patch_entity_workspaces PATCH /api/v1/entities/workspaces/{id}
OrganizationModelControllerApi update_entity_color_palettes PUT /api/v1/entities/colorPalettes/{id}
OrganizationModelControllerApi update_entity_csp_directives PUT /api/v1/entities/cspDirectives/{id}
OrganizationModelControllerApi update_entity_data_sources PUT /api/v1/entities/dataSources/{id}
OrganizationModelControllerApi update_entity_organization_settings PUT /api/v1/entities/organizationSettings/{id}
OrganizationModelControllerApi update_entity_themes PUT /api/v1/entities/themes/{id}
OrganizationModelControllerApi update_entity_user_groups PUT /api/v1/entities/userGroups/{id}
OrganizationModelControllerApi update_entity_users PUT /api/v1/entities/users/{id}
OrganizationModelControllerApi update_entity_workspaces PUT /api/v1/entities/workspaces/{id}
UserModelControllerApi create_entity_api_tokens POST /api/v1/entities/users/{userId}/apiTokens
UserModelControllerApi create_entity_user_settings POST /api/v1/entities/users/{userId}/userSettings
UserModelControllerApi delete_entity_api_tokens DELETE /api/v1/entities/users/{userId}/apiTokens/{id}
UserModelControllerApi delete_entity_user_settings DELETE /api/v1/entities/users/{userId}/userSettings/{id}
UserModelControllerApi get_all_entities_api_tokens GET /api/v1/entities/users/{userId}/apiTokens List all api tokens for a user
UserModelControllerApi get_all_entities_user_settings GET /api/v1/entities/users/{userId}/userSettings List all settings for a user
UserModelControllerApi get_entity_api_tokens GET /api/v1/entities/users/{userId}/apiTokens/{id}
UserModelControllerApi get_entity_user_settings GET /api/v1/entities/users/{userId}/userSettings/{id}
UserModelControllerApi update_entity_api_tokens PUT /api/v1/entities/users/{userId}/apiTokens/{id}
UserModelControllerApi update_entity_user_settings PUT /api/v1/entities/users/{userId}/userSettings/{id}
WorkspaceObjectControllerApi create_entity_analytical_dashboards POST /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards
WorkspaceObjectControllerApi create_entity_custom_application_settings POST /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings
WorkspaceObjectControllerApi create_entity_dashboard_plugins POST /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins
WorkspaceObjectControllerApi create_entity_filter_contexts POST /api/v1/entities/workspaces/{workspaceId}/filterContexts
WorkspaceObjectControllerApi create_entity_metrics POST /api/v1/entities/workspaces/{workspaceId}/metrics
WorkspaceObjectControllerApi create_entity_user_data_filters POST /api/v1/entities/workspaces/{workspaceId}/userDataFilters
WorkspaceObjectControllerApi create_entity_visualization_objects POST /api/v1/entities/workspaces/{workspaceId}/visualizationObjects
WorkspaceObjectControllerApi create_entity_workspace_data_filters POST /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters
WorkspaceObjectControllerApi create_entity_workspace_settings POST /api/v1/entities/workspaces/{workspaceId}/workspaceSettings
WorkspaceObjectControllerApi delete_entity_analytical_dashboards DELETE /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId}
WorkspaceObjectControllerApi delete_entity_custom_application_settings DELETE /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId}
WorkspaceObjectControllerApi delete_entity_dashboard_plugins DELETE /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId}
WorkspaceObjectControllerApi delete_entity_filter_contexts DELETE /api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId}
WorkspaceObjectControllerApi delete_entity_metrics DELETE /api/v1/entities/workspaces/{workspaceId}/metrics/{objectId}
WorkspaceObjectControllerApi delete_entity_user_data_filters DELETE /api/v1/entities/workspaces/{workspaceId}/userDataFilters/{objectId}
WorkspaceObjectControllerApi delete_entity_visualization_objects DELETE /api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId}
WorkspaceObjectControllerApi delete_entity_workspace_data_filters DELETE /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/{objectId}
WorkspaceObjectControllerApi delete_entity_workspace_settings DELETE /api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId}
WorkspaceObjectControllerApi get_all_entities_analytical_dashboards GET /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards
WorkspaceObjectControllerApi get_all_entities_attributes GET /api/v1/entities/workspaces/{workspaceId}/attributes
WorkspaceObjectControllerApi get_all_entities_custom_application_settings GET /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings
WorkspaceObjectControllerApi get_all_entities_dashboard_plugins GET /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins
WorkspaceObjectControllerApi get_all_entities_datasets GET /api/v1/entities/workspaces/{workspaceId}/datasets
WorkspaceObjectControllerApi get_all_entities_facts GET /api/v1/entities/workspaces/{workspaceId}/facts
WorkspaceObjectControllerApi get_all_entities_filter_contexts GET /api/v1/entities/workspaces/{workspaceId}/filterContexts
WorkspaceObjectControllerApi get_all_entities_labels GET /api/v1/entities/workspaces/{workspaceId}/labels
WorkspaceObjectControllerApi get_all_entities_metrics GET /api/v1/entities/workspaces/{workspaceId}/metrics
WorkspaceObjectControllerApi get_all_entities_user_data_filters GET /api/v1/entities/workspaces/{workspaceId}/userDataFilters
WorkspaceObjectControllerApi get_all_entities_visualization_objects GET /api/v1/entities/workspaces/{workspaceId}/visualizationObjects
WorkspaceObjectControllerApi get_all_entities_workspace_data_filter_settings GET /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings
WorkspaceObjectControllerApi get_all_entities_workspace_data_filters GET /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters
WorkspaceObjectControllerApi get_all_entities_workspace_settings GET /api/v1/entities/workspaces/{workspaceId}/workspaceSettings
WorkspaceObjectControllerApi get_entity_analytical_dashboards GET /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId}
WorkspaceObjectControllerApi get_entity_attributes GET /api/v1/entities/workspaces/{workspaceId}/attributes/{objectId}
WorkspaceObjectControllerApi get_entity_custom_application_settings GET /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId}
WorkspaceObjectControllerApi get_entity_dashboard_plugins GET /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId}
WorkspaceObjectControllerApi get_entity_datasets GET /api/v1/entities/workspaces/{workspaceId}/datasets/{objectId}
WorkspaceObjectControllerApi get_entity_facts GET /api/v1/entities/workspaces/{workspaceId}/facts/{objectId}
WorkspaceObjectControllerApi get_entity_filter_contexts GET /api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId}
WorkspaceObjectControllerApi get_entity_labels GET /api/v1/entities/workspaces/{workspaceId}/labels/{objectId}
WorkspaceObjectControllerApi get_entity_metrics GET /api/v1/entities/workspaces/{workspaceId}/metrics/{objectId}
WorkspaceObjectControllerApi get_entity_user_data_filters GET /api/v1/entities/workspaces/{workspaceId}/userDataFilters/{objectId}
WorkspaceObjectControllerApi get_entity_visualization_objects GET /api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId}
WorkspaceObjectControllerApi get_entity_workspace_data_filter_settings GET /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/{objectId}
WorkspaceObjectControllerApi get_entity_workspace_data_filters GET /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/{objectId}
WorkspaceObjectControllerApi get_entity_workspace_settings GET /api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId}
WorkspaceObjectControllerApi patch_entity_analytical_dashboards PATCH /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId}
WorkspaceObjectControllerApi patch_entity_custom_application_settings PATCH /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId}
WorkspaceObjectControllerApi patch_entity_dashboard_plugins PATCH /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId}
WorkspaceObjectControllerApi patch_entity_filter_contexts PATCH /api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId}
WorkspaceObjectControllerApi patch_entity_metrics PATCH /api/v1/entities/workspaces/{workspaceId}/metrics/{objectId}
WorkspaceObjectControllerApi patch_entity_user_data_filters PATCH /api/v1/entities/workspaces/{workspaceId}/userDataFilters/{objectId}
WorkspaceObjectControllerApi patch_entity_visualization_objects PATCH /api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId}
WorkspaceObjectControllerApi patch_entity_workspace_data_filters PATCH /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/{objectId}
WorkspaceObjectControllerApi patch_entity_workspace_settings PATCH /api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId}
WorkspaceObjectControllerApi update_entity_analytical_dashboards PUT /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId}
WorkspaceObjectControllerApi update_entity_custom_application_settings PUT /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId}
WorkspaceObjectControllerApi update_entity_dashboard_plugins PUT /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId}
WorkspaceObjectControllerApi update_entity_filter_contexts PUT /api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId}
WorkspaceObjectControllerApi update_entity_metrics PUT /api/v1/entities/workspaces/{workspaceId}/metrics/{objectId}
WorkspaceObjectControllerApi update_entity_user_data_filters PUT /api/v1/entities/workspaces/{workspaceId}/userDataFilters/{objectId}
WorkspaceObjectControllerApi update_entity_visualization_objects PUT /api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId}
WorkspaceObjectControllerApi update_entity_workspace_data_filters PUT /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/{objectId}
WorkspaceObjectControllerApi update_entity_workspace_settings PUT /api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId}

Documentation For Models

Documentation For Authorization

All endpoints do not require authorization.

Author

support@gooddata.com

Notes for Large OpenAPI documents

If the OpenAPI document is large, imports in gooddata_api_client.apis and gooddata_api_client.models may fail with a RecursionError indicating the maximum recursion limit has been exceeded. In that case, there are a couple of solutions:

Solution 1: Use specific imports for apis and models like:

  • from gooddata_api_client.api.default_api import DefaultApi
  • from gooddata_api_client.model.pet import Pet

Solution 2: Before importing the package, adjust the maximum recursion limit as shown below:

import sys
sys.setrecursionlimit(1500)
import gooddata_api_client
from gooddata_api_client.apis import *
from gooddata_api_client.models import *

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

gooddata-api-client-1.3.1.dev4.tar.gz (405.6 kB view hashes)

Uploaded Source

Built Distribution

gooddata_api_client-1.3.1.dev4-py3-none-any.whl (1.7 MB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page