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.1.1a3
  • 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 actions_api
from gooddata_api_client.model.afm_execution import AfmExecution
from gooddata_api_client.model.afm_execution_response import AfmExecutionResponse
from gooddata_api_client.model.afm_valid_objects_query import AfmValidObjectsQuery
from gooddata_api_client.model.afm_valid_objects_response import AfmValidObjectsResponse
from gooddata_api_client.model.api_entitlement import ApiEntitlement
from gooddata_api_client.model.data_source_schemata import DataSourceSchemata
from gooddata_api_client.model.declarative_model import DeclarativeModel
from gooddata_api_client.model.declarative_setting import DeclarativeSetting
from gooddata_api_client.model.dependent_entities_request import DependentEntitiesRequest
from gooddata_api_client.model.dependent_entities_response import DependentEntitiesResponse
from gooddata_api_client.model.elements_request import ElementsRequest
from gooddata_api_client.model.elements_response import ElementsResponse
from gooddata_api_client.model.entitlements_request import EntitlementsRequest
from gooddata_api_client.model.execution_result import ExecutionResult
from gooddata_api_client.model.generate_ldm_request import GenerateLdmRequest
from gooddata_api_client.model.platform_usage import PlatformUsage
from gooddata_api_client.model.platform_usage_request import PlatformUsageRequest
from gooddata_api_client.model.resolve_settings_request import ResolveSettingsRequest
from gooddata_api_client.model.result_cache_metadata import ResultCacheMetadata
from gooddata_api_client.model.scan_request import ScanRequest
from gooddata_api_client.model.scan_result_pdm import ScanResultPdm
from gooddata_api_client.model.tabular_export_request import TabularExportRequest
from gooddata_api_client.model.tabular_export_result import TabularExportResult
from gooddata_api_client.model.test_definition_request import TestDefinitionRequest
from gooddata_api_client.model.test_request import TestRequest
from gooddata_api_client.model.test_response import TestResponse
# 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 = actions_api.ActionsApi(api_client)

    try:
        # Info about the platform usage.
        api_response = api_instance.all_platform_usage()
        pprint(api_response)
    except gooddata_api_client.ApiException as e:
        print("Exception when calling ActionsApi->all_platform_usage: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost

Class Method HTTP request Description
ActionsApi all_platform_usage GET /api/v1/actions/collectUsage Info about the platform usage.
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_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_tabular_export GET /api/v1/actions/workspaces/{workspaceId}/export/tabular/{exportId} Retrieve exported files
ActionsApi particular_platform_usage POST /api/v1/actions/collectUsage Info about the platform usage for particular items.
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 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.
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_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_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_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_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
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_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_groups GET /api/v1/entities/userGroups
EntitiesApi get_all_entities_user_settings GET /api/v1/entities/users/{userId}/userSettings
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_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_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_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_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_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_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_groups_layout GET /api/v1/layout/userGroups Get all user groups
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_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

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.1.1a3.tar.gz (267.9 kB view hashes)

Uploaded Source

Built Distribution

gooddata_api_client-1.1.1a3-py3-none-any.whl (1.4 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